查询会话 - 尘锋SCRM开放平台

接口说明

根据企微明文id查询会话

接口信息

POST https://qw-openapi-tx.dustess.com/ai/v1/agent/getChatByOriginID?accessToken=

Content-Type: application/json

请求参数

请求参数名	类型	说明	是否必须
type	`int`	会话类型，会话类型 0=单聊，1=群聊	true
originContactId	`string`	单聊选传好友明文企微ID	false
originUserId	`string`	单聊选传员工账号ID（企微的明文账号ID）,originContactId和originUserId需同时传值	false
contactName	`string`	单聊选传好友名称精准匹配	false
userName	`string`	单聊选传员工名称精准匹配，contactName和userName需同时传值	false
originGroupId	`string`	群聊选传群明文企微ID	false
groupNameFullMatch	`string`	群聊选传群名称精准匹配	false

请求参数示例
json - Request-Example:

{
    "type": 0, 
    "originContactId": "", 
    "originUserId": "", 
    "contactName": "", 
    "userName": "", 
    "originGroupId": "",
    "groupNameFullMatch": ""
}

成功响应

响应参数名	类型	说明
code	`int32`	响应码
msg	`string`	消息提示
success	`string`	是否成功请求
traceId	`string`	请求链路id
data.chat	`[]object`	会话列表数组
data.chat.id	`int64`	会话id
data.chat.name	`string`	会话名称

成功响应示例

{
    "code": 0,
    "msg": "success",
    "success": true,
    "data": {
        "chat": [
            {
                "id": 12121211212,
                "name": "会话名称xxx"
            }
        ]
    },
    "traceId": "1601ca8f-1ee0-9725-81ba-d49016bc1a34"
}

错误响应示例

{
    "code": 20170309,
    "msg": "参数不能为空",
    "success": false,
    "data": {},
    "traceId": "88146ad5-ac5f-9758-9ebb-0f13eb8ae973"
}

{
    "code": 20170309,
    "msg": "参数不能为空",
    "success": false,
    "data": {},
    "traceId": "88146ad5-ac5f-9758-9ebb-0f13eb8ae973"
}