data/zh_cn/dypnsapi-intl/2017-07-25/api-docs.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431

<?php return [
    'version' => '1.0',
    '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',
            ],
            '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' => '认证通道，包括短信（SMS)、语音（VOCIE）、whatsApp(WHATSAPP)。',
                        'type' => 'string',
                        'required' => true,
                        'enumValueTitles' => [],
                        'example' => 'SMS',
                    ],
                ],
                [
                    'name' => 'To',
                    'in' => 'query',
                    'schema' => [
                        'description' => '接收短信号码。号码格式为：国际区号+号码。',
                        'type' => 'string',
                        'required' => true,
                        'example' => '6212345****01',
                    ],
                ],
                [
                    'name' => 'ServiceSid',
                    'in' => 'query',
                    'schema' => [
                        'description' => '控制台配置的ServiceID。',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'FA00000000000001',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    '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',
                            ],
                        ],
                    ],
                ],
            ],
            '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' => '发送验证码',
        ],
        'SearchVerification' => [
            'summary' => '查询验证结果详情。',
            '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' => '控制台配置的ServiceID。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'FA00000000000001',
                    ],
                ],
                [
                    'name' => 'To',
                    'in' => 'query',
                    'schema' => [
                        'description' => '接收短信号码。号码格式为：国际区号+号码。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '6212345****01',
                    ],
                ],
                [
                    'name' => 'Code',
                    'in' => 'query',
                    'schema' => [
                        'description' => '验证码。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '1234',
                    ],
                ],
                [
                    'name' => 'VerificationId',
                    'in' => 'query',
                    '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,',
                    ],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    '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',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    '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',
                            ],
                        ],
                    ],
                ],
            ],
            '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' => '查询验证结果',
        ],
        'CheckVerification' => [
            'summary' => '调用CheckVerification接口完成验证码校验。',
            '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' => '控制台配置的ServiceID。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'FA00000000000001',
                    ],
                ],
                [
                    'name' => 'To',
                    'in' => 'query',
                    'schema' => [
                        'description' => '接收短信号码。号码格式为：国际区号+号码。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '6212345****01',
                    ],
                ],
                [
                    'name' => 'Code',
                    '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',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    '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',
                            ],
                        ],
                    ],
                ],
            ],
            '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' => '校验验证码',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'ap-southeast-1',
            'endpoint' => 'dypnsapi-intl.ap-southeast-1.aliyuncs.com',
        ],
    ],
];