修改在线客服状态

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ChangeChatAgentStatus

系统规定参数。取值:ChangeChatAgentStatus

ClientToken String 46c1341e-2648-447a-9b11-70b6a298d94d

客户请求唯一id,用于幂等校验,可以用uuid生成

InstanceId String ccc_xp_pre-cn-***

实例id

AccountName String 123@123.com

坐席账号名称,实例内唯一(登录名)

Method String requestLogout

修改到的状态类型

  • requestRest (申请小休)
  • requestLogout (申请离线)
  • restToWork (小休转上班)

返回数据

名称 类型 示例值 描述
Message String xxx

错误描述

RequestId String EE338D98-9BD3-4413-B165

请求ID,用于跟踪错误原因

HttpStatusCode Integer 200

http状态码

Data String 0

data

Code String Agent.NotFound

错误编码

Success Boolean true

接口调用是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=ChangeChatAgentStatus
&ClientToken=46c1341e-2648-447a-9b11-70b6a298d94d
&InstanceId=ccc_xp_pre-cn-***
&AccountName=123@123.com
&Method=requestLogout
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ChangeChatAgentStatusResponse>
    <Message>xxx</Message>
    <RequestId>EE338D98-9BD3-4413-B165</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>0</Data>
    <Code>Agent.NotFound</Code>
    <Success>true</Success>
</ChangeChatAgentStatusResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "xxx",
  "RequestId" : "EE338D98-9BD3-4413-B165",
  "HttpStatusCode" : 200,
  "Data" : "0",
  "Code" : "Agent.NotFound",
  "Success" : true
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。