接口说明:
接口类型:主动调用接口
接口作用:可通过调用该接口来获取某个用户在系统中的会话记录列表( cid 列表)。
请求方式:
POST
请求地址:
api/chat/5/user/query_cids
1
headers 请求头:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
language | String | 是 | 语言标识:en-英文,zh-中文 |
请求参数:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
visitorid | String | 是 | 访客 id: visitorid 与 partnerid 选择其一 |
partnerid | String | 否 | 企业自己的用户 id,可自行传值 |
from | Integer | 否 | 来源:0:开放平台、1:pc/h5/sdk、2:微信 |
start_time | String | 否 | 开始时间 |
end_time | String | 否 | 结束时间 |
返回参数:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
ret_code | String | 是 | 返回编码 |
ret_msg | String | 是 | 返回信息 |
items | List | 否 | 对象列表 |
items 对象:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
cid | String | 会话 ID | |
start_date_time | String | 会话时间:毫秒 | |
visitorid | String | 访客 id |
请求示例:
curl https://www.sobot.com/api/chat/5/user/query_cids
-X POST
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802'
-d '{
"visitorid" : "xx"
}'
12345678
返回示例:
{
"items": [
{
"cid": "825a57e755a240559e03deec267e6463",
"start_date_time": 1568603119126,
"visitorid": "7f27b999bbe94274ab1a738568aba137"
},
{
"cid": "1874cbc483b64d4b9f1b7f06de083638",
"start_date_time": 1568613840540,
"visitorid": "7f27b999bbe94274ab1a738568aba137"
}
],
"ret_code": "000000",
"ret_msg": "成功"
}