实时调用
所有文档
menu

客悦·智能外呼平台 AIOB

实时调用

产品详情立即使用

描述

调用接口,可实现电话的实时调用并呼叫,支持排队,可配置截止呼叫时间,超过截止呼叫时间,则不再拨打,直接进行数据回调。

拨打URL

https://aiob-open.baidu.com/api/v3/console/realtime/status/create
https://aicc.bce.baidu.com/api/v3/console/realtime/status/create即将下架

HTTP Method

POST

请求参数

Header

参数名称 是否必须 说明 示例
Content-Type application/json application/json
Authorization 参考「生成认证Token」文档 cc-api-auth-v1/5b050c050f5a4e74b8c20bf512e39c1d/2021-04-13T08:05:43Z/1800000/host;x-bce-date/746ed9ad706c379f31bafc292e3c720797e39bb7f08ce5f641d657e14e42dd33

Body

参数名称 类型 是否必须 说明 示例
robotId string 机器人id "2dc37b0f-47b7-4d41-b5da-1085399ef65d"
mobile string 被叫号码,加密类型为「系统加密」和「自定义加密」时,被叫号码需为密文,每次调用只能传一个号码 "172XXXXX323"
callerNum array 主叫号码,字符串数组,为空则从租户所有主叫中随机选择 ["0206xxx2195"]
secretType int 加密类型, 1:系统加密,即被叫号码采用系统的加密方式,AES128加密;2:不加密,即被叫号码为明文;3:自定义加密,即被叫号码采用客户自定义的加密方式,需在配置台-隐私配置-其他配置中配置自定义加解密服务地址,便于请求解密 1
stopDate string 呼叫截止时间,yyyy-MM-dd HH:mm:ss,默认为空,则不限制呼叫截止时间 "2021-10-01 00:00:00"
dialogVar obj 变量信息,用于短信或机器人对话中使用 { "name":"12323"}
promptVar obj 变量信息,用在prompt中 { "age":"18"}
secretId string 加密ID ,加密类型为「系统加密」时,加密ID从「配置台」-「隐私配置」-「系统密钥」中获取;加密类型为「自定义加密」时,可输入解密所需的密钥标识,非必填; 29
plainText string 明文, 如果加密类型为系统加密,则必填 29234
cipherText string 密文,为明文plainText加密后的密文, 如果加密类型为系统加密,则必填 fghjdhffjdkfdkfdk
callBackUrl string 任务级别,指定当前任务回调的地址,如果没有配置默认按照全局配置推送 https://127.0.0.1:8080/dataCallBack
extJson string 调用方的业务随路数据, 字符串,百度侧原文回传 xxxx

响应参数

名称 类型 备注
code int http响应码,比如200、400 200即成功
msg string 响应信息,失败显示具体原因
data obj 返回数据

data数据

参数名称 类型 描述
memberId long 被叫号码系统唯一标识,可根据该标识查询通话记录

请求示例

{
  "robotId": "2dc37b0f-47b7-4d41-b5da-1085399ef65d",
  "mobile": "172XXXXX323",
  "callerNum": ["0206xxx2195"],
  "secretType": 2,
  "stopDate": "2021-10-01 00:00:00",
  "dialogVar": {
      "name": "12323"
  },
  "promptVar": {
      "age": "18"
  },
  "secretId": "",
  "plainText": "" ,
  "cipherText": ""
}

响应示例

  {
      "code": 200,
      "msg": "success",
      "data": {
          "memberId": 673096993226752
      }
  }
上一篇
批量任务
下一篇
数据回调