first commitHEADv1.0.0+20260212main

1 files changed, 410 insertions, 0 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
new file mode 100644
index 0000000..e9f319d
--- /dev/null
+++ b/data/en_us/dypnsapi-intl/2017-07-25/api-docs.php
@@ -0,0 +1,410 @@
+<?php return [
+    'version' => '1.0',
+    'info' => [
+        'style' => 'RPC',
+        'product' => 'Dypnsapi-intl',
+        'version' => '2017-07-25',
+    ],
+    'directories' => [
+        'StartVerification',
+        'SearchVerification',
+        'CheckVerification',
+    ],
+    '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',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'operationType' => 'readAndWrite',
+            'deprecated' => false,
+            'systemTags' => [
+                'operationType' => 'create',
+                'riskType' => 'none',
+                'chargeType' => 'free',
+                'abilityTreeCode' => '171584',
+                'abilityTreeNodes' => [
+                    'FEATUREdypnsL4YHVT',
+                ],
+                'autoTest' => true,
+                'tenantRelevance' => 'publicInformation',
+            ],
+            'parameters' => [
+                [
+                    'name' => 'Channel',
+                    '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',
+                    ],
+                ],
+                [
+                    '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',
+                    ],
+                ],
+                [
+                    'name' => 'ServiceSid',
+                    'in' => 'query',
+                    'schema' => [
+                        'description' => 'The service ID that is displayed in the Phone Number Verification Service console.'."\n",
+                        'type' => 'string',
+                        'required' => true,
+                        'example' => 'FA00000000000001',
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    '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',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [
+                400 => [
+                    [
+                        'errorMessage' => 'The parameter is invalid.',
+                        'errorCode' => 'Invalid.Parameters',
+                    ],
+                ],
+            ],
+            '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',
+        ],
+        'SearchVerification' => [
+            'summary' => 'Queries the result of a verification.',
+            'methods' => [
+                'post',
+                'get',
+            ],
+            'schemes' => [
+                'http',
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'operationType' => 'read',
+            'deprecated' => false,
+            'systemTags' => [
+                'operationType' => 'get',
+                'riskType' => 'none',
+                'chargeType' => 'free',
+                'abilityTreeCode' => '171585',
+                'abilityTreeNodes' => [
+                    'FEATUREdypnsL4YHVT',
+                ],
+                'autoTest' => true,
+                'tenantRelevance' => 'publicInformation',
+            ],
+            'parameters' => [
+                [
+                    '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',
+                    ],
+                ],
+                [
+                    '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',
+                    ],
+                ],
+                [
+                    'name' => 'Code',
+                    'in' => 'query',
+                    'schema' => [
+                        'description' => 'The verification code.'."\n",
+                        'type' => 'string',
+                        'required' => false,
+                        'example' => '1234',
+                    ],
+                ],
+                [
+                    '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',
+                    ],
+                ],
+                [
+                    '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,',
+                    ],
+                ],
+                [
+                    'name' => 'PageSize',
+                    'in' => 'query',
+                    'schema' => [
+                        'description' => 'The number of entries to return on each page.'."\n",
+                        'type' => 'integer',
+                        'format' => 'int64',
+                        'required' => false,
+                        'example' => '10',
+                    ],
+                ],
+                [
+                    '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',
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    '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',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            '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',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'operationType' => 'readAndWrite',
+            'deprecated' => false,
+            'systemTags' => [
+                'operationType' => 'create',
+                'riskType' => 'none',
+                'chargeType' => 'free',
+                'abilityTreeCode' => '171586',
+                'abilityTreeNodes' => [
+                    'FEATUREdypnsL4YHVT',
+                ],
+                'autoTest' => true,
+                'tenantRelevance' => 'publicInformation',
+            ],
+            'parameters' => [
+                [
+                    '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',
+                    ],
+                ],
+                [
+                    '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',
+                    ],
+                ],
+                [
+                    'name' => 'Code',
+                    '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',
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    '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',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [
+                400 => [
+                    [
+                        'errorMessage' => 'The parameter is invalid.',
+                        'errorCode' => 'Invalid.Parameters',
+                    ],
+                ],
+            ],
+            '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',
+        ],
+    ],
+    'endpoints' => [
+        [
+            'regionId' => 'ap-southeast-1',
+            'endpoint' => 'dypnsapi-intl.ap-southeast-1.aliyuncs.com',
+        ],
+    ],
+];