接口调用说明
该接口可以让一个已在群里的客服咨询入口触发转人工。
接口请求限制
调用该接口之前,请确保群组已经创建,且群内包含待转人工的客服咨询入口,参见 创建群组。
调用该接口之前,请确保对应客服咨询入口已经打开了客服群聊模式,参见 更新客服咨询入口。
该接口仅限智能客服试用版、高级版、旗舰版调用。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/transfer_to_human_in_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/transfer_to_human_in_group | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
请求包示例
转人工时按客服咨询入口设置的分组进行分配:
{"GroupId": "MyFirstGroup", // 待转人工的群组 ID(必填)"IMAgentList": [ // 本次需要转人工的客服咨询入口列表(必填)"@customer_service_account"]}
转人工时指定分配参数:
{"GroupId": "MyFirstGroup", // 待转人工的群组 ID(必填)"IMAgentList": [ // 本次需要转人工的客服咨询入口列表(必填)"@customer_service_account"],"TransferToHumanParam": {"@customer_service_account": { // 客服咨询入口 ID"CustomerServiceGroupId": 111, // 指定的分组 ID"CustomerServiceMemberIdList": ["member1@qq.com"], // 指定的客服成员列表,以列表里的顺序来分配;若指定了列表,则分组ID的参数失效。"AllowAssignBusyMember": 1 // 是否允许分配给示忙客服成员,0(默认):不允许,1:允许;}}}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 待转人工的群组 ID,需为已创建且包含客服咨询入口的群组。 |
IMAgentList | Array | 必填 | 本次需要触发转人工的客服咨询入口 ID 列表,列表中的每个客服咨询入口都必须是群内成员。 |
TransferToHumanParam | Object | 选填 | 转人工分配参数,以客服咨询入口 ID 为键,对应各自的分配策略。不填时按客服咨询入口关联的默认分组进行分配。 |
CustomerServiceGroupId | Integer | 选填 | 转人工时指定的分组 ID 。 |
CustomerServiceMemberIdList | Array | 选填 | 转人工时指定的客服成员列表,以列表里的顺序来分配。若指定了成员列表,则 CustomerServiceGroupId 参数失效。 |
AllowAssignBusyMember | Integer | 选填 | 是否允许分配给示忙客服成员: 0:不允许(默认值)。 1:允许。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"AgentIDList": {"@customer_service_account": "member1@qq.com"}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果: OK 表示处理成功。 FAIL 表示失败。 |
ErrorCode | Integer | 错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
AgentIDList | Object | 转人工成功后分配结果,以客服咨询入口 ID 为键,值为分配到的人工客服成员 ID。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 含义说明 |
10002 | 服务器内部错误,请重试。 |
10003 | 请求命令字非法。 |
10004 | 参数非法,请根据错误描述检查请求是否正确。 |
10008 | |
141001 | 分配人工客服失败,无可用客服在线。 |
141002 | 系统内部错误,请重试。 |
141004 | 请求参数非法,请检查后重试。 |