调用SignInGroup使坐席签入指定实例下的指定技能组,即坐席上线操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
ccc-test |
| UserId |
string |
否 |
坐席 ID,不填默认使用当前 RAM 账号映射的坐席。 |
agent@ccc-test |
| DeviceId |
string |
是 |
语音设备 ID。当有多个语音设备可用时,通过此参数指定其中一个语音设备,比如浏览器 WebRTC 或者 SIP 话机等。 |
CCC-xx.xx.xx.xx-chrome119-bse1b618bff3xxxxd |
| SignedSkillGroupIdList |
string |
是 |
想要签入的技能组 ID 列表,格式为 JSON 数组字符串,数组元素是技能组 ID。 |
["skillgroup1@ccc-test","skillgroup2@ccc-test"] |
| ChatDeviceId |
string |
否 |
Chat 设备 ID。 |
4c51c9116c36537cb850dc1081d745df |
| Additivity |
boolean |
否 |
座席已经签入一些技能组后,如果指定此参数为 True, 则可以签入更多新技能组。 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
OK |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Message |
string |
响应信息。 |
无 |
| RequestId |
string |
请求 ID。 |
EEEE671A-3E24-4A04-81E6-6C4F5B39DF75 |
| Params |
array |
响应参数列表。 |
|
|
string |
响应参数。 |
无 |
|
| Data |
object |
数据。 |
|
| Extension |
string |
坐席分机号。 |
8032**** |
| WorkMode |
string |
工作模式。 枚举值:
|
ON_SITE |
| DeviceId |
string |
设备 ID,浏览器 WebRTC 软电话或实体话机设备的标识 ID,同一时间只允许一种设备注册。 |
ACC-YUNBS-1.0.10-**** |
| JobId |
string |
通话 ID。 |
无 |
| UserId |
string |
坐席 ID。 |
agent@ccc-test |
| BreakCode |
string |
小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。 枚举值:
|
Warm-up |
| InstanceId |
string |
实例 ID。 |
ccc-test |
| OutboundScenario |
boolean |
坐席是否处于仅外呼模式。 |
false |
| UserState |
string |
座席状态。 枚举值:
|
READY |
| SignedSkillGroupIdList |
array |
坐席签入的技能组 ID 列表。 |
|
|
string |
技能组 ID。 |
skillgroup1@ccc-test |
|
| ChatDeviceId |
string |
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
| 404 | NotExists.UserId | The user %s does not exist in instance %s. | 云联络中心实例中不存在指定的用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。