Callbot API orderList

callbot-api

v1.0.0

Base URLs:

• 正式环境: https://nxbot.nxcloud.com

aibot外部接口v3.0/订单操作

鉴权方式

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

POST 列出通话订单

POST /callcentre/api/v3/listOrder

列出订单信息，同时列出该订单最后的通话状态

Body 请求参数

{
  "productID": "callbot",
  "userTaskID": "string",
  "options": {
    "orderID": [
      "string"
    ],
    "intentID": [
      "string"
    ],
    "intentName": [
      "string"
    ],
    "intentTag": [
      "string"
    ],
    "intentLevel": [
      0
    ],
    "finish": 1,
    "turnTime": {
      "gt": 0,
      "lt": 0,
      "enable": true
    },
    "callDuration": {
      "gt": 0,
      "lt": 0,
      "enable": true
    },
    "callStatus": [
      1
    ]
  },
  "page": 1,
  "size": 100
}

请求参数

名称	位置	类型	必选	说明
requestID	header	string	是	请求唯一id
uuid	header	string	是	uuid,由被调用方给出
createTs	header	string	是	请求时间戳,(秒级)
sign	header	string	是	签名
algorithm	header	string	否	签名的算法：MD5或者SHA256，不填默认用MD5
body	body	object	否
» productID	body	string	是	产品id，定值"callbot"
» userTaskID	body	string	是	请求方的任务id(调用方生成并且保证唯一)，建议使用uuid
» options	body	object	是	查询条件
»» orderID	body	[string]¦null	否	调用方在导入通话时导入的订单id
»» intentID	body	[string]¦null	否	后台意向标签id，可通过查询该任务所属话术模板的意向标签设置获取
»» intentName	body	[string]¦null	否	后台意向标签名，可通过查询该任务所属话术模板的意向标签设置获取
»» intentTag	body	[string]¦null	否	用户自定义的意向标签tag
»» finish	body	integer¦null	否	已完成通话
»» turnTime	body	object¦null	否	对话轮次
»»» gt	body	integer	否	大于
»»» lt	body	integer	否	小于
»»» enable	body	boolean	是	使用对话轮次条件
»» callDuration	body	object¦null	否	通话时长
»»» gt	body	integer	否	大于
»»» lt	body	integer	否	小于
»»» enable	body	boolean	是	条件是否使用
»» callStatus	body	[integer]¦null	否	通话订单所属的通话的状态。枚举值请参考《通话状态枚举值文档》
» page	body	integer	是	页码
» size	body	integer	是	页面大小

枚举值

属性	值
»» finish	1	未完成订单
»» finish	2	已完成订单
»» 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	通话结束-响铃过长

返回示例

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "totalCount": 0,
  "orderList": [
    {
      "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": null,
            "intentTag": null,
            "intentName": null,
            "intentLevel": 0
          }
        ],
        "sms": [
          {
            "smsSendTs": null,
            "sysMessageID": null,
            "smsContent": null
          }
        ],
        "agent": {
          "agentName": "string",
          "agentGroup": "string",
          "agentCallStatus": "[",
          "agentCallElapsed": 0,
          "agentLabel": "string",
          "manualCallStart": 0,
          "manualCallAnswer": 0,
          "manualCallEnd": 0,
          "manualHangupBy": 0
        },
        "params": [
          {
            "name": null,
            "value": null
          }
        ]
      }
    }
  ]
}

返回结果

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

响应的header

名称	类型	必选	说明
requestID	string	是	与请求头一致
uuid	string	是	与请求头一致
createTs	string	是	响应时的秒级时间戳
sign	string	是	生成方法与请求头sign生成算法一样
algorithm	string	否	与请求头一致，签名的算法：MD5或者SHA256，不填默认用MD5

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» retCode	integer	true	none	响应码，0为成功，其余为失败
» retMsg	string	true	none	响应消息
» responseID	string	true	none	随机唯一id，用于请求追踪，定位问题时需要提供该次请求的responseID
» totalCount	integer	true	none	订单总数
» orderList	[object]	true	none	返回订单列表
»» orderID	string	true	none	订单id
»» userPhone	string	true	none	手机号
»» userName	string	true	none	用户名
»» sceneID	string	true	none	话术模板id
»» userTaskID	string	true	none	用户任务id
»» taskID	string	true	none	任务id
»» finish	boolean	true	none	订单完成
»» other	string	true	none	透传字段
»» callInfoDetail	object	true	none	通话详细信息
»»» callID	string	true	none	通话id
»»» callingNumber	string	true	none	主叫号码
»»» lineAddress	string	true	none	线路IP
»»» callStatus	integer	true	none	通话状态
»»» callStartTs	integer	true	none	通话拨打时间戳
»»» callAnswerTs	integer	true	none	接听时间戳有值不代表通话被接听，请参照callStatus判断通话状态
»»» callEndTs	integer	true	none	通话挂断时间戳
»»» callDuration	integer	true	none	通话接听秒数
»»» callAudioUrl	string	true	none	通话录音url（有效期3个月），格式为wav,形如https://xxxx.wav
»»» hangupCause	string	true	none	挂断原因
»»» termSipCode	string	true	none	sipCode
»»» intents	[object]	true	none	可通过查询该任务所属话术模板的意向标签设置获取
»»»» intentID	string	true	none	意向标签id
»»»» intentTag	string	true	none	可通过查询该任务所属话术模板的意向标签设置获取
»»»» intentName	string	true	none	意向标签名
»»» sms	[object]	false	none	短信
»»»» smsSendTs	integer	true	none	短信发送时间
»»»» sysMessageID	string	true	none	短信发送id
»»»» smsContent	string	true	none	短信发送内容
»»» agent	object	false	none	坐席相关信息
»»»» agentName	string	true	none	接听坐席名
»»»» agentGroup	string	true	none	接听坐席组
»»»» agentCallStatus	integer	true	none	坐席接听状态
»»»» agentCallElapsed	integer	true	none	坐席接听时长
»»»» agentLabel	string	true	none	坐席标签
»»»» manualCallStart	integer	true	none	转人工开始时间戳
»»»» manualCallAnswer	integer	true	none	转人工应答时间戳
»»»» manualCallEnd	integer	true	none	转人工结束时间戳
»»»» manualHangupBy	integer	true	none	被谁挂断了0：none，1：坐席挂断，2：用户挂断
»»» params	[object]	false	none	变量
»»»» name	string	true	none	变量名
»»»» value	string	true	none	变量值

枚举值

属性	值
»» 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	通话完成-用户拒接