diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/dypnsapi-intl | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/dypnsapi-intl')
| -rw-r--r-- | data/en_us/dypnsapi-intl/2017-07-25/api-docs.php | 359 |
1 files changed, 105 insertions, 254 deletions
diff --git a/data/en_us/dypnsapi-intl/2017-07-25/api-docs.php b/data/en_us/dypnsapi-intl/2017-07-25/api-docs.php index e9f319d..86bad04 100644 --- a/data/en_us/dypnsapi-intl/2017-07-25/api-docs.php +++ b/data/en_us/dypnsapi-intl/2017-07-25/api-docs.php @@ -1,29 +1,15 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Dypnsapi-intl', - 'version' => '2017-07-25', - ], - 'directories' => [ - 'StartVerification', - 'SearchVerification', - 'CheckVerification', - ], + 'info' => ['style' => 'RPC', 'product' => 'Dypnsapi-intl', 'version' => '2017-07-25'], + 'directories' => ['CheckVerification', 'SearchVerification', 'StartVerification'], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'StartVerification' => [ - 'summary' => 'Sends verification codes to an end user by using a specified channel, such as Short Message Service (SMS), Voice, and WhatsApp.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CheckVerification' => [ + 'summary' => 'Verifies a verification code.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -35,48 +21,31 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '171584', - 'abilityTreeNodes' => [ - 'FEATUREdypnsL4YHVT', - ], + 'abilityTreeCode' => '171586', + 'abilityTreeNodes' => ['FEATUREdypnsL4YHVT'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Channel', + 'name' => 'ServiceSid', 'in' => 'query', - 'schema' => [ - 'description' => 'The channels that you can use for verification.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'VOICE' => 'VOICE', - 'SMS' => 'SMS', - 'WHATSAPP' => 'WHATSAPP', - ], - 'example' => 'SMS', - ], + 'schema' => ['description' => 'The service ID that is displayed in the Phone Number Verification Service console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FA00000000000001', 'title' => ''], ], [ 'name' => 'To', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile phone number of the recipient. You must add the country code to the beginning of the mobile phone number.', - 'type' => 'string', - 'required' => true, - 'example' => '6212345****01', - ], + 'schema' => ['description' => 'The mobile phone number of the recipient. You must add the country code to the beginning of the mobile phone number.', 'type' => 'string', 'required' => false, 'example' => '6212345****01', 'title' => ''], ], [ - 'name' => 'ServiceSid', + 'name' => 'Code', 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID that is displayed in the Phone Number Verification Service console.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'FA00000000000001', - ], + 'schema' => ['description' => 'The verification code.'."\n", 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'VerificationId', + 'in' => 'query', + 'schema' => ['description' => 'The unique authentication ID that is returned by calling the StartVerification operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I', 'title' => ''], ], ], 'responses' => [ @@ -84,63 +53,37 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request. An ID is a unique identifier that Alibaba Cloud generates for a request.'."\n", - 'type' => 'string', - 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62', - ], - 'Message' => [ - 'description' => 'The message that was returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Model' => [ - 'description' => 'The data that was returned only if the request was successful.', - 'type' => 'object', - 'example' => '{ "verifyCode": "", "verificationId": "", "status": "" }', - ], - 'Code' => [ - 'description' => 'The HTTP status code that was returned for the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: '."\n" - ."\n" - .'- **true**: The request was successful. '."\n" - ."\n" - .'- **false**: The request failed.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request. An ID is a unique identifier that Alibaba Cloud generates for a request.'."\n", 'type' => 'string', 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62', 'title' => ''], + 'Message' => ['description' => 'The message that was returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Model' => ['description' => 'The data that was returned for the successful request.', 'type' => 'object', 'example' => ' { "phoneNumber": "", "channel": "", "verificationId": "", "status": "approved" }', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code that was returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: '."\n" + ."\n" + .'- **true**: The request was successful. '."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'Invalid.Parameters', - ], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'Invalid.Parameters', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"phoneNumber\\": \\"\\",\\n \\"channel\\": \\"\\",\\n \\"verificationId\\": \\"\\",\\n \\"status\\": \\"approved\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'CheckVerification', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [ + ['createdAt' => '2025-08-01T08:40:16.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"verifyCode\\": \\"\\",\\n \\"verificationId\\": \\"\\",\\n \\"status\\": \\"\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'StartVerification', ], 'SearchVerification' => [ 'summary' => 'Queries the result of a verification.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -153,9 +96,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '171585', - 'abilityTreeNodes' => [ - 'FEATUREdypnsL4YHVT', - ], + 'abilityTreeNodes' => ['FEATUREdypnsL4YHVT'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -163,75 +104,37 @@ [ 'name' => 'ServiceSid', 'in' => 'query', - 'schema' => [ - 'description' => 'The service ID that is displayed in the Phone Number Verification Service console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FA00000000000001', - ], + 'schema' => ['description' => 'The service ID that is displayed in the Phone Number Verification Service console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FA00000000000001', 'title' => ''], ], [ 'name' => 'To', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile phone number of the recipient. You must add the country code to the beginning of the mobile phone number.', - 'type' => 'string', - 'required' => false, - 'example' => '6212345****01', - ], + 'schema' => ['description' => 'The mobile phone number of the recipient. You must add the country code to the beginning of the mobile phone number.', 'type' => 'string', 'required' => false, 'example' => '6212345****01', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', - 'schema' => [ - 'description' => 'The verification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['description' => 'The verification code.'."\n", 'type' => 'string', 'required' => false, 'example' => '1234', 'title' => ''], ], [ 'name' => 'VerificationId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique authentication ID that is returned by calling the StartVerification operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I', - ], + 'schema' => ['description' => 'The unique authentication ID that is returned by calling the StartVerification operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I', 'title' => ''], ], [ 'name' => 'SendDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when a text message is sent, in milliseconds. You can query text messages that were sent within the last 30 days.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1677600000000,', - ], + 'schema' => ['description' => 'The time when a text message is sent, in milliseconds. You can query text messages that were sent within the last 30 days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1677600000000,', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -239,55 +142,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request. An ID is a unique identifier that Alibaba Cloud generates for a request.'."\n", - 'type' => 'string', - 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62'."\n", - ], - 'Message' => [ - 'description' => 'The message that was returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Model' => [ - 'description' => 'The data that was returned for the request.', - 'type' => 'object', - 'example' => '{ "records": \\[ { "sendDate":, "channel": "", "serviceSid": "", "to": "", "updatedDate":, "verificationId": "", "status": "" } ], "pageNo": , "totalPage": 1, "pageSize": 20, "totalCount": 1, }', - ], - 'Code' => [ - 'description' => 'The HTTP status code that was returned for the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: '."\n" - ."\n" - .'- **true**: The request was successful. '."\n" - ."\n" - .'- **false**: The request failed.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request. An ID is a unique identifier that Alibaba Cloud generates for a request.'."\n", 'type' => 'string', 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62'."\n", 'title' => ''], + 'Message' => ['description' => 'The message that was returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Model' => ['description' => 'The data that was returned for the request.', 'type' => 'object', 'example' => '{ "records": \\[ { "sendDate":, "channel": "", "serviceSid": "", "to": "", "updatedDate":, "verificationId": "", "status": "" } ], "pageNo": , "totalPage": 1, "pageSize": 20, "totalCount": 1, }', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code that was returned for the request.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: '."\n" + ."\n" + .'- **true**: The request was successful. '."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'SearchVerification', - ], - 'CheckVerification' => [ - 'summary' => 'Verifies a verification code.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [ + ['createdAt' => '2025-08-01T08:40:15.000Z', 'description' => 'OpenAPI offline'], ], + ], + 'StartVerification' => [ + 'summary' => 'Sends verification codes to an end user by using a specified channel, such as Short Message Service (SMS), Voice, and WhatsApp.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -299,53 +179,33 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '171586', - 'abilityTreeNodes' => [ - 'FEATUREdypnsL4YHVT', - ], + 'abilityTreeCode' => '171584', + 'abilityTreeNodes' => ['FEATUREdypnsL4YHVT'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ServiceSid', + 'name' => 'Channel', 'in' => 'query', 'schema' => [ - 'description' => 'The service ID that is displayed in the Phone Number Verification Service console.'."\n", + 'description' => 'The channels that you can use for verification.', 'type' => 'string', - 'required' => false, - 'example' => 'FA00000000000001', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'SMS', + 'title' => '', ], ], [ 'name' => 'To', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile phone number of the recipient. You must add the country code to the beginning of the mobile phone number.', - 'type' => 'string', - 'required' => false, - 'example' => '6212345****01', - ], + 'schema' => ['description' => 'The mobile phone number of the recipient. You must add the country code to the beginning of the mobile phone number.', 'type' => 'string', 'required' => true, 'example' => '6212345****01', 'title' => ''], ], [ - 'name' => 'Code', + 'name' => 'ServiceSid', 'in' => 'query', - 'schema' => [ - 'description' => 'The verification code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'VerificationId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique authentication ID that is returned by calling the StartVerification operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I', - ], + 'schema' => ['description' => 'The service ID that is displayed in the Phone Number Verification Service console.'."\n", 'type' => 'string', 'required' => true, 'example' => 'FA00000000000001', 'title' => ''], ], ], 'responses' => [ @@ -353,58 +213,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request. An ID is a unique identifier that Alibaba Cloud generates for a request.'."\n", - 'type' => 'string', - 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62', - ], - 'Message' => [ - 'description' => 'The message that was returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Model' => [ - 'description' => 'The data that was returned for the successful request.', - 'type' => 'object', - 'example' => ' { "phoneNumber": "", "channel": "", "verificationId": "", "status": "approved" }', - ], - 'Code' => [ - 'description' => 'The HTTP status code that was returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: '."\n" - ."\n" - .'- **true**: The request was successful. '."\n" - ."\n" - .'- **false**: The request failed.', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request. An ID is a unique identifier that Alibaba Cloud generates for a request.'."\n", 'type' => 'string', 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62', 'title' => ''], + 'Message' => ['description' => 'The message that was returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Model' => ['description' => 'The data that was returned only if the request was successful.', 'type' => 'object', 'example' => '{ "verifyCode": "", "verificationId": "", "status": "" }', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code that was returned for the request.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: '."\n" + ."\n" + .'- **true**: The request was successful. '."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'Invalid.Parameters', - ], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'Invalid.Parameters', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"verifyCode\\": \\"\\",\\n \\"verificationId\\": \\"\\",\\n \\"status\\": \\"\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'StartVerification', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [ + ['createdAt' => '2025-08-01T08:40:15.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"phoneNumber\\": \\"\\",\\n \\"channel\\": \\"\\",\\n \\"verificationId\\": \\"\\",\\n \\"status\\": \\"approved\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'CheckVerification', ], ], 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dypnsapi-intl.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dypnsapi-intl.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Invalid.Parameters', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [ [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'dypnsapi-intl.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'SearchVerification'], + ['description' => 'OpenAPI offline', 'api' => 'StartVerification'], + ['description' => 'OpenAPI offline', 'api' => 'CheckVerification'], + ], + 'createdAt' => '2025-08-01T08:40:15.000Z', + 'description' => '', ], ], ]; |
