Skip to content

Callbot API callCallback

Jcateye edited this page Dec 16, 2024 · 5 revisions

callbot-api

v1.0.0

Base URLs:

aibot外部接口v3.0/回调

鉴权方式

鉴权请查看文档https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization

POST 通话回调(aibot->customer)

POST /api/v3/callCallback

Body 请求参数

{
  "callbackType": 1,
  "orderID": "string",
  "userPhone": "string",
  "userName": "string",
  "sceneID": "string",
  "userTaskID": "string",
  "taskID": "string",
  "finish": true,
  "other": "string",
  "callInfoDetail": {
    "callID": "string",
    "callStatus": 1,
    "callStartTs": 0,
    "callAnswerTs": 0,
    "callEndTs": 0,
    "callDuration": 0,
    "callAudioUrl": "string",
    "hangupCause": "string",
    "termSipCode": "string",
    "intents": [
      {
        "intentID": "string",
        "intentTag": "string",
        "intentName": "string",
        "intentLevel": 0
      }
    ],
    "sms": [
      {
        "smsSendTs": 0,
        "sysMessageID": "string",
        "smsContent": "string"
      }
    ],
    "agent": {
      "agentName": "string",
      "agentGroup": "string",
      "agentCallStatus": 1,
      "agentCallElapsed": 0,
      "agentLabel": "string",
      "manualCallStart": 0,
      "manualCallAnswer": 0,
      "manualCallEnd": 0,
      "manualHangupBy": 0
    },
    "params": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }
}

请求参数

名称 位置 类型 必选 说明
requestID header string 请求唯一id
uuid header string uuid,由被调用方给出
createTs header string 请求时间戳,(秒级)
sign header string 签名,使用的签名算法可在后台->开发者 查看
body body object
» callbackType body integer 回调类型
» orderID body string 订单id
» userPhone body string 手机号
» userName body string 用户名
» sceneID body string 话术模板id
» userTaskID body string 用户任务id
» taskID body string 任务id
» finish body boolean 订单完成
» other body string 透传字段
» callInfoDetail body object 通话详细信息
»» callID body string 通话id
»» callingNumber body string 主叫号码
»» lineAddress body string 线路IP
»» callStatus body integer 通话状态
»» callStartTs body integer 通话拨打时间戳
»» callAnswerTs body integer 通话接听时间戳,接听时间戳有值不代表通话被接听,请参照callStatus判断通话状态
»» callEndTs body integer 通话挂断时间戳
»» callDuration body integer 通话接听秒数
»» callAudioUrl body string 通话录音Url,通话录音url(有效期3个月),格式为wav,形如https://xxxx.wav
»» hangupCause body string 挂断原因
»» termSipCode body string sipCode
»» intents body [object] 意向,可通过查询该任务所属话术模板的意向标签设置获取
»»» intentID body string 意向标签id
»»» intentTag body string 意向标签tag,可通过查询该任务所属话术模板的意向标签设置获取
»»» intentName body string 意向标签名
»»» intentLevel body string 意向优先级
»» sms body [object] 短信
»»» smsSendTs body integer 短信发送时间
»»» sysMessageID body string 短信发送id
»»» smsContent body string 短信发送内容
»» agent body object 坐席相关信息
»»» agentName body string 接听坐席名
»»» agentGroup body string 接听坐席组
»»» agentCallStatus body integer 坐席接听状态
»»» agentCallElapsed body integer 坐席接听时长
»»» agentLabel body string 坐席标签
»»» manualCallStart body integer 转人工开始时间戳
»»» manualCallAnswer body integer 转人工接通时间戳
»»» manualCallEnd body integer 转人工结束时间戳
»»» manualHangupBy body integer 被谁挂断了0:none,1:坐席挂断,2:用户挂断
»» params body [object] 变量
»»» name body string 变量名
»»» value body string 变量值

枚举值

属性
» callbackType 1 任务回调
» callbackType 2 订单回调
» callbackType 3 通话回调
»» callStatus 1 准备通话
»» callStatus 2 调度中
»» callStatus 3 拨打中
»» callStatus 4 响铃中
»» callStatus 5 正在通话
»» callStatus 6 通话结束-完成通话
»» callStatus 8 通话结束-不合法号码
»» callStatus 9 通话结束-暂时无法接通
»» callStatus 10 通话结束-用户占线
»» callStatus 11 通话结束-用户忙线并拒接
»» callStatus 12 通话结束-用户拒接
»» callStatus 13 通话结束-用户拒接
»» callStatus 15 通话结束-tts合成失败
»» callStatus 16 通话结束-未知原因
»» callStatus 17 通话结束-黑名单号码
»» callStatus 18 通话结束-用户叫停
»» callStatus 21 通话结束-无效号码(号码检测非法,不满足当地号段)
»» callStatus 22 通话结束-响铃不接
»» callStatus 23 通话结束-拨打没响应
»» callStatus 24 通话结束-早媒体-语音信箱
»» callStatus 25 通话结束-响铃过长
»»» smsSendTs 0 未发送
»»» smsSendTs 1 已发送
»»» smsSendTs 2 发送成功
»»» smsSendTs 3 发送失败
»»» smsSendTs 4 点击成功
»»» agentCallStatus 1 拨打中
»»» agentCallStatus 2 响铃中
»»» agentCallStatus 3 接通
»»» agentCallStatus 4 完成通话
»»» agentCallStatus 10 通话完成-坐席繁忙
»»» agentCallStatus 12 通话完成-用户拒接

返回示例

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 解释
» retCode integer true none 响应码,0为成功,其余为失败
» retMsg string true none 响应消息
» responseID string true none 响应id,随机唯一id,用于请求追踪,定位问题时需要提供该次请求的responseID

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent(对外api)

Clone this wiki locally