{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dyvmsapi-intl/backend-call-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_intl_backend_call_group","summary":"Initiates a voice group call to multiple phone numbers. The content of the group call is that of approved…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"},"CalledNumber":{"type":"string","description":"The called numbers. You can specify up to 50,000 phone numbers (JSON-encoded)"},"CallerIdNumber":{"type":"string","description":"The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a…"},"CountryId":{"type":"string","description":"The ISO2 country code"},"PlayTimes":{"type":"integer","description":"The number of times the audio file is played. Valid values: 1 to 3"},"SendType":{"type":"integer","description":"The delivery type. Valid values: 1 and 2. 1: The audio file is delivered immediately. 2: The audio file is delivered at a scheduled time.…"},"Speed":{"type":"integer","description":"The playback speed. Valid values: -500 to 500. You must specify this parameter when the audio type is text-to-speech (TTS). You do not…"},"TaskName":{"type":"string","description":"The task name"},"TimingStart":{"type":"string","description":"The time when the audio file is scheduled to be delivered"},"TtsCode":{"type":"string","description":"The voice template ID of the audio file. You can log on to the VMS console and choose Voice Call Template > Audio File to view the…"},"VoiceCode":{"type":"string","description":"The TTS template ID. You can log on to the VMS console and choose Voice Call Template > TTS Template to view the template ID. You must…"},"Volume":{"type":"integer","description":"The playback volume of the audio file. Valid values: 0 to 100. Default value: 100"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be of the STRING type and 1 to 15…"}}}}}},"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:aliyun-dyvmsapi-intl/backend-call-signal":{"post":{"operationId":"cloud_aliyun_dyvmsapi_intl_backend_call_signal","summary":"Sends a voice verification code and voice notification with variables to a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"},"CalledNumber":{"type":"string","description":"The phone number that receives the voice notification. You must add the country code to the beginning of the phone number. Example:…"},"CallerIdNumber":{"type":"string","description":"The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a…"},"CountryId":{"type":"string","description":"The ISO2 country code"},"PlayTimes":{"type":"integer","description":"The number of times the voice notification is played back in a call. Valid values: 1 to 3. Default value: 3"},"Speed":{"type":"integer","description":"The playback speed. Valid values: -500 to 500"},"TtsCode":{"type":"string","description":"The ID of the approved voice verification code template. You can log on to the VMS console and choose Voice Call Template to view the…"},"TtsParam":{"type":"string","description":"The variables in the template, in the JSON format"},"Volume":{"type":"integer","description":"The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be of the STRING type and 1 to 15…"}}}}}},"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:aliyun-dyvmsapi-intl/group-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_intl_group_call","summary":"Initiates multiple voice calls to specified numbers. Supports voice file templates or text-to-speech…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"},"Signature":{"type":"string","description":"The Signature"},"Timestamp":{"type":"string","description":"The Timestamp"},"SignatureNonce":{"type":"string","description":"The SignatureNonce"},"CalledNumber":{"type":"string","description":"The called numbers. A maximum of 50,000 numbers are supported (JSON-encoded)"},"CallerIdNumber":{"type":"string","description":"The calling number. If you do not specify this parameter, the system uses a random local number as the display number. If you use a…"},"CountryId":{"type":"string","description":"The ISO 3166-1 alpha-2 country or region code"},"PlayTimes":{"type":"integer","description":"The number of times the voice file is played. Valid values: 1 to 3"},"SendType":{"type":"integer","description":"The send type. Valid values: 1 and 2. 1: starts the task immediately. 2: starts the task at a scheduled time. If you set this parameter to…"},"Speed":{"type":"integer","description":"The speech rate. Valid values: -500 to 500. This parameter is required when the audio type is TTS. This parameter is optional for recorded…"},"TaskName":{"type":"string","description":"The task name"},"TimingStart":{"type":"string","description":"2022-05-01T08:00:00+08:00"},"TtsCode":{"type":"string","description":"The template ID for text-to-speech. Log on to the International Voice Service console and choose Voice Template Management >…"},"VoiceCode":{"type":"string","description":"The template ID for the voice file. Log on to the International Voice Service console and choose Voice Template Management > Voice File to…"},"Volume":{"type":"integer","description":"The volume for voice file playback. Valid values: 0 to 100. Default value: 100"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string of 1 to 15 bytes in length"},"TtsParam":{"type":"string","description":"The variable parameters in the template, in JSON format"}}}}}},"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:aliyun-dyvmsapi-intl/signal-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_intl_signal_call","summary":"Sends a voice verification code or a voice notification with parameter variables to a specified phone…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"},"Signature":{"type":"string","description":"The Signature"},"Timestamp":{"type":"string","description":"The Timestamp"},"SignatureNonce":{"type":"string","description":"The SignatureNonce"},"CallerIdNumber":{"type":"string","description":"The calling number. If you do not specify this parameter, the system uses a random local number as the display number. If you use a…"},"CalledNumber":{"type":"string","description":"The phone number that receives the voice notification. Format: country code + phone number. Example: 85200****00"},"TtsCode":{"type":"string","description":"The voice ID of the text-to-speech template. You can log on to the International Voice Service console and choose Voice Template…"},"TtsParam":{"type":"string","description":"The variable parameters in the template, in JSON format"},"VoiceCode":{"type":"string","description":"The template ID of the voice file. You can log on to the International Voice Service console and choose Voice Template Management > Voice…"},"PlayTimes":{"type":"integer","description":"The number of times the voice notification content is played in a single call. Valid values: 1 to 3. Default value: 3"},"Volume":{"type":"integer","description":"The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100"},"Speed":{"type":"integer","description":"The speech rate control. Valid values: -500 to 500"},"CountryId":{"type":"string","description":"The ISO2 two-letter country or region code"},"TaskName":{"type":"string","description":"The task name"},"SendType":{"type":"integer","description":"The send type. Valid values: 1 and 2. 1: starts the send task immediately without waiting. 2: starts the send task at a scheduled time. If…"},"TimingStart":{"type":"string","description":"The scheduled send time"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string of 1 to 15 bytes in length"}}}}}},"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:aliyun-dyvmsapi-intl/voice-group-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_intl_voice_group_call","summary":"Sends a voice notification to multiple phone numbers. A voice file or text-to-speech (TTS) template is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"},"CallerIdNumber":{"type":"string","description":"The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a…"},"CalledNumber":{"type":"string","description":"The called numbers. You can specify up to 50,000 numbers (JSON-encoded)"},"TtsCode":{"type":"string","description":"The ID of the TTS template. You can log on to the VMS console and go to the TTS templates page to view the template ID. You must specify…"},"TtsParam":{"type":"string","description":"The variables in the template, in the JSON format"},"VoiceCode":{"type":"string","description":"The ID of the voice file template. You can log on to the VMS console and go to the voice file templates page to view the template ID. You…"},"PlayTimes":{"type":"integer","description":"The number of times the voice notification is played in the call. Valid values: 1 to 3"},"Volume":{"type":"integer","description":"The playback volume of the voice file. Valid values: 0 to 100. Default value: 100"},"Speed":{"type":"integer","description":"The playback speed. Valid values: -500 to 500. This parameter is required when a TTS template is used. You do not need to specify this…"},"TaskName":{"type":"string","description":"The task name"},"SendType":{"type":"integer","description":"The delivery type. Valid values: 1 and 2. 1: immediately delivers the task. 2: delivers the task at a scheduled time. If you set this…"},"TimingStart":{"type":"string","description":"The time when the task is scheduled to be delivered"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be a string that is 1 to 15 bytes…"},"CountryId":{"type":"string","description":"The ISO2 country/region code"}}}}}},"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:aliyun-dyvmsapi-intl/voice-single-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_intl_voice_single_call","summary":"Sends a voice verification code or voice notification with variables to a phone number. A voice file or…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"},"CallerIdNumber":{"type":"string","description":"The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a…"},"CalledNumber":{"type":"string","description":"The phone number that receives the voice notification. You must add the country/region dialing code to the beginning of the phone number.…"},"TtsCode":{"type":"string","description":"The ID of the TTS template. You can log on to the VMS console and go to the TTS templates page to view the template ID. You must specify…"},"TtsParam":{"type":"string","description":"The variables in the template, in the JSON format"},"VoiceCode":{"type":"string","description":"The ID of the voice file template. You can log on to the VMS console and go to the voice file templates page to view the template ID. You…"},"PlayTimes":{"type":"integer","description":"The number of times the voice notification is played in the call. Valid values: 1 to 3. Default value: 3"},"Volume":{"type":"integer","description":"The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100"},"Speed":{"type":"integer","description":"The playback speed. Valid values: -500 to 500"},"TaskName":{"type":"string","description":"The task name"},"SendType":{"type":"integer","description":"The delivery type. Valid values: 1 and 2. 1: immediately delivers the task. 2: delivers the task at a scheduled time. If you set this…"},"TimingStart":{"type":"string","description":"The time when the task is scheduled to be delivered"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be a string that is 1 to 15 bytes…"},"CountryId":{"type":"string","description":"The ISO2 country/region code"}}}}}},"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:aliyun-dyvmsapi-intl/version":{"post":{"operationId":"cloud_aliyun_dyvmsapi_intl_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi-intl.ap-southeast-1.aliyuncs.com"}}}}}},"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"}}}}}}}