summaryrefslogtreecommitdiff
path: root/data/zh_cn/dypnsapi-intl
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/dypnsapi-intl
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/dypnsapi-intl')
-rw-r--r--data/zh_cn/dypnsapi-intl/2017-07-25/api-docs.php398
1 files changed, 123 insertions, 275 deletions
diff --git a/data/zh_cn/dypnsapi-intl/2017-07-25/api-docs.php b/data/zh_cn/dypnsapi-intl/2017-07-25/api-docs.php
index 4bdf5c6..d55a07a 100644
--- a/data/zh_cn/dypnsapi-intl/2017-07-25/api-docs.php
+++ b/data/zh_cn/dypnsapi-intl/2017-07-25/api-docs.php
@@ -1,29 +1,14 @@
<?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' => ['StartVerification', 'SearchVerification', 'CheckVerification'],
'components' => [
'schemas' => [],
],
'apis' => [
- 'StartVerification' => [
- 'summary' => '通过指定的通道向最终用户发送验证码,支持的通道有短信、语音、和whatsapp。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CheckVerification' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -35,44 +20,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' => '认证通道,包括短信(SMS)、语音(VOCIE)、whatsApp(WHATSAPP)。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'SMS',
- ],
+ 'schema' => ['description' => '控制台配置的ServiceID。', 'type' => 'string', 'required' => false, 'example' => 'FA00000000000001'],
],
[
'name' => 'To',
'in' => 'query',
- 'schema' => [
- 'description' => '接收短信号码。号码格式为:国际区号+号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6212345****01',
- ],
+ 'schema' => ['description' => '接收短信号码。号码格式为:国际区号+号码。', 'type' => 'string', 'required' => false, 'example' => '6212345****01'],
],
[
- 'name' => 'ServiceSid',
+ 'name' => 'Code',
'in' => 'query',
- 'schema' => [
- 'description' => '控制台配置的ServiceID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FA00000000000001',
- ],
+ 'schema' => ['description' => '验证码。', 'type' => 'string', 'required' => true, 'example' => '1234'],
+ ],
+ [
+ 'name' => 'VerificationId',
+ 'in' => 'query',
+ 'schema' => ['description' => '发送验证码接口返回的唯一认证ID。', 'type' => 'string', 'required' => true, 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I'],
],
],
'responses' => [
@@ -80,67 +52,41 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID,阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Model' => [
- 'description' => '请求结果数据,如果请求成功则返回。',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "verifyCode": "",'."\n"
- .' "verificationId": "",'."\n"
- .' "status": ""'."\n"
- .' }',
- ],
- 'Code' => [
- 'description' => '返回code。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- .' '."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求ID,阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62'],
+ 'Message' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'OK'],
+ 'Model' => ['description' => '请求结果数据,请求正确返回。', 'type' => 'object', 'example' => ' {'."\n"
+ .' "phoneNumber": "",'."\n"
+ .' "channel": "",'."\n"
+ .' "verificationId": "",'."\n"
+ .' "status": "approved"'."\n"
+ .' }'],
+ 'Code' => ['description' => '接口返回状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ ."\n"
+ .'- **false**:调用失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorMessage' => 'The parameter is invalid.',
- 'errorCode' => 'Invalid.Parameters',
- ],
+ ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'Invalid.Parameters', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '校验验证码',
+ 'summary' => '调用CheckVerification接口完成验证码校验。',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T08:40:16.000Z', 'description' => 'OpenAPI 下线'],
],
- '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' => '发送验证码',
+ '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"}]',
],
'SearchVerification' => [
'summary' => '查询验证结果详情。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -153,9 +99,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '171585',
- 'abilityTreeNodes' => [
- 'FEATUREdypnsL4YHVT',
- ],
+ 'abilityTreeNodes' => ['FEATUREdypnsL4YHVT'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -163,75 +107,37 @@
[
'name' => 'ServiceSid',
'in' => 'query',
- 'schema' => [
- 'description' => '控制台配置的ServiceID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FA00000000000001',
- ],
+ 'schema' => ['description' => '控制台配置的ServiceID。', 'type' => 'string', 'required' => false, 'example' => 'FA00000000000001'],
],
[
'name' => 'To',
'in' => 'query',
- 'schema' => [
- 'description' => '接收短信号码。号码格式为:国际区号+号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6212345****01',
- ],
+ 'schema' => ['description' => '接收短信号码。号码格式为:国际区号+号码。', 'type' => 'string', 'required' => false, 'example' => '6212345****01'],
],
[
'name' => 'Code',
'in' => 'query',
- 'schema' => [
- 'description' => '验证码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1234',
- ],
+ 'schema' => ['description' => '验证码。', 'type' => 'string', 'required' => false, 'example' => '1234'],
],
[
'name' => 'VerificationId',
'in' => 'query',
- 'schema' => [
- 'description' => '发送验证码接口返回的唯一认证ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I',
- ],
+ 'schema' => ['description' => '发送验证码接口返回的唯一认证ID。', 'type' => 'string', 'required' => false, 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I'],
],
[
'name' => 'SendDate',
'in' => 'query',
- 'schema' => [
- 'description' => '短信发送日期,格式为毫秒时间戳。支持查询最近30天的记录。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1677600000000,',
- ],
+ 'schema' => ['description' => '短信发送日期,格式为毫秒时间戳。支持查询最近30天的记录。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1677600000000,'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页的大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页的大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页数。取值从1开始。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '当前页数。取值从1开始。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
],
'responses' => [
@@ -239,71 +145,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID,阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62'."\n",
- ],
- 'Message' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Model' => [
- 'description' => '请求结果数据。',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "records": ['."\n"
- .' {'."\n"
- .' "sendDate":,'."\n"
- .' "channel": "",'."\n"
- .' "serviceSid": "",'."\n"
- .' "to": "",'."\n"
- .' "updatedDate":,'."\n"
- .' "verificationId": "",'."\n"
- .' "status": ""'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "pageNo": ,'."\n"
- .' "totalPage": 1,'."\n"
- .' "pageSize": 20,'."\n"
- .' "totalCount": 1,'."\n"
- .' }',
- ],
- 'Code' => [
- 'description' => '返回code。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- ."\n"
- .' - **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求ID,阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62'."\n"],
+ 'Message' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'OK'],
+ 'Model' => ['description' => '请求结果数据。', 'type' => 'object', 'example' => '{'."\n"
+ .' "records": ['."\n"
+ .' {'."\n"
+ .' "sendDate":,'."\n"
+ .' "channel": "",'."\n"
+ .' "serviceSid": "",'."\n"
+ .' "to": "",'."\n"
+ .' "updatedDate":,'."\n"
+ .' "verificationId": "",'."\n"
+ .' "status": ""'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "pageNo": ,'."\n"
+ .' "totalPage": 1,'."\n"
+ .' "pageSize": 20,'."\n"
+ .' "totalCount": 1,'."\n"
+ .' }'],
+ 'Code' => ['description' => '返回code。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ ."\n"
+ .' - **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询验证结果',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T08:40:15.000Z', 'description' => 'OpenAPI 下线'],
],
'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' => '查询验证结果',
],
- 'CheckVerification' => [
- 'summary' => '调用CheckVerification接口完成验证码校验。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartVerification' => [
+ 'summary' => '通过指定的通道向最终用户发送验证码,支持的通道有短信、语音、和whatsapp。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -315,53 +196,32 @@
'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' => '控制台配置的ServiceID。',
+ 'description' => '认证通道,包括短信(SMS)、语音(VOCIE)、whatsApp(WHATSAPP)。',
'type' => 'string',
- 'required' => false,
- 'example' => 'FA00000000000001',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'SMS',
],
],
[
'name' => 'To',
'in' => 'query',
- 'schema' => [
- 'description' => '接收短信号码。号码格式为:国际区号+号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6212345****01',
- ],
+ 'schema' => ['description' => '接收短信号码。号码格式为:国际区号+号码。', 'type' => 'string', 'required' => true, 'example' => '6212345****01'],
],
[
- 'name' => 'Code',
+ 'name' => 'ServiceSid',
'in' => 'query',
- 'schema' => [
- 'description' => '验证码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1234',
- ],
- ],
- [
- 'name' => 'VerificationId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '发送验证码接口返回的唯一认证ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I',
- ],
+ 'schema' => ['description' => '控制台配置的ServiceID。', 'type' => 'string', 'required' => true, 'example' => 'FA00000000000001'],
],
],
'responses' => [
@@ -369,63 +229,51 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID,阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62',
- ],
- 'Message' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Model' => [
- 'description' => '请求结果数据,请求正确返回。',
- 'type' => 'object',
- 'example' => ' {'."\n"
- .' "phoneNumber": "",'."\n"
- .' "channel": "",'."\n"
- .' "verificationId": "",'."\n"
- .' "status": "approved"'."\n"
- .' }',
- ],
- 'Code' => [
- 'description' => '接口返回状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- **true**:调用成功。'."\n"
- ."\n"
- .'- **false**:调用失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求ID,阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'],
+ 'Model' => ['description' => '请求结果数据,如果请求成功则返回。', 'type' => 'object', 'example' => '{'."\n"
+ .' "verifyCode": "",'."\n"
+ .' "verificationId": "",'."\n"
+ .' "status": ""'."\n"
+ .' }'],
+ 'Code' => ['description' => '返回code。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- **true**:调用成功。'."\n"
+ .' '."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorMessage' => 'The parameter is invalid.',
- 'errorCode' => 'Invalid.Parameters',
- ],
+ ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'Invalid.Parameters', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '发送验证码',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T08:40:15.000Z', 'description' => 'OpenAPI 下线'],
],
- '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' => '校验验证码',
+ '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"}]',
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dypnsapi-intl.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dypnsapi-intl.ap-southeast-1.aliyuncs.com', 'vpc' => 'dypnsapi-intl-vpc.ap-southeast-1.aliyuncs.com'],
+ ],
+ '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 下线', 'api' => 'SearchVerification'],
+ ['description' => 'OpenAPI 下线', 'api' => 'StartVerification'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CheckVerification'],
+ ],
+ 'createdAt' => '2025-08-01T08:40:15.000Z',
+ 'description' => '',
],
],
];