OneNET物联网平台 平台介绍 入门手册 设备开发指南 应用开发指南
API
API使用 API列表 SDK MQTT LwM2M EDP Modbus TCP
消息队列MQ HTTP推送
服务定价 扩展服务 常见问题 发布公告

语音通知

语音通知

请求方式:POST

请求地址: https://voice.heclouds.com:8002/v1/onenet/voice/notify

HTTP头部

参数名称 是否必填 参数值
Authorization 详见鉴权认证
Content-Type application/json;charset=utf-8

请求body

参数名称类型长度是否必填说明
appidString32应用标识
由OneNET平台生成
participant_addressString20外呼被叫号码MSISDN
举例8618625150488
displayString64号显号码(业务号码)
由OneNET平台提供
actionsCallActionType[]-呼叫操作指示,参考CallActionType定义
仅支持Play和PlayAndCollect
notify_urlString512用户指定的通知地址(请求方式为POST)
如无此字段,则根据OneNET平台配置为准
呼叫操作类型CallActionType参数说明
参数名称类型长度是否必填说明
operationString32操作类型
Play:放音
PlayAndCollect:放音及收号
tts_templateString20tts模板编号
用户向OneNET提交的通知模板,需审核通过后才能使用
param_valueString-模板中需要填充的参数
参数内容为UTF-8编码,JSON Object的格式为{"var1":"aa","var2":"aa"},其中var1,var2为模板变量名称,var的个数可变
collect_lengthString32收号长度
当operation=PlayAndCollect时有效,如果replayAfterCollection=false或未配置,系统会将用户输入的号码通过呼叫状态通知API发送给第三方;如果replayAfterCollection=true,则不会将收号结果上报给第三方
取值范围
1~32:收号,取值表示收号位长,最大支持32位
replay_after_collectionString-重新播放标识
当operation=PlayAndCollect时有效,此字段用于设置是否在收号后重新播放指定的放音
true:播放
false:不播放
默认值:false
collect_content_trigger_replayingString32当replayAfterCollection=true时此参数有效
此字段用于设置触发重新放音的收号内容,只有实际收号内容与该参数值一致时,才重新放音
例如:该参数设置为1,当用户根据收号语音提示按1,两者一致,则重复放音
默认值为1
relay_timeString32重复放音次数
当操作类型为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_idString32请求Id
http请求唯一识别码
code_noString6返回编码
codeString512返回码
messageString512返回描述信息
dataData-呼叫结果信息
Data详细参数说明如下所示
Data参数说明
参数名称类型长度是否必填说明
call_idString64呼叫标识

响应消息示例

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_nocodemessage
000000onenet_common_success成功
000111onenet_common_systemException系统异常,请稍后重试
000001onenet_common_systemBusy系统繁忙,请稍后重试
000002onenet_common_authException系统认证失败
000004onenet_common_invalidParams非法的参数
000005onenet_common_invalidReqParams非法的请求参数
000006onenet_common_paramNullException必输参数不能为空
000012onenet_common_JsonException非法JSON的数据
000014onenet_common_authorizationIsNull鉴权参数为空
000015onenet_common_authorizationFailed鉴权失败
001001onenet_iaepVoice_callIdNotExist呼叫标识不存在
001005onenet_iaepVoice_NumberFormatRrror号码格式错误
001008onenet_iaepVoice_BusinessNumberMismatch业务号码不匹配
001009onenet_iaepVoice_NotOpenTheBusiness用户没有开通该业务
001010onenet_iaepVoice_TheBusinessIsClosed用户该项业务已关闭

个搜索结果,搜索内容 “

    0 个搜索结果,搜索内容 “