接口调用说明
该接口可以指定客服人员或者指定分组对用户主动发起人工会话。该接口只能用于集成方式为“SDK 轻量集成”的应用中。
请求URL示例
https://console.tim.qq.com/v4/desk_http_svc/contact_user?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/contact_user | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
请求包示例
{"IMAgentUserID": "@customer_service_account","ClientUserID": "1289314544","GroupId": 9465,"MemberId": "1289316687@qq.com"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
IMAgentUserId | String | 必填 | 客服号的 UserID。 |
ClientUserId | String | 必填 | 联系的用户 ID。 |
GroupId | Integer | 选填 | 指定分配的客服分组,若不填,则按默认策略分配客服。 |
MemberId | String | 选填 | 指定的客服成员 ID,若不填,则按默认策略分配客服。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"MemberId": "test@qq.com"}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
ActionStatus | String | 请求处理的结果。 |
MemberId | String | 分配的客服成员。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
141000 | 非智能客服的应用不允许调用此接口。 |
141001 | 分配人工客服失败,无可用客服在线。 |
141002 | 系统内部错误,请重试。 |
141003 | 该会话无法转人工。 |
141004 | 请求参数非法,请检查后重试。 |
141011 | 客服不在线,请检查客服是否在线。 |
141012 | 客服达到最大接待人数限制。 |
141013 | 客服小休中,可接待状态后重试。 |
141014 | 联系用户功能关闭。 |
141015 | 用户账号不存在,检查用户账号是否正确。 |
141016 | 用户在人工会话中。 |
141017 | 分配客服失败,检查是否无客服成员在线。 |
141018 | 技能组无该客服号权限,请检查客服号技能组配置。 |
141019 | 技能组不合法,请检查技能组是否正确。 |
接口调试工具