即时通信 IM 更新客服号-智能客服-文档中心-腾讯云

接口调用说明
通过该接口更新客服号，可以更新客服号的欢迎语、关联的客服分组、客服工作时间等。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/update_im_agent?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
v4/desk_http_svc/update_im_agent
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为json。
请求包示例
1. 仅更新客服号的欢迎语和关联的客服分组 ID
{
    "IMAgentUserID": "iamTu5QojCp7TtUAMoLx7Cdt0ucDtHL1",
    "WelcomeMessage": "欢迎咨询衣服官方旗舰店，很高兴为您服务！",
    "AgentGroupId": 1234
}
2. 仅更新人工客服的工作时间判断，并指定周一、周二上午09:00 - 11:30，下午的14:00 - 18:00，周五的上午09:00 - 12:00为人工客服的工作时间
{
    "IMAgentUserID": "iamTu5QojCp7TtUAMoLx7Cdt0ucDtHL1",
    "WorkTimeConfig": {
      "Type":1,
      "Periods": [
        {
          "Day": "Monday",
          "PeriodsWithinOneDay": [
              {
                "Start": "09:00",
                "End": "11:30"
              },
              {
                "Start": "14:00",
                "End": "18:00"
              }
          ]
        },
        {
          "Day": "Tuesday",
          "PeriodsWithinOneDay": [
              {
                "Start": "09:00",
                "End": "11:30"
              },
              {
                "Start": "14:00",
                "End": "18:00"
              }
          ]
        },
        {
          "Day": "Friday",
          "PeriodsWithinOneDay": [
              {
                "Start": "09:00",
                "End": "12:00"
              }
          ]
        }
      ]
    }
}
请求包字段说明
字段
类型
属性
说明
IMAgentUserID
String
必填
客服号的 UserID
IMAgentNick
String
选填
客服号的昵称
IMAgentAvatarUrl
String
选填
客服号的头像 URL
WelcomeMessage
String
选填
欢迎语
ChatbotDisabled
Integer
选填
该客服号是否停用机器人，0为启用机器人，1为停用机器人
AgentGroupId
Integer
选填
关联的客服分组 ID
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
选填
非人工客服工作时间的自动回复
应答包体示例
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "IMAgentUserID": "iamTu5QojCp7TtUAMoLx7Cdt0ucHtDL1"
}
应答包字段说明
字段
类型
说明
ErrorCode
Integer
错误码：
0表示成功。
非0表示失败。
ErrorInfo
String
错误信息。
ActionStatus
String
请求处理的结果。
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
141000
该应用非智能客服应用。
141002
内部错误，请重试。
141004
参数非法。
141007
客服号数量超过最大限制。
141008
账号数量超过最大限制。
接口调试工具
通过 REST API 在线调试工具 调试本接口。
参考
查询单聊消息（v4/openim/admin_getroammsg）

参数	说明
v4/desk_http_svc/update_im_agent	请求接口。
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig	App 管理员账号生成的签名，具体操作请参见生成 UserSig。
random	请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype	请求格式固定值为`json`。

字段	类型	属性	说明
IMAgentUserID	String	必填	客服号的 UserID
IMAgentNick	String	选填	客服号的昵称
IMAgentAvatarUrl	String	选填	客服号的头像 URL
WelcomeMessage	String	选填	欢迎语
ChatbotDisabled	Integer	选填	该客服号是否停用机器人，0为启用机器人，1为停用机器人
AgentGroupId	Integer	选填	关联的客服分组 ID
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	选填	非人工客服工作时间的自动回复

错误码	描述
141000	该应用非智能客服应用。
141002	内部错误，请重试。
141004	参数非法。
141007	客服号数量超过最大限制。
141008	账号数量超过最大限制。

更新客服号

本页目录：

接口调用说明

请求 URL 示例

请求参数说明

请求包示例

1. 仅更新客服号的欢迎语和关联的客服分组 ID

2. 仅更新人工客服的工作时间判断，并指定周一、周二上午09:00 - 11:30，下午的14:00 - 18:00，周五的上午09:00 - 12:00为人工客服的工作时间

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考