ResetAgentState - 重置坐席状态

调用ResetAgentState重置指定实例下指定坐席的坐席状态。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

ccc-test
UserIdstring

坐席 ID,非必填,不填默认使用当前 RAM 账户映射的坐席。

agent@ccc-test
DeviceIdstring

设备 ID,可以随便填写,无特殊作用,无特殊要求。

device

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Paramsarray
Paramstring

参数信息。

Dataobject

坐席状态数据。

Extensionstring

坐席分机号。

8001****
WorkModestring

工作模式。

枚举值:
  • ON_SITE场内模式
  • OFF_SITE场外模式
  • OFFICE_PHONE办公电话模式
ON_SITE
DeviceIdstring

设备 ID,浏览器 WebRTC 软电话或实体话机设备的标识 ID,同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
JobIdstring

通话 ID,如果该字段有值,说明坐席当前处于通话过程中。

UserIdstring

坐席 ID。

agent@ccc-test
BreakCodestring

小休状态码,分为系统定义的和客户定义的两种,系统定义的小休码包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。

Warm-up
InstanceIdstring

实例 ID。

ccc-test
OutboundScenarioboolean

坐席是否开启了仅外呼模式。

false
UserStatestring

坐席状态。

枚举值:
  • READY空闲
  • WORKING话后处理中
  • DIALING拨号中
  • BREAK小休
  • OFFLINE离线
  • TALKING通话中
  • RINGING振铃中
OFFLINE
SignedSkillGroupIdListarray

坐席签入的技能组 ID 列表。

SkillGroupIdstring

技能组 ID。

skillgroup@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ],
  "Data": {
    "Extension": "8001****",
    "WorkMode": "ON_SITE",
    "DeviceId": "ACC-YUNBS-1.0.10-****",
    "JobId": "无",
    "UserId": "agent@ccc-test",
    "BreakCode": "Warm-up",
    "InstanceId": "ccc-test",
    "OutboundScenario": false,
    "UserState": "OFFLINE",
    "SignedSkillGroupIdList": [
      "skillgroup@ccc-test"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.UserIdThe user %s does not exist in instance %s.呼叫中心实例中不存在指定的用户。

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

变更历史

变更时间变更内容概要操作
2023-10-26OpenAPI 错误码发生变更查看变更详情