{"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-dysmsapi/batch-send-message-to-globe":{"post":{"operationId":"cloud_aliyun_dysmsapi_batch_send_message_to_globe","summary":"Sends a message to multiple recipients in countries or regions outside the Chinese mainland","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["To","Message"],"properties":{"endpoint":{"type":"string","enum":["https://dysmsapi.aliyuncs.com","https://dysmsapi.ap-southeast-1.aliyuncs.com","https://dysmsapi.ap-southeast-5.aliyuncs.com","https://dysmsapi.eu-central-1.aliyuncs.com"],"default":"https://dysmsapi.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com"},"To":{"type":"string","description":"The mobile phone number of the recipient. You must add the dialing code to the beginning of each mobile phone number. For more…"},"From":{"type":"string","description":"The mobile phone number of the sender. You can specify the sender ID when you call the API operation. The sender ID can contain only…"},"Message":{"type":"string","description":"The content of the message"},"Type":{"type":"string","description":"The type of the message. Valid values: NOTIFY: notification MKT: promotional message"},"TaskId":{"type":"string","description":"The ID of the messaging campaign. It must be 1 to 255 characters in length. The ID is the value of the TaskId field in the delivery…"},"ValidityPeriod":{"type":"integer","description":"The validity period of the message. Unit: seconds"},"ChannelId":{"type":"string","description":"The ID of the delivery channel"}}}}}},"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-dysmsapi/conversion-data":{"post":{"operationId":"cloud_aliyun_dysmsapi_conversion_data","summary":"Reports the status of an OTP message to Alibaba Cloud SMS","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ConversionRate"],"properties":{"endpoint":{"type":"string","enum":["https://dysmsapi.aliyuncs.com","https://dysmsapi.ap-southeast-1.aliyuncs.com","https://dysmsapi.ap-southeast-5.aliyuncs.com","https://dysmsapi.eu-central-1.aliyuncs.com"],"default":"https://dysmsapi.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com"},"ReportTime":{"type":"integer","description":"Timestamp of the conversion rate observation should be a Unix timestamp, a millisecond-level long integer. If this field is not specified:…"},"ConversionRate":{"type":"string","description":"Conversion rate monitoring return value. The value of this parameter is of type double, and the value is between [0,1]"}}}}}},"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-dysmsapi/query-message":{"post":{"operationId":"cloud_aliyun_dysmsapi_query_message","summary":"Queries the delivery report of a message","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MessageId"],"properties":{"endpoint":{"type":"string","enum":["https://dysmsapi.aliyuncs.com","https://dysmsapi.ap-southeast-1.aliyuncs.com","https://dysmsapi.ap-southeast-5.aliyuncs.com","https://dysmsapi.eu-central-1.aliyuncs.com"],"default":"https://dysmsapi.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com"},"MessageId":{"type":"string","description":"The ID of the message"}}}}}},"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-dysmsapi/send-message-to-globe":{"post":{"operationId":"cloud_aliyun_dysmsapi_send_message_to_globe","summary":"Sends messages to regions outside the Chinese mainland, including Hong Kong (China), Macao (China), Taiwan…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["To","Message"],"properties":{"endpoint":{"type":"string","enum":["https://dysmsapi.aliyuncs.com","https://dysmsapi.ap-southeast-1.aliyuncs.com","https://dysmsapi.ap-southeast-5.aliyuncs.com","https://dysmsapi.eu-central-1.aliyuncs.com"],"default":"https://dysmsapi.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com"},"To":{"type":"string","description":"The phone numbers to which the message is sent. Format: `Dialing code + Phone number`. For example, 8521245567\\\\. For dialing odes, see…"},"From":{"type":"string","description":"The phone number of the sender. You can also specify a sender ID, which can contain letters and digits. An alphanumeric ID can be up to 11…"},"Message":{"type":"string","description":"The message content"},"Type":{"type":"string","description":"The message type. Valid values: OTP: verification code message. NOTIFY: notification. MKT: marketing message"},"TaskId":{"type":"string","description":"The ID of the task. The ID can be up to 255 characters in length. You can obtain the task ID from the TaskId field in the message receipt"},"ValidityPeriod":{"type":"integer","description":"The validity period of the message, in seconds"},"ChannelId":{"type":"string","description":"The ID of the channel"}}}}}},"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-dysmsapi/send-message-with-template":{"post":{"operationId":"cloud_aliyun_dysmsapi_send_message_with_template","summary":"Sends a message to the Chinese mainland by using a message template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["To","From","TemplateCode"],"properties":{"endpoint":{"type":"string","enum":["https://dysmsapi.aliyuncs.com","https://dysmsapi.ap-southeast-1.aliyuncs.com","https://dysmsapi.ap-southeast-5.aliyuncs.com","https://dysmsapi.eu-central-1.aliyuncs.com"],"default":"https://dysmsapi.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com"},"To":{"type":"string","description":"The mobile phone number to which the message is sent. You must add the country code to the beginning of the mobile phone number. Example:…"},"From":{"type":"string","description":"The signature. To query the signature, log on to the Short Message Service (SMS) console (https://sms-intl.console.aliyun.com/overview)…"},"TemplateCode":{"type":"string","description":"The code of the message template. To query the code, log on to the SMS console (https://sms-intl.console.aliyun.com/overview) and navigate…"},"TemplateParam":{"type":"string","description":"The value of the variable in the message template. If a variable exists in the template, the parameter is required"},"SmsUpExtendCode":{"type":"string","description":"The extension code of the MO message"},"ValidityPeriod":{"type":"integer","description":"The validity period of the message"},"ChannelId":{"type":"string","description":"The ID of the channel"}}}}}},"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-dysmsapi/sms-conversion":{"post":{"operationId":"cloud_aliyun_dysmsapi_sms_conversion","summary":"Delivers one-time password (OTP) message statuses to Alibaba Cloud, which calculates and monitors OTP…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Delivered"],"properties":{"endpoint":{"type":"string","enum":["https://dysmsapi.aliyuncs.com","https://dysmsapi.ap-southeast-1.aliyuncs.com","https://dysmsapi.ap-southeast-5.aliyuncs.com","https://dysmsapi.eu-central-1.aliyuncs.com"],"default":"https://dysmsapi.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dysmsapi.ap-southeast-1.aliyuncs.com"},"MessageId":{"type":"string","description":"The ID of the OTP message"},"Delivered":{"type":"string","description":"Specifies whether customers replied to the OTP message. Valid values: true and false"},"ConversionTime":{"type":"integer","description":"The time when the OTP message was delivered. The value is a UNIX timestamp. Unit: milliseconds. If you leave the parameter empty, the…"},"To":{"type":"string","description":"The mobile phone number of the recipient. You must add the dialing code to the beginning of the mobile phone number. For more information,…"}}}}}},"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-dysmsapi/version":{"post":{"operationId":"cloud_aliyun_dysmsapi_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dysmsapi.aliyuncs.com","https://dysmsapi.ap-southeast-1.aliyuncs.com","https://dysmsapi.ap-southeast-5.aliyuncs.com","https://dysmsapi.eu-central-1.aliyuncs.com"],"default":"https://dysmsapi.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dysmsapi.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"}}}}}}}