注意： 为了确保数据隐私和安全， REST API须通过HTTPS方式请求（查询子账号信息接口除外）
URL请求方式及地址
请求方式：POST
请求地址：https://api.ucpaas.com /{version}/Accounts/{accountSid}/Calls/voiceVerify?sig={SigParameter}
URL参数属性说明
| 属性 | 说明 |
|---|---|
| Version | 云之讯REST API版本号，当前版本号为：2014-06-30 |
| Account | 此参数为默认固定值 |
| accountSid | 注册云之讯官网，在控制台中即可获取此参数 |
| Calls | 业务功能 |
| voiceNotify | 业务操作，业务功能的各类具体操作分支 |
| SigParameter | 请求URL必须带有此参数 |
| Accept | 客户端响应接收数据格式：application/xml、application/json |
| Content-Type | 类型：application/xml;charset=utf-8、application/json;charset=utf-8 |
| Authorization | 验证信息 |
| Content-Length | 包体长度 |
关键点
SigParameter是REST API 验证参数 URL后必须带有sig参数，sig= MD5（账户Id + 账户授权令牌 + 时间戳），共32位(注:转成大写) 使用MD5加密（账户Id + 账户授权令牌 + 时间戳），共32位 时间戳是当前系统时间（24小时制），格式“yyyyMMddHHmmss”。时间戳有效时间为50分钟。 Authorization是包头验证信息 使用Base64编码（账户Id + 冒号 + 时间戳） 冒号为英文冒号 时间戳是当前系统时间（24小时制），格式“yyyyMMddHHmmss”，需与SigParameter中时间戳相同
| 属性 | 类型 | 约束 | 说明 |
|---|---|---|---|
| appId | String | 必选 | 应用Id |
| captchaCode | String | 必选 | 验证码内容[为数字0~9长度为4或6] |
| playTimes | String | 必选 | 语音播放次数 |
| to | String | 必选 | 接收号码 |
| displayNum | String | 必选 | 显示的主叫号码 |
| userData | String | 可选 | 用户透传数据，语音验证码状态通知中获取该数据 |
| 属性 | 类型 | 约束 | 说明 |
|---|---|---|---|
| respCode | String | 必选 | 请求返回的状态码 00000代表成功 |
| callId | String | 必选 | 用户唯一通话标识长度不能超过32 |
| createDate | String | 必选 | 语音验证码发起时间，格式yyyyMMddHHmmss |
业务请求JSON 请求示例
业务请求JSON 请求示例
POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Calls/voiceVerify?sig=4D3C2549D3A487841CB3D84EA7421FCD
Accept=[application/json],
connection=[Keep-Alive],
Authorization=[ Authorization],
content-type=[application/json;charset=UTF-8]
“voiceVerify”:
{
" appId ": "543f603b414841999d48411d9cb8ddf51",
" captchaCode ": "1234",
" playTimes ": "2",
" to ": "13901234567",
" displayNum ": “125904030108”,
" userData ": "1234"
}
正确响应JSON 请求示例
正确响应JSON 请求示例
Response-Code: 200
Content-Type: application/json;charset=utf-8
Headers: {Content-Type=[application/json;charset=utf-8], Content-Length=[163], Date=[Wed, 15 Jun 2016 09:13:58 GMT]}
Payload:{"resp":{"respCode":"000000","voiceVerify":{"callId":"3123456b134657b15fbfcd59e30ba0","createDate":"20160728103603"}}}
错误响应JSON 请求示例
错误响应JSON 请求示例
Response-Code: 200
Content-Type: application/json;charset=utf-8
Headers: {Content-Type=[application/json;charset=utf-8], Content-Length=[22], Date=[Wed, 15 Jun 2016 09:21:54 GMT]}
Payload: {"resp":{"respCode":"102102"}}