预约使用
即接即用,玖云平台为您提供稳定的通信能力
开发者账户使用使用指南
开放接口使用指南
平台审核标准
平台服务标准
Rest API接口介绍
取消通话接口
通话记录查询接口
录音及下载接口
专线语音接口
专号通接口
专号通号码申请接口
专号通号码查询接口
专号通号码释放接口
应用映射号码查询接口
语音通知下发接口
取消预约语音通知接口
语音通知记录查询接口
语音验证码接口
智能语音验证接口
订单小号绑定接口
订单小号解绑接口
订单小号查询接口
订单小号话单查询接口
虚拟小号绑定接口
虚拟小号解绑接口
虚拟小号查询接口
虚拟小号在线呼叫接口
虚拟小号话单查询接口
工作号被叫绑定接口
云呼小号在线呼叫接口
批量上传号码接口
手机专号通绑定接口
手机专号通解绑接口
手机专号通更新接口
手机专号通查询接口
手机专号通双呼接口
云话机回拨接口
SDK产品简介
SDK集成指南
来电推送配置指南
Web
Android
Ios
更多
常见问题
专线语音回调通知接口
专号通回调通知接口
语音通知状态回调接口
语音验证码回调接口
智能语音验证回调接口
订单小号状态回调接口
虚拟小号状态回调接口
云呼小号状态回调
AI智能语音回调接口
语音回呼回调接口
手机专号通回调接口
云双呼回调接口
云呼AXB回调接口
云话机回调通知接口
全局错误码表
开发者调用语音验证码接口,可以使用平台公用号码,也可以使用应用的专属号码。(具体方法可联系工作人员)。
/{softVersion}/Accounts/{accountSid}/Verification/request
REST API是通过HTTPS POST方式请求。
参数名称 | 类型 | 约束 | 说明 |
appId | String | 必选 | 应用ID |
verifyNum | String | 必选 | 待验证手机号码 |
validTime | String | 可选 | 验证有效时长,单位为秒。不填默认300秒,最长不超过3600秒 |
userData | String | 可选 | 用户自定义数据,最长128字节 |
参数说明:
(1).appId:应用ID
(2).verifyNum:待验证手机号码。必须为11位的手机号码
(3).validTime:验证有效时长,单位为秒。传参用字符串类型表述阿拉伯数字,选填。如不传则默认300秒,最长不超过3600秒
(4).userData:用户子定义数据,字符串类型,选填。最长不超过128字节。此参数在回调时会被回传
特殊说明:
(1).同一APPID,同一号码,申请多次,返回相同号码,及request
ID,并更新超时时间,超时时间以最后一次为准,只回调一次。一分钟最多申请3次,超过返回,“申请次数过多”错误提示。
(2).不同APPID,相同号码,申请时返回不同号码,同一时间只能有3个待验证记录,若超过,返回已超过验证上限。
请求示例
JSON请求示例POST /2016-01-01/Accounts/798b9ec0eaa94142852aa2c402570146/Verification/request?sig= 6949C5F977B304EC5BB969FD8838D345HTTP/1.1 Host:127.0.0.1:9080 content-length: 272 Accept: application/json; Content-Type: application/json;charset=utf-8; Authorization: Nzk4YjllYzBlYWE5NDE0Mjg1MjYwMmM0AAI1NzAxNDY6MjAxNjAzMjQxNTE3MDE= { "req": { "appId":"7290fa01293c483fb2709c690f213272", "verifyNum":"13012345678", "validTime":"60", "userData":"abc" } }XML请求示例
POST /2016-01-01/Accounts/798b9ec0eaa94142852aa2c402570146/Verification/request?sig= 230AB7B77C951C9DB5FECD55B3AFB3CFHTTP/1.1 Host:127.0.0.1:9080 content-length: 357 Accept: application/xml; Content-Type: application/xml;charset=utf-8; Authorization: Nzk4YjllYzBlYWE5NDE0Mjg1MjYwMmMAADI1NzAxNDY6MjAxNjAzMjQxNjA2MjI= <?xml version='1.0' encoding='utf-8'?> <req> <appId>7290fa01293c483fb2709c690f213272</appId> <verifyNum>13812345678</verifyNum> <validTime>60</validTime> <userData>abc</userData> </req>
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考 Rest 错误代码 |
dateCreated | String | 必选 | 响应时间:格式"yyyy/MM/dd HH:mm:ss"。如:2016/01/01 12:00:00 |
represent | String | 可选 | 错误描述,报错时返回,请求正常不返回 |
requestId | String | 可选 | 一个由32个字符组成的电话唯一标识符 |
accessNum | String | 可选 | 进行验证的接入号码 |
响应示例
JSON响应示例HTTP/1.1 200 OK Content-Length: 126 { "resp": { "statusCode": "000000", "dateCreated": "2017/04/24 15:36:52", "requestId": " 58ee9f02ffe14926b534ce1e3c4f926f", "accessNum": "075512345678" } }XML响应示例
HTTP/1.1 200 OK Content-Length: 197 <?xml version='1.0'?> <resp> <statusCode>000000</statusCode> <dateCreated>2016/03/24 16:12:44</dateCreated> <requestId>58ee9f02ffe14926b534ce1e3c4f926f</requestId> <accessNum>075512345678</accessNum> </resp>
2 请求地址
3 请求包头
4 请求包体
5 响应包体