{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:tencent-sms/add-sms-sign":{"post":{"operationId":"cloud_tencent_sms_add_sms_sign","summary":"Add Sms Sign","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SignName","SignType","DocumentType","International","SignPurpose","ProofImage"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SignName":{"type":"string"},"SignType":{"type":"integer"},"DocumentType":{"type":"integer"},"International":{"type":"integer"},"SignPurpose":{"type":"integer"},"ProofImage":{"type":"string"},"CommissionImage":{"type":"string"},"Remark":{"type":"string"},"QualificationId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/add-sms-template":{"post":{"operationId":"cloud_tencent_sms_add_sms_template","summary":"Add Sms Template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateName","TemplateContent","SmsType","International","Remark"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TemplateName":{"type":"string"},"TemplateContent":{"type":"string"},"SmsType":{"type":"integer"},"International":{"type":"integer"},"Remark":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/callback-status-statistics":{"post":{"operationId":"cloud_tencent_sms_callback_status_statistics","summary":"Callback Status Statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime","SmsSdkAppId","Limit","Offset"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BeginTime":{"type":"string"},"EndTime":{"type":"string"},"SmsSdkAppId":{"type":"string"},"Limit":{"type":"integer"},"Offset":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/delete-sms-sign":{"post":{"operationId":"cloud_tencent_sms_delete_sms_sign","summary":"Delete Sms Sign","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SignId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SignId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/delete-sms-template":{"post":{"operationId":"cloud_tencent_sms_delete_sms_template","summary":"Delete Sms Template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TemplateId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/describe-phone-number-info":{"post":{"operationId":"cloud_tencent_sms_describe_phone_number_info","summary":"Describe Phone Number Info","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumberSet"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"PhoneNumberSet":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/describe-send-record-list":{"post":{"operationId":"cloud_tencent_sms_describe_send_record_list","summary":"Describe Send Record List","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumber","SmsSdkAppId","BeginTime"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"PhoneNumber":{"type":"string"},"SmsSdkAppId":{"type":"string"},"BeginTime":{"type":"integer"},"EndTime":{"type":"integer"},"Limit":{"type":"integer"},"Offset":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/describe-sms-sign-list":{"post":{"operationId":"cloud_tencent_sms_describe_sms_sign_list","summary":"Describe Sms Sign List","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["International"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"International":{"type":"integer"},"SignIdSet":{"type":"array"},"Limit":{"type":"integer"},"Offset":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/describe-sms-template-list":{"post":{"operationId":"cloud_tencent_sms_describe_sms_template_list","summary":"Describe Sms Template List","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["International"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"International":{"type":"integer"},"TemplateIdSet":{"type":"array"},"Limit":{"type":"integer"},"Offset":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/modify-sms-sign":{"post":{"operationId":"cloud_tencent_sms_modify_sms_sign","summary":"Modify Sms Sign","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SignId","SignName","SignType","DocumentType","International","SignPurpose","ProofImage"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SignId":{"type":"integer"},"SignName":{"type":"string"},"SignType":{"type":"integer"},"DocumentType":{"type":"integer"},"International":{"type":"integer"},"SignPurpose":{"type":"integer"},"ProofImage":{"type":"string"},"CommissionImage":{"type":"string"},"Remark":{"type":"string"},"QualificationId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/modify-sms-template":{"post":{"operationId":"cloud_tencent_sms_modify_sms_template","summary":"Modify Sms Template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId","TemplateName","TemplateContent","SmsType","International","Remark"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"TemplateId":{"type":"integer"},"TemplateName":{"type":"string"},"TemplateContent":{"type":"string"},"SmsType":{"type":"integer"},"International":{"type":"integer"},"Remark":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/pull-sms-reply-status":{"post":{"operationId":"cloud_tencent_sms_pull_sms_reply_status","summary":"Pull Sms Reply Status","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Limit","SmsSdkAppId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Limit":{"type":"integer"},"SmsSdkAppId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/pull-sms-reply-status-by-phone-number":{"post":{"operationId":"cloud_tencent_sms_pull_sms_reply_status_by_phone_number","summary":"Pull Sms Reply Status By Phone Number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","Offset","Limit","PhoneNumber","SmsSdkAppId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BeginTime":{"type":"integer"},"Offset":{"type":"integer"},"Limit":{"type":"integer"},"PhoneNumber":{"type":"string"},"SmsSdkAppId":{"type":"string"},"EndTime":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/pull-sms-send-status":{"post":{"operationId":"cloud_tencent_sms_pull_sms_send_status","summary":"Pull Sms Send Status","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Limit","SmsSdkAppId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Limit":{"type":"integer"},"SmsSdkAppId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/pull-sms-send-status-by-phone-number":{"post":{"operationId":"cloud_tencent_sms_pull_sms_send_status_by_phone_number","summary":"Pull Sms Send Status By Phone Number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","Offset","Limit","PhoneNumber","SmsSdkAppId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BeginTime":{"type":"integer"},"Offset":{"type":"integer"},"Limit":{"type":"integer"},"PhoneNumber":{"type":"string"},"SmsSdkAppId":{"type":"string"},"EndTime":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/report-conversion":{"post":{"operationId":"cloud_tencent_sms_report_conversion","summary":"Report Conversion","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SmsSdkAppId","SerialNo"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SmsSdkAppId":{"type":"string"},"SerialNo":{"type":"string"},"ConversionTime":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/send-multi-global-sms":{"post":{"operationId":"cloud_tencent_sms_send_multi_global_sms","summary":"Send Multi Global Sms","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SmsSdkAppId","MultiSmsInfoSet"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SmsSdkAppId":{"type":"string"},"MultiSmsInfoSet":{"type":"array"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/send-sms":{"post":{"operationId":"cloud_tencent_sms_send_sms","summary":"Send Sms","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumberSet","SmsSdkAppId","TemplateId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"PhoneNumberSet":{"type":"array"},"SmsSdkAppId":{"type":"string"},"TemplateId":{"type":"string"},"SignName":{"type":"string"},"TemplateParamSet":{"type":"array"},"ExtendCode":{"type":"string"},"SessionContext":{"type":"string"},"SenderId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/send-status-statistics":{"post":{"operationId":"cloud_tencent_sms_send_status_statistics","summary":"Send Status Statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime","SmsSdkAppId","Limit","Offset"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BeginTime":{"type":"string"},"EndTime":{"type":"string"},"SmsSdkAppId":{"type":"string"},"Limit":{"type":"integer"},"Offset":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-sms/sms-packages-statistics":{"post":{"operationId":"cloud_tencent_sms_sms_packages_statistics","summary":"Sms Packages Statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SmsSdkAppId","Limit","Offset","BeginTime","EndTime"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SmsSdkAppId":{"type":"string"},"Limit":{"type":"integer"},"Offset":{"type":"integer"},"BeginTime":{"type":"string"},"EndTime":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}