{"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:aliyun-dypnsapi-intl/check-verification":{"post":{"operationId":"cloud_aliyun_dypnsapi_intl_check_verification","summary":"Calls the CheckVerification operation to verify a verification code","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Code","VerificationId"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dypnsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi-intl.ap-southeast-1.aliyuncs.com"},"ServiceSid":{"type":"string","description":"The ServiceID configured in the console"},"To":{"type":"string","description":"The phone number that received the SMS message. Format: country code + phone number"},"Code":{"type":"string","description":"The verification code"},"VerificationId":{"type":"string","description":"The unique verification ID returned by the send verification code operation"}}}}}},"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-dypnsapi-intl/search-verification":{"post":{"operationId":"cloud_aliyun_dypnsapi_intl_search_verification","summary":"Queries the details of verification results","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dypnsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi-intl.ap-southeast-1.aliyuncs.com"},"ServiceSid":{"type":"string","description":"The ServiceID configured in the console"},"To":{"type":"string","description":"The phone number that receives the SMS message. Format: country code + phone number"},"Code":{"type":"string","description":"The verification code"},"VerificationId":{"type":"string","description":"The unique verification ID returned by the send verification code operation"},"SendDate":{"type":"integer","description":"The date when the SMS message was sent, in millisecond-precision timestamp format. You can query records from the last 30 days"},"PageSize":{"type":"integer","description":"The page size"},"CurrentPage":{"type":"integer","description":"The current page number. The value starts from 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-dypnsapi-intl/start-verification":{"post":{"operationId":"cloud_aliyun_dypnsapi_intl_start_verification","summary":"Sends a verification code to an end user through a specified channel. Supported channels include SMS, voice,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Channel","To","ServiceSid"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dypnsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi-intl.ap-southeast-1.aliyuncs.com"},"Channel":{"type":"string","description":"The verification channel. Valid values: SMS, VOICE, and WHATSAPP"},"To":{"type":"string","description":"The recipient phone number. Format: country code + phone number"},"ServiceSid":{"type":"string","description":"The service ID configured in the console"}}}}}},"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-dypnsapi-intl/version":{"post":{"operationId":"cloud_aliyun_dypnsapi_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://dypnsapi-intl.ap-southeast-1.aliyuncs.com"],"default":"https://dypnsapi-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi-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"}}}}}}}