{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dytnsapi/describe-number-hlr":{"post":{"operationId":"cloud_aliyun_dytnsapi_describe_number_hlr","summary":"Call this operation to query basic information and the status of a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dytnsapi.aliyuncs.com"],"default":"https://dytnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dytnsapi.aliyuncs.com"},"PhoneNumber":{"type":"string","description":"The phone number to query"},"AuthCode":{"type":"string","description":"The authorization code. Log on to the Number Encyclopedia 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-dytnsapi/describe-number-mcc-mnc":{"post":{"operationId":"cloud_aliyun_dytnsapi_describe_number_mcc_mnc","summary":"This operation from Phone Number-based Service queries an international phone number to identify its country…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dytnsapi.aliyuncs.com"],"default":"https://dytnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dytnsapi.aliyuncs.com"},"PhoneNumber":{"type":"string","description":"The phone number, which must be prefixed with a country code. For example, a phone number in China (Hong Kong) must be in the…"},"AuthCode":{"type":"string","description":"The authorization code. To obtain an authorization code, log on to the Phone Number-based Service console, go to Tag Plaza…"}}}}}},"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-dytnsapi/get-identification-result":{"post":{"operationId":"cloud_aliyun_dytnsapi_get_identification_result","summary":"Retrieves the result of an identification request","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SessionId","AuthCode"],"properties":{"endpoint":{"type":"string","enum":["https://dytnsapi.aliyuncs.com"],"default":"https://dytnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dytnsapi.aliyuncs.com"},"SessionId":{"type":"string","description":"The session ID"},"AuthCode":{"type":"string","description":"The authorization code. In the Phone Number Verification Service console (https://dytns.console.aliyun.com/analysis/apply), you can obtain…"}}}}}},"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-dytnsapi/get-identification-session":{"post":{"operationId":"cloud_aliyun_dytnsapi_get_identification_session","summary":"Gets a session ID for international certification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AuthCode"],"properties":{"endpoint":{"type":"string","enum":["https://dytnsapi.aliyuncs.com"],"default":"https://dytnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dytnsapi.aliyuncs.com"},"AuthCode":{"type":"string","description":"The authorization 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-dytnsapi/get-phone-number-identification-result":{"post":{"operationId":"cloud_aliyun_dytnsapi_get_phone_number_identification_result","summary":"Obtains the verification result of your phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SessionId","SessionPayload","OutId","AuthCode","PhoneNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dytnsapi.aliyuncs.com"],"default":"https://dytnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dytnsapi.aliyuncs.com"},"SessionId":{"type":"string","description":"The session ID"},"SessionPayload":{"type":"string","description":"The session payload"},"OutId":{"type":"string","description":"The external ID"},"AuthCode":{"type":"string","description":"The authorization code"},"PhoneNumber":{"type":"string","description":"The phone number of the subscriber. The phone number to be verified must be in the Mobile Station International Subscriber Directory…"}}}}}},"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-dytnsapi/get-phone-number-identification-url":{"post":{"operationId":"cloud_aliyun_dytnsapi_get_phone_number_identification_url","summary":"Obtains the verification URL of your phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumber","OutId","AuthCode"],"properties":{"endpoint":{"type":"string","enum":["https://dytnsapi.aliyuncs.com"],"default":"https://dytnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dytnsapi.aliyuncs.com"},"Ip":{"type":"string","description":"The IP address of the subscriber's phone"},"PhoneNumber":{"type":"string","description":"The phone number of the subscriber. The phone number is in the Mobile Station International Subscriber Directory Number (MSISDN) format"},"OutId":{"type":"string","description":"The external ID"},"AuthCode":{"type":"string","description":"The authorization code"},"RememberPhoneNumber":{"type":"string","description":"Specifies whether to remember the phone number"}}}}}},"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-dytnsapi/version":{"post":{"operationId":"cloud_aliyun_dytnsapi_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dytnsapi.aliyuncs.com"],"default":"https://dytnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dytnsapi.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"}}}}}}}