调用EndConference使指定坐席退出指定实例下指定通话ID对应的通话，该通话必须处于会议状态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
9cfad875-6260-4a53-ab6e-b13e3fb31f7d |
| UserId |
string |
否 |
需要退出会议的坐席 ID，选填，不填默认为当前 RAM 账户映射的坐席。 |
agent@ccc-test |
| JobId |
string |
是 |
通话 ID。 |
job-6538214103685**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
OK |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Message |
string |
响应信息。 |
无 |
| RequestId |
string |
请求 ID。 |
0630E5DF-CEB0-445B-8626-D5C7481181C3 |
| Params |
array |
响应参数列表。 |
|
|
string |
响应参数。 |
无 |
|
| Data |
object |
数据。 |
|
| CallContext |
object |
话务上下文环境。 |
|
| JobId |
string |
通话 ID。 |
job-6538214103685**** |
| InstanceId |
string |
实例 ID。 |
ccc-test |
| ChannelContexts |
array<object> |
话务通道列表。 |
|
|
object |
话务通道。 |
||
| ReleaseInitiator |
string |
话务通道的挂断方，表示该话务通道是谁首先发起的挂断。 |
1390501**** |
| ChannelState |
string |
话务通道的状态。 枚举值：
|
CREATED |
| Destination |
string |
话务通道的被叫方。 |
8001**** |
| UserId |
string |
话务通道关联的坐席 ID，如果是客户的话务通道，该字段为空。 |
agent@ccc-test |
| Timestamp |
integer |
话务通道最近一次状态变化的时间戳，格式是 Unix 时间戳，单位毫秒。 |
1609138903315 |
| ReleaseReason |
string |
话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自 SIP 协议中定义的响应码，请客户参考 SIP 协议分析挂断原因。 |
404 - No destination |
| CallType |
string |
话务通道的通话类型。 枚举值：
|
OUTBOUND |
| JobId |
string |
通话 ID。 |
job-6538214103685**** |
| ChannelId |
string |
话务通道 ID。 |
ch:user:131888****->8001****:1609225718294:job-65700074013925376 |
| Originator |
string |
话务通道的主叫方。 |
0830019**** |
| UserExtension |
string |
话务通道关联的坐席的分机号。 |
8032**** |
| UserContext |
object |
坐席上下文环境。 |
|
| Extension |
string |
坐席分机号。 |
8032**** |
| DeviceState |
string |
SIP 话机设备的状态，如果未注册 SIP 话机，则状态为 UNREGISTERED（未注册），如过 SIP 话机注册过但是不在线，则状态为 OFFLINE（离线），如果 SIP 话机注册过并且在线则为 ONLINE（在线）。 枚举值：
|
UNREGISTERED |
| WorkMode |
string |
工作模式。 枚举值：
|
ON_SITE |
| DeviceId |
string |
设备 ID，浏览器 WebRTC 软电话或实体话机设备的标识 ID，同一时间只允许一种设备注册。 |
ACC-YUNBS-1.0.10-**** |
| JobId |
string |
通话 ID。 |
job-6538214103685**** |
| UserId |
string |
坐席 ID。 |
agent@ccc-test |
| BreakCode |
string |
小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。 枚举值：
|
Warm-up |
| InstanceId |
string |
实例 ID。 |
ccc-test |
| OutboundScenario |
boolean |
坐席是否处于仅外呼模式。 |
false |
| UserState |
string |
座席状态。 枚举值：
|
TALKING |
| SignedSkillGroupIdList |
array |
坐席签入的技能组 ID 列表。 |
|
|
string |
技能组 ID。 |
skillgroup1@ccc-test |
|
| ContextId |
integer |
系统自增 ID，客户无需关心。 |
103655 |
示例
正常返回示例
JSON格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "0630E5DF-CEB0-445B-8626-D5C7481181C3",
"Params": [
"无"
],
"Data": {
"CallContext": {
"JobId": "job-6538214103685****",
"InstanceId": "ccc-test",
"ChannelContexts": [
{
"ReleaseInitiator": "1390501****",
"ChannelState": "CREATED",
"Destination": "8001****",
"UserId": "agent@ccc-test",
"Timestamp": 1609138903315,
"ReleaseReason": "404 - No destination",
"CallType": "OUTBOUND",
"JobId": "job-6538214103685****",
"ChannelId": "ch:user:131888****->8001****:1609225718294:job-65700074013925376",
"Originator": "0830019****",
"UserExtension": "8032****"
}
]
},
"UserContext": {
"Extension": "8032****",
"DeviceState": "UNREGISTERED",
"WorkMode": "ON_SITE",
"DeviceId": "ACC-YUNBS-1.0.10-****",
"JobId": "job-6538214103685****",
"UserId": "agent@ccc-test",
"BreakCode": "Warm-up",
"InstanceId": "ccc-test",
"OutboundScenario": false,
"UserState": "TALKING",
"SignedSkillGroupIdList": [
"skillgroup1@ccc-test"
]
},
"ContextId": 103655
}
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。