请求方式:POST
请求地址:https(http)://openapi.heclouds.com/vcs?action=voiceNotify&version=2
| 参数名称 | 是否必填 | 参数值 |
|---|---|---|
| Authorization | 是 | 查看鉴权参数计算方法 |
| Content-Type | 是 | application/json;charset=utf-8 |
| 参数名称 | 类型 | 长度 | 是否必填 | 说明 |
|---|---|---|---|---|
| participant_address | String | 20 | 是 | 外呼被叫号码MSISDN 举例8618625150488 |
| display | String | 64 | 是 | 业务号码(用户在开发者中心进行资质申请,审核通过后平台分配业务号码) |
| actions | CallActionType[] | - | 是 | 呼叫操作指示,参考CallActionType定义 仅支持Play和PlayAndCollect |
| notify_url | String | 512 | 否 | 用户指定的通知地址(请求方式为POST) 如无此字段,则根据OneNET平台配置为准 |
| 参数名称 | 类型 | 长度 | 是否必填 | 说明 |
|---|---|---|---|---|
| operation | String | 32 | 是 | 操作类型 Play:放音 PlayAndCollect:放音及收号 |
| tts_template | String | 20 | 是 | tts模板编号 用户向OneNET提交的通知模板,需审核通过后才能使用 |
| param_value | String | - | 是 | 模板中需要填充的参数 参数内容为UTF-8编码,JSON Object的格式为{"var1":"aa","var2":"aa"},其中var1,var2为模板变量名称,var的个数可变 |
| collect_length | String | 32 | 否 | 收号长度 当operation=PlayAndCollect时有效,如果replayAfterCollection=false或未配置,系统会将用户输入的号码通过呼叫状态通知API发送给第三方;如果replayAfterCollection=true,则不会将收号结果上报给第三方 取值范围 1~32:收号,取值表示收号位长,最大支持32位 |
| replay_after_collection | String | - | 否 | 重新播放标识 当operation=PlayAndCollect时有效,此字段用于设置是否在收号后重新播放指定的放音 true:播放 false:不播放 默认值:false |
| collect_content_trigger_replaying | String | 32 | 否 | 当replayAfterCollection=true时此参数有效 此字段用于设置触发重新放音的收号内容,只有实际收号内容与该参数值一致时,才重新放音 例如:该参数设置为1,当用户根据收号语音提示按1,两者一致,则重复放音 默认值为1 |
| relay_time | String | 32 | 否 | 重复放音次数 当操作类型为Play时,此字段有效 默认为1次 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | String | 调用失败时,返回的错误码 |
| msg | String | 调用失败时,返回的错误信息 |
| requestId | String | 调用API时生成的请求标识 |
| success | boolean | 接口是否调用成功 |
| data | - | 调用成功时,返回的业务数据 |
| data.call_id | string | 呼叫标识 |
POST /vcs?action=voiceNotify&version=2
Content-type: application/json
{
"actions": [
{
"tts_template": "89",
"param_value": {"param1": "张三"},
"collect_length": "1",
"replay_after_collection": "true",
"collect_content_trigger_replaying": "1",
"operation": "PlayAndCollect"
}
],
"display": "02066240200",
"notify_url": "http:10.10.3.71:80/thirdParty/callback/statusback",
"participant_address": "8618102383000"
}
成功
{
"requestId": "a25087f46df04b69b29e90ef0acfd115",
"success": true,
"data": {
"call_id": "150104227912386807"
}
}
失败
{
"code": "iot.vcs.notApplyTestAccount",
"msg": "request ip not equals test account ip",
"requestId": "0d9a3bab49ee458984743d5ee59eafab",
"success": false
}