接口调用说明
通过该接口批量创建客服账号。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/create_members?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/create_members | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
请求包示例
{"MemberList": [{"NickName": "客服1","MemberMail": "kefu1@tencent.com","RoleIDList": [5, 7],"MemberGroupIDList": []},{"NickName": "客服2","MemberMail": "kefu2@tencent.com","RoleIDList": [5],"MemberGroupIDList": []}],"SendPassword": true}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
MemberList | Array | 必填 | 待创建的客服账号列表,单次最多支持10个账号。 |
NickName | String | 选填 | 客服昵称,最大长度32字符。 |
MemberMail | String | 必填 | 客服邮箱,作为登录账号。 |
RoleIDList | Array | 选填 | 该客服绑定的角色 ID 列表。 角色列表: 超级管理员: 1 在线员工:5 在线管理员:7 |
MemberGroupIDList | Array | 选填 | 该客服所属的客服分组 ID 列表。 说明: 系统会将客服成员默认添加到默认分组。 |
SendPassword | Boolean | 选填 | 是否发送密码邮件。 true 表示发送(默认值)。 false 表示不发送。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","ErrorMemberList": [{"MemberMail": "kefu2@tencent.com","Code": "141004","Message": "参数非法"}]}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 请求错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
ActionStatus | String | 请求处理的结果。 |
ErrorMemberList | Array | 创建失败的客服账号列表。 |
MemberMail | String | 创建失败的客服邮箱。 |
Code | String | 错误码。 |
Message | String | 错误信息。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
141000 | 该应用非智能客服应用。 |
141002 | 内部错误,请重试。 |
141004 | 参数非法。 |
141009 | 接口限频。 |