获取客服成员信息列表

最近更新时间:2025-10-24 14:25:42

我的收藏

接口调用说明

通过该接口获取客服账号信息列表,支持分页查询和排序功能。

请求 URL 示例

https://console.tim.qq.com/v4/desk_http_svc/get_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
参数
说明
v4/desk_http_svc/get_member_list
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295。
contenttype
请求格式固定值为 json

请求包示例

{
"PageSize": 20,
"PageNum": 0,
"Order": 0
}

请求包字段说明

字段
类型
属性
说明
PageSize
Integer
必填
查询记录数,取值范围0-100。
如果取值为0,会设置成默认值为15。
PageNum
Integer
必填
当前页码,从0开始计数。
Order
Integer
选填
根据创建时间排序:
0表示升序(默认值)。
1表示降序。

应答包体示例

{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"MemberList": [
{
"NickName": "客服1",
"MemberMail": "kefu1@tencent.com",
"RoleIDList": [5],
"MemberGroupIDList": [101, 102]
},
{
"NickName": "客服2",
"MemberMail": "kefu2@tencent.com",
"RoleIDList": [7],
"MemberGroupIDList": [101]
}
],
"Total": 2
}

应答包字段说明

字段
类型
说明
ErrorCode
Integer
请求错误码:
0表示成功。
非0表示失败。
ErrorInfo
String
错误信息。
ActionStatus
String
请求处理的结果。
MemberList
Array
客服成员信息列表。
NickName
String
客服昵称,最大长度32字符。
MemberMail
String
客服邮箱账号。
RoleIDList
Array
绑定的角色 ID 列表。
MemberGroupIDList
Array
绑定的分组 ID 列表。
Total
Integer
总记录数。

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码
描述
141000
该应用非智能客服应用。
141002
内部错误,请重试。
141004
参数非法。
141009
接口限频。

接口调试工具

通过 REST API 在线调试工具 调试本接口。