客服号查询相关接口
客服号查询相关接口
查询在线的坐席(客服号)
类型
API
URI
/group-dispatch-api/user/queryUserStatus
请求方式
POST、Content-Type: application/json
接口说明
查询在线的坐席以及客服号
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
userId | int | 否 | 坐席 id(不填默认查询所有的坐席) |
userName | String | 否 | 坐席登录账号(不填默认查询所有的坐席) |
source | int | 是 | 来源 1、pc 2、移动端 |
请求示例:
{
"userId": 12,
"source": 2,
"userName": ""
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data List 是 数据 data 响应参数说明
参数名 类型 是否必填 备注 userId int 是 坐席 id agentAccount String 是 坐席账号 whatsAppList List 是 客服号列表 whatsAppList 响应参数说明
参数名 类型 是否必填 备注 whatsApp String 是 whatsApp name String 否 昵称 响应示例
{
"data": [
{
"userId": 12,
"agentAccount": "u1",
"whatsAppList": [
{
"whatsApp": "861821371272",
"name": "jack"
}
]
}
],
"code": 200,
"message": "success"
}
查询所有在线的坐席+客服号
类型
API
URI
/group-dispatch-api/user/queryAllOlWhatsAppInfo
请求方式
POST、Content-Type: application/json
接口说明
查询在线的坐席以及客服号
响应参数说明
参数名 类型 备注 code int 状态码 message String 描述 data list 数据 data 响应参数说明
参数名 类型 备注 source String 来源 1、pc 2、mobile list String 坐席客服号数据 list 响应参数说明
参数名 类型 备注 agentAccount String 坐席账号 userName String 坐席名称 whatsAppList list 客服号列表 whatsAppList 响应参数说明
参数名 类型 备注 whatsApp String whatsapp 账号 name String 客服号昵称 响应示例
{
"code": 200,
"message": "Success ",
"data": [
{
"source": 1,
"list": [
{
"agentAccount": "202503101",
"userName": "202503101",
"whatsAppList": [
{
"whatsApp": "8618217331413",
"name": "chen"
}
],
"userId": 868024
}
]
},
{
"source": 2,
"list": []
}
]
}
查询指定的客服号在线信息
类型
API
URI
/group-dispatch-api/user/queryWhatsAppInfo
请求方式
POST、Content-Type: application/json
接口说明
查询指定的客服号在线信息
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
int | 是 | whatsapp 账号 |
请求示例:
{
"whatsapp": 8618217331412
}
响应参数说明
参数名 类型 备注 code int 状态码 message String 描述 data List 数据 data 响应参数说明
参数名 类型 备注 userId int 坐席 id agentAccount String 坐席账号 whatsApp String whatsapp 号 status int 状态 10 在线 20 掉线 30 离线 40 封号 source int 1、pc 2、mobile 响应示例
{
"code": 200,
"message": "Success ",
"data": {
"agentAccount": "202503101",
"whatsApp": "8618217331411",
"source": 1,
"userId": "868024",
"status": "10"
}
}
查询坐席(客服号)在线状态日志
类型
API
URI
/group-dispatch-api/user/queryUserStatusLog
请求方式
POST、Content-Type: application/json
接口说明
查询坐席(客服号)在线状态日志(最近 50 条)
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
agentAccount | String | 否 | 坐席账号(不填默认查询所有的坐席) |
String | 否 | 客服号 | |
source | int | 是 | 来源(1pc 2 移动端) |
请求示例:
{
"agentAccount": "",
"whatsApp": "573125704139",
"source": 2
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data List 是 数据 data 响应参数说明
参数名 类型 是否必填 备注 userId int 是 坐席 id agentAccount String 是 坐席账号 whatsAppList List 是 客服号列表 (最多 50 条) whatsAppList 响应参数说明
参数名 类型 是否必填 备注 whatsApp String 是 whatsApp name String 否 昵称 status int 是 状态 10 在线 20 掉线 30 离线 40 封号 source int 是 来源(1pc 2 移动端) countryCode String 是 国家 detailStatus int 是 行为类型 createTime int 是 创建时间
行为类型 code 对照
code | 描述 |
---|---|
11 | PC 扫码登录 |
12 | PC 上线 |
13 | 手机上线 |
21 | PC 掉线 |
22 | 手机掉线 |
31 | PC 关闭客服号下线 |
32 | PC 关闭客户端下线 |
33 | PC 触发监控下线 |
34 | 手机删除下线 |
35 | 手机主动退出下线 |
36 | 手机触发监控下线 |
37 | 手机异常下线 |
41 | PC 封号 |
42 | 手机封号 |
43 | 系统标记永久封号 |
- 响应示例
{
"code": 200,
"message": "Success",
"data": [
{
"userId": 621443,
"agentAccount": "lsl001",
"whatsAppList": [
{
"whatsApp": "573125704139",
"name": "",
"status": 20,
"source": 2,
"countryCode": "哥伦比亚",
"detailStatus": 42,
"createTime": "2024-07-08 19:25:31"
}
]
}
]
}
查询坐席最近上线的客服号状态(最近十条)
类型
API
URI
/group-dispatch-api/user/getLatestOnlineWhatsAccount
请求方式
POST、Content-Type: application/json
接口说明
查询坐席最近上线的客服号状态(最近十条)
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
userId | int | 否 | 坐席 id(不填默认查询所有的坐席) |
source | int | 是 | 来源(1pc 2 移动端) |
请求示例:
{
"userId": 621443,
"source": 1
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data List 是 数据 data 响应参数说明
参数名 类型 是否必填 备注 userId int 是 坐席 id agentAccount String 是 坐席账号 whatsAppList List 是 客服号列表 whatsAppList 响应参数说明
参数名 类型 是否必填 备注 whatsApp String 是 whatsApp name String 否 昵称 status int 否 状态 10 在线 20 掉线 30 离线 40 封号 响应示例
{
"code": 200,
"message": "Success ",
"data": [
{
"agentAccount": "lsl001",
"whatsAppList": [
{
"whatsApp": "234567892",
"name": "zhang",
"status": 10
}
],
"userId": 621443
}
]
}
查询客服号最新状态
类型
API
URI
/wscrm-bus-api/whatsapp/queryWhatsappStatus
请求方式
POST、Content-Type: application/json
接口说明
查询客服号最新状态
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
String | 是 | 客服号 |
- 请求示例:
{
"whatsApp": "8218132718231"
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data Object 是 数据
data 参数说明
参数名 类型 是否必填 备注 status int 是 状态 0、离线 1、在线 2、封号
- 响应示例
{
"data": {
"status": 1
},
"code": 200,
"message": "success"
}