修改隐身状态(等同于仅外呼场景)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
云联络中心实例 ID。 |
szpczf |
| UserId |
string |
否 |
坐席 ID。 |
sam@szpczf |
| Invisible |
boolean |
否 |
是否切换为隐身状态。隐身状态和仅外呼含义一致。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
OK |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Message |
string |
响应信息 |
Internal service issue. Detail:. |
| RequestId |
string |
请求 ID。 |
24BE19E8-BF7D-4992-A35E-15EBA874F2E5 |
| Params |
array |
响应参数。 |
|
|
string |
响应参数。 |
无 |
|
| Data |
object |
数据。 |
|
| Extension |
string |
座席分机号。 |
8001**** |
| WorkMode |
string |
工作模式。 |
ON_SITE |
| DeviceId |
string |
设备 ID,浏览器 WebRTC 软电话或实体话机设备的标识 ID,同一时间只允许一种设备注册。 |
Yealink SIP-T23G 44.84.203.6 |
| JobId |
string |
通话 ID,如果该字段有值,说明坐席当前处于通话过程中。 |
job-330557290544431104 |
| UserId |
string |
座席 ID。 |
sam@szpczf |
| BreakCode |
string |
小休代码。 |
会议 |
| InstanceId |
string |
实例 ID。 |
szpczf |
| OutboundScenario |
boolean |
坐席是否为仅外呼状态。 |
False |
| UserState |
string |
用户状态。 |
Ready |
| SignedSkillGroupIdList |
array |
技能组 ID。 |
|
|
string |
技能组 ID。 |
skillgroup@ccc-test |
示例
正常返回示例
JSON格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "Internal service issue. Detail:.",
"RequestId": "24BE19E8-BF7D-4992-A35E-15EBA874F2E5",
"Params": [
"无"
],
"Data": {
"Extension": "8001****",
"WorkMode": "ON_SITE",
"DeviceId": "Yealink SIP-T23G 44.84.203.6",
"JobId": "job-330557290544431104",
"UserId": "sam@szpczf",
"BreakCode": "会议",
"InstanceId": "szpczf",
"OutboundScenario": true,
"UserState": "Ready",
"SignedSkillGroupIdList": [
"skillgroup@ccc-test"
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidOperation.ChannelState | The operation is not allowed. Channel stats (%s) does not meet expectations (%s). | |
| 400 | InvalidOperation.UserState | The operation is not allowed. User state (%s) does not meet expectations (%s). | 非法操作,用户状态不符合预期。 |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
| 404 | NotExists.UserId | The user %s does not exist in instance %s. | 云联络中心实例中不存在指定的用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。