调用BargeInCall强行插入指定实例下指定通话ID对应的正在通话中的通话,强插成功后,通话将由原来的双方通话变成三人会议。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | ccc-test |
UserId | string | 是 | 发起强插的坐席 ID。 | agent@ccc-test |
DeviceId | string | 是 | 设备 ID,无意义,可以随便填写。 | device |
JobId | string | 是 | 通话 ID。 | job-6538214103685**** |
BargedUserId | string | 是 | 被强插的座席 ID。 | agent2@ccc-test |
TimeoutSeconds | integer | 否 | 强插超时时间,经过指定的时间强插仍未成功,则取消强插,正常情况下,强插操作会马上成功,设置超时时间是为了防止异常发生,此字段选填,默认 30,单位秒。 | 60 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
"Params": [
"无"
],
"Data": {
"CallContext": {
"CallType": "BARGE",
"InstanceId": "ccc-test",
"JobId": "job-6538214103685****",
"ChannelContexts": [
{
"Index": 10,
"ReleaseInitiator": "1390501****",
"ChannelState": "ANSWERED",
"Destination": "1390501****",
"UserId": "agent@ccc-test",
"ChannelFlags": "MONITORING",
"SkillGroupId": "skillgroup@ccc-test",
"Timestamp": 1609138903315,
"ReleaseReason": "404 - No destination",
"CallType": "BARGE",
"JobId": "job-6538214103685****",
"ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
"UserExtension": "8032****",
"Originator": "0830019****"
}
]
},
"UserContext": {
"Extension": "8032****",
"Heartbeat": 1609136956378,
"WorkMode": "ON_SITE",
"DeviceId": "ACC-YUNBS-1.0.10-****",
"UserId": "agent@ccc-test",
"Reserved": 1609136956378,
"BreakCode": "Warm-up",
"InstanceId": "ccc-test",
"OutboundScenario": false,
"Mobile": "1324730****",
"JobId": "job-6538214103685****",
"UserState": "TALKING",
"SignedSkillGroupIdList": [
"skillgroup1@ccc-test"
]
}
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Parameter.Blank | The parameter %s may not be null or blank. | 该参数不能为null或含有空白符的字符串。 |
400 | InvalidOperation.DeviceState | The operation is not allowed. Device state (%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.JobId | The call %s does not exist. | 指定的通话信息不存在。 |
404 | NotExists.UserId | The user %s does not exist in instance %s. | 呼叫中心实例中不存在指定的用户。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-26 | OpenAPI 错误码发生变更 | 查看变更详情 |