B端人工会话历史聊天记录

服务描述

本接口,可用于查询租户下会话中客户与人工客服的历史聊天记录

开发须知

调用本接口前,请先获取appId

服务地址

GET https://{您的专属域名}/report/openapi/v1/statistics/chatRecordHistoryIm

请求参数

参数 位置 类型 是否必填 说明
appId header String Y 应用ID
timestamp header String Y 时间戳,毫秒
sign header String Y 签名
Content-Type header String Y application/json
pageNum param Integer N 页号,由1开始(默认1)
pageSize param Integer N 每页数据条数(默认10)
sessionId param String Y 会话编号,例如E66D83880BF3079E5B3E51184FEE11E5
terminal param String N 终端类型
receiver param Long N 接收者
请求示例数据:
GET http://abc.xyz/report/openapi/v1/statistics/chatRecordHistoryIm?sessionId=77663C7339F387B7CDA138162FF42829&pageNum=1&pageSize=20
sign: fo1OWX+JnfeonAFSGau2gwP1GvFa+RTw5czoBWoz+k3AjV8scDl6JnvFRDj8Lgt1nQxLlmcOhIBN4j7pEE/NAzYjXUFSGo308f5V9dHBnmGLYsqKmgma4cQZLBqHp9T43IZfRX8Zh2/Hp2HOmfTgos/L8GN6YPA8fQ2d5tbtJZrrkBuwA/LEezjOJxSRRRCrcS1ZFVvTZ+cIjYeO4QdC5r5I67LLY/nLbFAFUdQsCzUIytO09vUCLGlKierNhPfCtMzTgZSE9dWO5zJ3L2uCsXM7Od6mPROVpddVafF+BueKjtbL10PwDc9f1eBpGTpgmbOy8Bbx3NIyCjDvhc9Mag==
appId: 99845aaaaebd4d61acccc9b776208f12
timestamp: 1586314097995

返回结果

参数 类型 说明
code String 结果码
message String 结果描述
data PageDTO 分页对象
PageDTO
参数 类型 说明
total Long 总记录数
list ChatRecordHistoryDTO 数据集合
ChatRecordHistoryDTO
参数 类型 说明
recordKind ChatRecordKind(enum) 该记录的类型(客户问题(ROBOT_QUESTION),机器人回答(ROBOT_ANSWER),询前表单(PREFORM_DATA),人工(IM))
msgFrom String 发送者
content String 消息内容
uuid String 前端消息编号
time Long 消息时间戳
type String 消息类型(发起会话(chat_probe),聊天消息(chat),用户离开(chat_close),评价消息(evaluate),消息撤回(revoke))
msgStatus Integer 消息状态(0:未读,1:已读)
chatType Integer 聊天类型(人工-聊天(0),系统-欢迎语(1),系统-访客超时未回复提示消息(10),系统-访客超时未回复-结束会话文案消息(20))
fromTerminal String 发送终端
toTerminal String 接收终端
返回结果示例:
{
  "code": "10000",
  "message": "调用成功",
  "data": {
    "total": 2,
    "list": [
      {
        "recordKind": "PREFORM_DATA",
        "content": "[{\"name\":\"邮箱\",\"value\":\"\",\"code\":\"EMAIL\"},{\"name\":\"姓名\",\"value\":\"1\",\"code\":\"NAME\"},{\"name\":\"手机号\",\"value\":\"\",\"code\":\"PHONE\"}]"
      },
      {
        "recordKind": "IM",
        "fromTerminal": "user_h5",
        "content": "con_close",
        "chatType": 0,
        "type": "chat_close",
        "uuid": "1860d043545342d4923b90c02c28b4ab",
        "time": 1592305796484,
        "msgFrom": "0563d5b2e53f47ac836b1784b7ded2c6"
      }
    ]
  }
}
结果码说明
结果码 说明
10000 请求成功
10001 鉴权失败
10002 找不到对应的公钥,请先上传公钥
20001 请求失败
20002 参数错误
20003 未查询到符合条件的记录

FAQ:

results matching ""

    No results matching ""