TakeBreak - 小休

调用TakeBreak将指定实例下的指定坐席设置为小休状态。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
UserIdstring

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

agent@ccc-test
DeviceIdstring

设备 ID,无意义,可以随便填写。

device
Codestring

小休状态码,客户可以自定义任何小休状态。

lunchtime

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

B59382D2-5755-4C6D-861F-FA2AAD8F89F7
Paramsarray

响应参数列表。

Paramstring

响应参数。

Dataobject

数据。

Extensionstring

坐席分机号。

8001****
Heartbeatlong

上次收到坐席心跳的时间,格式为 Unix 时间戳,单位毫秒。

1609249563836
WorkModestring

工作模式。

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

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

ACC-YUNBS-1.0.10-****
UserIdstring

坐席 ID。

agent@ccc-test
Reservedlong

坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为 Unix 时间戳,单位毫秒。

1609234221864
BreakCodestring

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

lunchtime
InstanceIdstring

实例 ID。

ccc-test
OutboundScenarioboolean

坐席是否处于仅外呼模式。

false
Mobilestring

坐席的个人电话号码。

1390000****
JobIdstring

通话 ID。

UserStatestring

座席状态。

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

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

SkillGroupIdstring

技能组 ID。

skillgroup1@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "B59382D2-5755-4C6D-861F-FA2AAD8F89F7",
  "Params": [
    "无"
  ],
  "Data": {
    "Extension": "8001****",
    "Heartbeat": 1609249563836,
    "WorkMode": "ON_SITE",
    "DeviceId": "ACC-YUNBS-1.0.10-****",
    "UserId": "agent@ccc-test",
    "Reserved": 1609234221864,
    "BreakCode": "lunchtime",
    "InstanceId": "ccc-test",
    "OutboundScenario": false,
    "Mobile": "1390000****",
    "JobId": "无",
    "UserState": "BREAK",
    "SignedSkillGroupIdList": [
      "skillgroup1@ccc-test"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
400InvalidOperation.UserStateThe operation is not allowed. User state (%s) does not meet expectations (%s).非法操作,用户状态不符合预期。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.UserIdThe user %s does not exist in instance %s.呼叫中心实例中不存在指定的用户。

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

变更历史

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