接口调用说明
通过该接口拉取客服号列表
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/get_im_agent_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/get_im_agent_list | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json 。 |
请求包示例
{}
说明:
请求包体填空的 JSON 结构即可。
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Data": [{"IMAgentUserId": "@customer_service_account","IMAgentNick": "衣服官方旗舰店","IMAgentAvatarUrl": "avatar URL 1","WelcomeMessage": "欢迎咨询衣服官方旗舰店,很高兴为您服务!","ChatbotDisabled": 0,"AgentGroupId": 1234,"TransferToHumanTip": "正在为您转接,请稍候","TransferToHumanSuccessTip": "转接人工成功,客服${StaffNickName}为您服务","TransferToHumanFailTip": "抱歉,当前无客服在线,请稍后再试","QueueingTip": "您的问题我们已经收到。当前咨询人数较多,您目前排在第${QueuePosition}位,前面还有${WaitNo}人,感谢您的耐心等待","UserTimeout": 600,"EndTip": "本次服务已结束,感谢您的支持","TimeoutEndTip": "由于您长时间未回复,本次服务已自动结束,感谢您的支持","WorkTimeConfig": {"Type": 0},"NotWorkTimeTip": "当前无客服在线,请您于工作时间咨询","IsDefault": 1},{"IMAgentUserId": "iamTu5QojCp7TtUAMoLx7Cdt0ucDtHL1","IMAgentNick": "皮鞋官方旗舰店","IMAgentAvatarUrl": "avatar URL 2","WelcomeMessage": "欢迎咨询皮鞋官方旗舰店,很高兴为您服务!","ChatbotDisabled": 1,"AgentGroupId": 4321,"TransferToHumanTip": "正在为您转接,请稍候","TransferToHumanSuccessTip": "转接人工成功,客服${StaffNickName}为您服务","TransferToHumanFailTip": "抱歉,当前无客服在线,请稍后再试","QueueingTip": "您的问题我们已经收到。当前咨询人数较多,您目前排在第${QueuePosition}位,前面还有${WaitNo}人,感谢您的耐心等待","UserTimeout": 300,"EndTip": "本次服务已结束,感谢您的支持","TimeoutEndTip": "由于您长时间未回复,本次服务已自动结束,感谢您的支持","WorkTimeConfig": {"Type": 1,"Periods": [{"Day": "Monday","PeriodsWithinOneDay": [{"Start": "09:00","End": "11:30"},{"Start": "14:00","End": "18:00"}]},{"Day": "Saturday","PeriodsWithinOneDay": [{"Start": "09:00","End": "12:30"},{"Start": "13:00","End": "17:00"}]}]},"NotWorkTimeTip": "当前无客服在线,请您于工作时间咨询","IsDefault": 0}]}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
ActionStatus | String | 请求处理的结果。 |
IMAgentUserID | String | 客服号的 UserID |
IMAgentNick | String | 客服号的昵称 |
IMAgentAvatarUrl | String | 客服号的头像 URL |
WelcomeMessage | String | 欢迎语 |
ChatbotDisabled | Integer | 该客服号是否停用机器人,0为启用机器人,1为停用机器人 |
AgentGroupId | Integer | |
TransferToHumanPrompt | String | 转人工中提示语 |
TransferToHumanSuccessPrompt | String | 转人工成功提示语。可使用参数${StaffNickName},表示当前接待的客服昵称 |
TransferToHumanFailPrompt | String | 转人工失败提示语 |
QueueingPrompt | String | 排队提示语。可使用参数:${QueuePosition}表示当前排队位置,从 1 开始计算;${WaitNo}表示前方排队人数,从 0 开始计算 |
UserTimeout | Integer | 转人工后,用户应答超时的会话自动结束时间,单位为秒 |
EndPrompt | String | 用户或客服主动结束会话,系统自动发送的提示语 |
TimeoutEndPrompt | String | 用户超时未回复,会话自动结束后系统发送的提示语 |
WorkTimeConfig | Object | 人工客服工作时间设置 |
Type | Integer | 人工客服工作时间的类型,0为不打开工作时间设置,1为打开 |
Periods | Array | 人工客服工作时间的具体设置 |
Day | String | 可选值为Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday |
PeriodsWithinOneDay | Array | 每一天的具体工作时间 |
Start | String | 工作时间的开始时间点 |
End | String | 工作时间的结束时间点 |
NotWorkTimePrompt | String | 非人工客服工作时间的自动回复 |
IsDefault | Integer | 是否在创建智能客服应用时默认创建的客服号,0为不是,1为是 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 描述 |
141000 | 该应用非智能客服应用。 |
141002 | 内部错误,请重试。 |
141004 | 参数非法。 |
141007 | 客服号数量超过最大限制。 |
141008 | 账号数量超过最大限制。 |