OneNET Studio 简介 产品介绍 快速入门 设备接入与管理 应用开发
应用开发流程 新建项目 添加设备 设备分组 场景联动 应用数据流转 应用API 应用长连接 规则引擎(新)
运维监控 数据可视化 边缘计算 人工智能AI 位置定位 语音通话 工业互联网标识 权限管理 服务协议 更新日志

语音通知

语音通知

请求方式:POST

请求地址:https(http)://openapi.heclouds.com/vcs?action=voiceNotify&version=2

HTTP头部

参数名称 是否必填 参数值
Authorization 查看鉴权参数计算方法
Content-Type application/json;charset=utf-8

请求body

参数名称类型长度是否必填说明
participant_addressString20外呼被叫号码MSISDN
举例8618625150488
displayString64业务号码(用户在开发者中心进行资质申请,审核通过后平台分配业务号码)
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次

返回数据

参数名称类型描述
codeString调用失败时,返回的错误码
msgString调用失败时,返回的错误信息
requestIdString调用API时生成的请求标识
successboolean接口是否调用成功
data-调用成功时,返回的业务数据
data.call_idstring呼叫标识

请求示例

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
}

个搜索结果,搜索内容 “

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