回调接口

1.1 回调地址

POST /{callback}
说明:回调地址在机器人平台【系统设置】-【接口设置】里配置。

1.2  回调参数

属性类型描述说明
botIdint机器人id例如:4900

taskId

string

任务id

外呼任务的taskid

taskNamestring任务名称例如:外呼任务01
disnumberstring显号例如:4022000001

callid

string

呼叫id

例如:3E8-5B2B55D8-16ED-0

direction

string

呼叫类型 

呼叫类型:0-外呼、1-呼入

caller

string

主叫

主叫号码

called

string

被叫

被叫号码

startTime

string

接听时间

时间格式:2020-10-10 10:00:00

endTime

string

挂机时间

时间格式:2020-10-10 10:00:00

duration

string

通话时长

单位:秒

reason

int

呼叫状态

呼叫失败原因:0-成功、非0-失败

hangupPartstring挂断方系统端、用户端

recordUrl

string

录音下载地址如果没有录音,则返回为空
userdatastring扩展字段用户扩展字段
tagsarray客户标签例如:["是本人","同意还款"]

text

array

对话文本JSON数组格式

idx

int

必选

对话序列

role

string

必选讲话角色user-用户,robot-机器人
msgstring必选讲话内容

1.3  请求示例

  • POST /{callback} HTTP/1.1
  •   
  • {
  •     "botId": 4900,
  •     "taskId": "1234567890",
  •     "taskName": "外呼任务01",
  •     "disnumber": "4022000001",
  •     "callid": "3E8-5B2B55D8-16ED-0",
  •     "direction": 1,
  •     "caller": "12345678901",
  •     "called": "13100010001",
  •     "startTime": "2020-10-10 10:00:00",
  •     "endTime": "2020-10-10 10:00:00",
  •     "duration": 30,
  •     "reason": 0,
  •     "hangupPart":"用户端",
  •     "recordUrl": "https://ip:port/xxx/2020-10-10/10-00/01053270142_13800138000_20180823161604.wav",
  •     "userdata": "ABC100",
  •     "tags": ["是本人"],
  •     "text": [{
  •         "idx": 1,
  •         "role": "robot",
  •         "msg": "您好,请问您是张三吗"
  •     }, {
  •         "idx": 2,
  •         "role": "user",
  •         "msg": "嗯"
  •     }]
  • }

1.4 响应包体

属性类型说明
statuscodestring请求状态码,取值:000000(成功)

1.5 响应示例

  • HTTP/1.1 200 OK
  • Content-Length: 641
  •   
  • {
  •     "statuscode":"000000"
  • }