请求方式:POST
请求地址: https://voice.heclouds.com:8002/v1/onenet/voice/notify
参数名称 | 是否必填 | 参数值 |
---|---|---|
Authorization | 是 | 详见鉴权认证 |
Content-Type | 是 | application/json;charset=utf-8 |
参数名称 | 类型 | 长度 | 是否必填 | 说明 |
---|---|---|---|---|
appid | String | 32 | 是 | 应用标识 由OneNET平台生成 |
participant_address | String | 20 | 是 | 外呼被叫号码MSISDN 举例8618625150488 |
display | String | 64 | 是 | 号显号码(业务号码) 由OneNET平台提供 |
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次 |
Content-Type: application/json;charset=utf-8
Accept: application/json
Authorization:version=v1&res=onenet_voice%2Ffd977e9f94e44f239f18f6f919282569&et=1568341874&method=md5&sign=uMJm8NxLshHNkW9qqQF1Gg%3D%3D
{
"actions": [
{
"tts_template": "89",
"param_value": {"param1": "张三"},
"collect_length": "1",
"replay_after_collection": "true",
"collect_content_trigger_replaying": "1",
"operation": "PlayAndCollect"
}
],
"appid": "fd977e9f94e44f239f18f6f919282569",
"display": "02066240200",
"notify_url": "http:10.10.3.71:80/thirdParty/callback/statusback",
"participant_address": "8618102383000"
}
参数名称 | 类型 | 长度 | 是否必填 | 说明 |
---|---|---|---|---|
request_id | String | 32 | 是 | 请求Id http请求唯一识别码 |
code_no | String | 6 | 是 | 返回编码 |
code | String | 512 | 是 | 返回码 |
message | String | 512 | 是 | 返回描述信息 |
data | Data | - | 是 | 呼叫结果信息 Data详细参数说明如下所示 |
参数名称 | 类型 | 长度 | 是否必填 | 说明 |
---|---|---|---|---|
call_id | String | 64 | 是 | 呼叫标识 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Connection: close
{
"request_id": "85fcaba7045247c88b87380149ea0941",
"code_no": "000000",
"code": "OneNET_common_success",
"message": "调用成功",
"data": {
"call_id": "150104227912386807"
}
}
目前的响应码汇总如下,根据实际情况可能有所调整。
code_no | code | message |
---|---|---|
000000 | onenet_common_success | 成功 |
000111 | onenet_common_systemException | 系统异常,请稍后重试 |
000001 | onenet_common_systemBusy | 系统繁忙,请稍后重试 |
000002 | onenet_common_authException | 系统认证失败 |
000004 | onenet_common_invalidParams | 非法的参数 |
000005 | onenet_common_invalidReqParams | 非法的请求参数 |
000006 | onenet_common_paramNullException | 必输参数不能为空 |
000012 | onenet_common_JsonException | 非法JSON的数据 |
000014 | onenet_common_authorizationIsNull | 鉴权参数为空 |
000015 | onenet_common_authorizationFailed | 鉴权失败 |
001001 | onenet_iaepVoice_callIdNotExist | 呼叫标识不存在 |
001005 | onenet_iaepVoice_NumberFormatRrror | 号码格式错误 |
001008 | onenet_iaepVoice_BusinessNumberMismatch | 业务号码不匹配 |
001009 | onenet_iaepVoice_NotOpenTheBusiness | 用户没有开通该业务 |
001010 | onenet_iaepVoice_TheBusinessIsClosed | 用户该项业务已关闭 |