预约使用
即接即用,玖云平台为您提供稳定的通信能力
开发者账户使用使用指南
开放接口使用指南
平台审核标准
平台服务标准
Rest API接口介绍
取消通话接口
通话记录查询接口
录音及下载接口
专线语音接口
专号通接口
专号通号码申请接口
专号通号码查询接口
专号通号码释放接口
应用映射号码查询接口
语音通知下发接口
取消预约语音通知接口
语音通知记录查询接口
语音验证码接口
智能语音验证接口
订单小号绑定接口
订单小号解绑接口
订单小号查询接口
订单小号话单查询接口
虚拟小号绑定接口
虚拟小号解绑接口
虚拟小号查询接口
虚拟小号在线呼叫接口
虚拟小号话单查询接口
工作号被叫绑定接口
云呼小号在线呼叫接口
批量上传号码接口
手机专号通绑定接口
手机专号通解绑接口
手机专号通更新接口
手机专号通查询接口
手机专号通双呼接口
云话机回拨接口
SDK产品简介
SDK集成指南
来电推送配置指南
Web
Android
Ios
更多
常见问题
专线语音回调通知接口
专号通回调通知接口
语音通知状态回调接口
语音验证码回调接口
智能语音验证回调接口
订单小号状态回调接口
虚拟小号状态回调接口
云呼小号状态回调
AI智能语音回调接口
语音回呼回调接口
手机专号通回调接口
云双呼回调接口
云呼AXB回调接口
云话机回调通知接口
全局错误码表
开发者调用语音验证码接口前,需要先建立显号池(具体方法可联系工作人员)。号码池建立后,通过本接口动态申请一个可用显示号码。
/{softVersion}/Accounts/{accountSid}/VoiceValidate/requestCall
REST API是通过HTTPS POST方式请求。
参数名称 | 类型 | 约束 | 说明 |
appId | String | 必选 | 应用ID |
voiceRecId | String | 可选 | 语音验证码自定义模板ID,6位数字 |
verifyCode | String | 必选 | 验证码内容,为数字0~9,长度4-8位 |
called | String | 必选 | 被叫电话号码 |
callDisplayNumber | String | 可选 | 被叫显示号码 |
参数说明:
(1).appId:应用ID
(2).voiceRecId:语音验证码自定义模板ID,6位数字
(3).verifyCode:验证码内容,为数字0~9,长度4-8位
(4).called:被叫电话号码 (可以是正常手机号码、固定号码,被叫为座机时需要添加区号,如:075512345678)
(5).callDisplayNumber:被叫显示号码,需在用户号码池中随机选择
特殊说明:
请求示例
JSON请求示例POST /2016-01-01/Accounts/798b9ec0eaa94142852aa2c402570146/VoiceValidate/requestCall?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", "voiceRecId":"123456"," "verifyCode":"123456", "called":"18612345678", "callDisplayNumber":"075512345678" } }XML请求示例
POST /2016-01-01/Accounts/798b9ec0eaa94142852aa2c402570146/VoiceValidate/requestCall?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> <voiceRecId>123456</voiceRecId> <verifyCode>123456</verifyCode> <called>18612345678</called> <callDisplayNumber>075512345678</callDisplayNumber> </req>
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考 Rest 错误代码 |
dateCreated | String | 必选 | 响应时间:格式"yyyy/MM/dd HH:mm:ss"。如:2016/01/01 12:00:00 |
represent | String | 可选 | 错误描述,报错时返回,请求正常不返回 |
requestId | String | 可选 | 一个由32个字符组成的电话唯一标识符 |
callDisplayNumber | String | 可选 | 本次请求实际外显号码 |
响应示例
JSON响应示例HTTP/1.1 200 OK Content-Length: 126 { "resp": { "statusCode": "000000", "dateCreated": "2016/03/24 15:36:52", "requestId": "123456", "callDisplayNumber": "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>A2102X779X0008005970</requestId> <callDisplayNumber>13036894925</callDisplayNumber> </resp>
代码 | 含义 |
900800 | 模板ID格式不符 |
900801 | 验证码为空 |
900801 | 验证码为空 |
900802 | 验证码格式不符 |
900803 | 被叫电话号码为空 |
900804 | 被叫电话号码格式不符 |
900805 | 被叫显号格式不符 |
900806 | 显号池无可用显号 |
900807 | 显号池无此号码 |
900808 | 被叫黑名单号码限制 |
900809 | 被叫显号黑名单号码限制 |
900810 | 语音模板不存在 |