一、接口调用说明
通过该接口设置客服成员的工作台状态。
二、请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介。
| 参数 | 说明 |
| v4/desk_http_svc/force_member_offline | 请求接口。 |
| sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
| identifier | 必须为 App 管理员账号,更多详情请参见 App 管理员。 |
| usersig | App 管理员账号生成的签名,具体操作请参见 生成 UserSig。 |
| random | 请输入随机的32位无符号整数,取值范围0 – 4294967295。 |
| contenttype | 请求格式固定值为 json。 |
三、请求包示例
{ "MemberMail": "kefu1@tencent.com", "Status": "STATUS_REST", "RestReason": "午休"}
四、请求包字段说明
| 字段 | 类型 | 属性 | 说明 |
| MemberMail | String | 必填 | 待设置状态的客服成员账号。 |
| Status | String | 必填 | 客服工作状态:STATUS_FREE:示闲。STATUS_NOT_READY:示忙。STATUS_REST:小休。 |
| RestReason | String | 选填 | 该字段为小休原因:仅当 status 为 STATUS_REST 生效。如果 RestReason 为空,那么会切换到上次小休原因。如果 RestReason 不为空,但又不在小休原因列表中,则会报错。 |
五、应答包体示例
{ "ActionStatus": "OK", "ErrorCode": 0, "ErrorInfo": ""}
六、应答包字段说明
| 字段 | 类型 | 说明 |
| ErrorCode | Integer | 请求错误码:0表示成功。非0表示失败。 |
| ErrorInfo | String | 错误信息。 |
| ActionStatus | String | 请求处理的结果。 |
七、错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
| 错误码 | 描述 |
| 141000 | 该应用非智能客服应用。 |
| 141002 | 内部错误,请重试。 |
| 141004 | 参数非法。 |
| 141009 | 接口限频。 |
| 141010 | 客服账号不存在。 |
八、接口调试工具
通过 REST API 在线调试工具 调试本接口。
九、联系我们
如果你在接入过程中有任何疑问,请用微信或企业微信扫码加入智能客服交流群进行咨询。