首页 云呼叫中心 API参考 API目录 话务 BargeInCall - 强插通话

BargeInCall - 强插通话

调用BargeInCall强行插入指定实例下指定通话ID对应的正在通话中的通话,强插成功后,通话将由原来的双方通话变成三人会议。

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
UserIdstring

发起强插的坐席ID。

agent@ccc-test
DeviceIdstring

设备ID,无意义,可以随便填写。

device
JobIdstring

通话ID。

job-6538214103685****
BargedUserIdstring

被强插的座席ID。

agent2@ccc-test
TimeoutSecondsinteger

强插超时时间,经过指定的时间强插仍未成功,则取消强插,正常情况下,强插操作会马上成功,设置超时时间是为了防止异常发生,此字段选填,默认30,单位秒。

60

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

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

响应参数列表。

string

响应参数。

Dataobject

数据。

CallContextobject

话务上下文环境。

CallTypestring

通话类型。

BARGE
枚举值:
- INBOUND: 呼入
- BARGE: 强插
- CONSULTANT: 咨询
- CONFERENCE: 会议
- MONITOR: 监听
- INTERNAL: 内部通话
- OUTBOUND: 呼出
- INTERCEPT: 强拆
- BACK2BACK: 双呼
- PREDICTIVE: 预测式外呼
- COACH: 辅导
InstanceIdstring

实例ID。

ccc-test
JobIdstring

通话ID。

job-6538214103685****
ChannelContextsarray

话务通道列表。

object

话务通道。

Indexinteger

系统自增ID,客户无需关心。

10
ReleaseInitiatorstring

话务通道的挂断方,表示该话务通道是谁首先发起的挂断。

1390501****
ChannelStatestring

话务通道的状态。

ANSWERED
枚举值:
- CREATED: 已创建
- ANSWERED: 已接通
- RELEASED: 已挂断
- RETIRED: 已失效
- EARLY_MEDIA: 早媒体阶段
- NONE: 初始状态
- RINGING: 振铃中
Destinationstring

话务通道的被叫方。

1390501****
UserIdstring

话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。

agent@ccc-test
ChannelFlagsstring

话务通道标志。

MONITORING
枚举值:
- COACHING: 辅导中
- MONITORING: 监听中
- MONITORED: 被监听
- COACHED: 被辅导
- HOLD: 保持
- MUTED: 静音
SkillGroupIdstring

话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。

skillgroup@ccc-test
TimestampLong

话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。

1609138903315
ReleaseReasonstring

话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。

404 - No destination
CallTypestring

话务通道的通话类型。

BARGE
枚举值:
- INBOUND: 呼入
- BARGE: 强插
- CONSULTANT: 咨询
- CONFERENCE: 会议
- MONITOR: 监听
- INTERNAL: 内部通话
- OUTBOUND: 呼出
- INTERCEPT: 强拆
- BACK2BACK: 双呼
- PREDICTIVE: 预测式外呼
- COACH: 辅导
JobIdstring

通话ID。

job-6538214103685****
ChannelIdstring

话务通道ID。

ch:user:1390501****->8032****:1609138902226:job-653821410368****
UserExtensionstring

话务通道关联的坐席的分机号。

8032****
Originatorstring

话务通道的主叫方。

0830019****
UserContextobject

坐席上下文环境。

Extensionstring

坐席分机号。

8032****
HeartbeatLong

上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。

1609136956378
WorkModestring

工作模式。

ON_SITE
枚举值:
- ON_SITE: 场内模式
- OFF_SITE: 场外模式
- OFFICE_PHONE: 办公电话模式
DeviceIdstring

设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
UserIdstring

坐席ID。

agent@ccc-test
ReservedLong

坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。

1609136956378
BreakCodestring

小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。

Warm-up
枚举值:
- RingingTimeout: 坐席振铃超时导致的小休
- RejectCall: 坐席拒接导致的小休
- Warm-up: 坐席上线后置闲前的临时小休状态
InstanceIdstring

实例ID。

ccc-test
OutboundScenarioboolean

坐席是否处于仅外呼模式。

false
Mobilestring

坐席的个人电话号码。

1324730****
JobIdstring

通话ID。

job-6538214103685****
UserStatestring

座席状态。

TALKING
枚举值:
- READY: 空闲
- WORKING: 话后处理中
- DIALING: 拨号中
- BREAK: 小休
- OFFLINE: 离线
- TALKING: 通话中
- RINGING: 振铃中
SignedSkillGroupIdListarray

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

string

技能组ID。

skillgroup1@ccc-test

示例

正常返回示例

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": true,
      "Mobile": "1324730****",
      "JobId": "job-6538214103685****",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

Http code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
400InvalidOperation.DeviceStateThe operation is not allowed. Device state (%s) does not meet expectations (%s).非法操作。 设备状态不符合预期。
400InvalidOperation.UserStateThe operation is not allowed. User state (%s) does not meet expectations (%s).非法操作,用户状态不符合预期。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.JobIdThe call %s does not exist.指定的通话信息不存在。
404NotExists.UserIdThe user %s does not exist in instance %s.呼叫中心实例中不存在指定的用户。

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

阿里云首页 云呼叫中心 相关技术圈