文档

SignInGroup - 签入技能组

更新时间:

调用SignInGroup使坐席签入指定实例下的指定技能组,即坐席上线操作。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
UserIdstring

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

agent@ccc-test
DeviceIdstring

语音设备 ID。当有多个语音设备可用时,通过此参数指定其中一个语音设备,比如浏览器 WebRTC 或者 SIP 话机等。

CCC-xx.xx.xx.xx-chrome119-bse1b618bff3xxxxd
SignedSkillGroupIdListstring

想要签入的技能组 ID 列表,格式为 JSON 数组字符串,数组元素是技能组 ID。

["skillgroup1@ccc-test","skillgroup2@ccc-test"]
ChatDeviceIdstring

Chat 设备 ID。

4c51c9116c36537cb850dc1081d745df
Additivityboolean

座席已经签入一些技能组后,如果指定此参数为 True, 则可以签入更多新技能组。

false

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

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

响应参数列表。

string

响应参数。

Dataobject

数据。

Extensionstring

坐席分机号。

8032****
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振铃中
READY
SignedSkillGroupIdListarray

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

string

技能组 ID。

skillgroup1@ccc-test
ChatDeviceIdstring

Chat 设备 ID。

4c51c9116c36537cb850dc1081d745df

示例

正常返回示例

JSON格式

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

错误码

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

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

  • 本页导读 (0)
文档反馈