文档

StartBack2BackCall - 发起双呼

更新时间:

调用StartBack2BackCall发起双呼。

接口说明

双呼和传统的双方通话不同,主叫并不直接呼叫对方,而是通过一个背靠背代理(Back to Back Agent),背靠背代理首先呼叫主叫方,接通后,再呼叫被叫方,然后把二者拉进一个会场。在这种方式下,由于每个呼叫的所有消息流经背靠背代理,因此服务提供商可以据此提供增值服务,比如计时、录音、隐藏真实号码等等。

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
Callerstring

主叫号码。

1391814****
Calleestring

被叫号码。

1372168****
TimeoutSecondsinteger

双呼超时时间,呼叫在经过该参数指定的时间仍然未接通的情况下,则主动挂断,非必填,默认30,单位秒。

30
Brokerstring

中间号码,需要是实例下可用的外呼号码,双呼时会使用该号码先后呼叫主叫和被叫。

0102157****
AdditionalBrokerstring

附加中间号码,如果该参数存在,则呼叫主叫时使用中间号码,呼叫被叫时使用该参数指定的号码,非必填, 默认空。

0102156****
Tagsstring

随路数据,不能超过128字节,主要用于扩展需求,普通客户无需关心。

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

26A34338-5CD9-4C95-A7A6-5BDCE76C6B94
Paramsarray

响应参数列表。

string

响应参数。

Dataobject

数据。

CallContextobject

话务上下文环境。

CallTypestring

通话类型。

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

实例ID。

ccc-test
JobIdstring

通话ID。

job-1034159089076****
ChannelContextsobject []

话务通道列表。

ReleaseInitiatorstring

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

ChannelStatestring

话务通道的状态。

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

话务通道的被叫方。

1372168****
UserIdstring

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

ChannelFlagsstring

话务通道标志。

枚举值:
  • COACHINGCOACHING
  • MONITORINGMONITORING
  • MONITOREDMONITORED
  • COACHEDCOACHED
  • HOLDHOLD
  • MUTEDMUTED
MONITORING
Timestamplong

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

1618217874062
ReleaseReasonstring

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

CallTypestring

话务通道的通话类型。

枚举值:
  • INBOUNDINBOUND
  • BARGEBARGE
  • CONSULTANTCONSULTANT
  • CONFERENCECONFERENCE
  • MONITORMONITOR
  • INTERNALINTERNAL
  • OUTBOUNDOUTBOUND
  • INTERCEPTINTERCEPT
  • BACK2BACKBACK2BACK
  • PREDICTIVEPREDICTIVE
  • COACHCOACH
BACK2BACK
JobIdstring

通话ID。

job-1034159089076****
ChannelIdstring

话务通道ID。

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

话务通道的主叫方

0102157****
UserExtensionstring

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

8001****
UserContextobject

坐席上下文环境。

Extensionstring

坐席分机号。

8020****
Heartbeatlong

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

1618217872911
WorkModestring

工作模式。

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

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

ACC-YUNBS-1.0.10-****
UserIdstring

坐席ID。

agent@ccc-test
Reservedlong

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

1618217794599
BreakCodestring

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

Warm-up
InstanceIdstring

实例ID。

ccc-test
OutboundScenarioboolean

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

false
DeviceStatestring

设备状态。

枚举值:
  • UNREGISTERED未注册
  • ONLINE在线
  • OFFLINE离线
Mobilestring

坐席的个人电话号码。

1324730****
JobIdstring

通话ID。

job-1034159089076****
UserStatestring

座席状态。

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

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

string

技能组ID。

skillgroup1@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
  "Params": [
    "无"
  ],
  "Data": {
    "CallContext": {
      "CallType": "BACK2BACK",
      "InstanceId": "ccc-test",
      "JobId": "job-1034159089076****",
      "ChannelContexts": [
        {
          "ReleaseInitiator": "无",
          "ChannelState": "NONE",
          "Destination": "1372168****",
          "UserId": "无",
          "ChannelFlags": "MONITORING",
          "Timestamp": 1618217874062,
          "ReleaseReason": "无",
          "CallType": "BACK2BACK",
          "JobId": "job-1034159089076****",
          "ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
          "Originator": "0102157****",
          "UserExtension": "8001****"
        }
      ]
    },
    "UserContext": {
      "Extension": "8020****",
      "Heartbeat": 1618217872911,
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "Reserved": 1618217794599,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "DeviceState": "无",
      "Mobile": "1324730****",
      "JobId": "job-1034159089076****",
      "UserState": "OFFLINE",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.NumberThe specified number %s does not exist in instance %s.呼叫中心实例中不存在指定的号码。
500InternalService.CTIAn internal CTI service error occurred. %s内部CTI服务错误。

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

  • 本页导读 (0)
文档反馈