调用StartBack2BackCall发起双呼。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String StartBack2BackCall

系统规定参数。取值:StartBack2BackCall。

Broker String 010xxxx2157

背靠背代理所用的中间号码。需要是呼叫中心的可外呼号码。

Callee String 137xxxx2168

被叫号码。

Caller String 139xxxx1814

主叫号码。

InstanceId String ccc-test

呼叫中心实例ID。

TimeoutSeconds Integer 20

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

AdditionalBroker String 010xxxx2156

附加的中间号码,如果该参数存在,则呼叫callee时使用该参数指定的号码。

Tags String

随路数据,不能超过128字节。

返回数据

名称 类型 示例值 描述
Code String OK

响应码。

Data Struct

数据。

CallContext Struct

话务上下文环境。

CallType String BACK2BACK

呼叫类型, 最初发起呼叫时的类型。

ChannelContexts Array of ChannelContext

通话上下文。

AssociatedData Map

随路数据。

CallType String BACK2BACK

呼叫类型, 最初发起呼叫时的类型。

ChannelFlags String []

通道标志,比如监听,辅助,静音等。

ChannelId String ch:user:1318888888->80011474:1609225718294:job-65700074013925376

通道ID。

ChannelState String NONE

状态。

Destination String 1014

接收方。

JobId String job-103415908907622400

通话ID。

Originator String 010xxxx2157

发起方。

ReleaseInitiator String

挂断方。

ReleaseReason String

挂断原因。

Timestamp Long 1618217874062

状态数据上次变更时间戳。

UserExtension String 80011474

座席是否发起方。

UserId String

该Channel的用户ID,如果是客户通道,则userId为空。

InstanceId String ccc-test

呼叫中心实例ID。

JobId String job-103415908907622400

话务ID。

UserContext Struct

用户上下文环境。

BreakCode String Warm-up

小休状态码。

DeviceId String ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c

设备标示。

DeviceState String

设备状态。

Extension String 80202301

座席分机号,一共8位 如果一个用户账号有多种设备,则多个设备用一个分机号,且同一时间只有一个设备可用。

Heartbeat Long 1618217872911

上次操作时间。

InstanceId String ccc-test

呼叫中心实例ID。

JobId String job-103415908907622400

在呼叫状态时的通话ID。

Mobile String 86-132xxxx4730

座席手机号码,场外座席情况下通过此号码联系座席。

OutboundScenario Boolean false

仅外呼。

Reserved Long 1618217794599

座席处于预定状态,说明马上有电话给TA. 该参数记录收到预定请求的时间。

SignedSkillGroupIdList List ["skg-default@ccc-test"]

签入的技能组ID列表。

Uri String

废弃。

UserId String user-test@ccc-test

用户ID,格式为username@domain。

UserState String OFFLINE

座席状态码。

WorkMode String ON_SITE

工作模式。

HttpStatusCode Integer 200

HTTP状态码。

Message String

响应信息。

Params List

返回参数。

RequestId String 26A34338-5CD9-4C95-A7A6-5BDCE76C6B94

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=StartBack2BackCall
&Broker=010xxxx2157
&Callee=137xxxx2168
&Caller=139xxxx1814
&InstanceId=ccc-test
&<公共请求参数>

正常返回示例

XML格式

<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>
<Message>无</Message>
<HttpStatusCode>200</HttpStatusCode>
<Params>无</Params>
<Data>
    <CallContext>
        <InstanceId>ccc-test</InstanceId>
        <CallType>BACK2BACK</CallType>
        <JobId>job-103415908907622400</JobId>
        <ChannelContexts>
            <Destination>1014</Destination>
            <ChannelState>NONE</ChannelState>
            <ReleaseReason>无</ReleaseReason>
            <ReleaseInitiator>无</ReleaseInitiator>
            <Originator>010xxxx2157</Originator>
            <ChannelFlags>[]</ChannelFlags>
            <UserId>无</UserId>
            <UserExtension>80011474</UserExtension>
            <CallType>BACK2BACK</CallType>
            <AssociatedData>无</AssociatedData>
            <ChannelId>ch:user:1318888888-&gt;80011474:1609225718294:job-65700074013925376</ChannelId>
            <Timestamp>1618217874062</Timestamp>
            <JobId>job-103415908907622400</JobId>
        </ChannelContexts>
    </CallContext>
    <UserContext>
        <UserState>OFFLINE</UserState>
        <InstanceId>ccc-test</InstanceId>
        <DeviceId>ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c</DeviceId>
        <BreakCode>Warm-up</BreakCode>
        <OutboundScenario>false</OutboundScenario>
        <Uri>无</Uri>
        <Mobile>86-132xxxx4730</Mobile>
        <Extension>80202301</Extension>
        <DeviceState>无</DeviceState>
        <UserId>user-test@ccc-test</UserId>
        <Heartbeat>1618217872911</Heartbeat>
        <WorkMode>ON_SITE</WorkMode>
        <JobId>job-103415908907622400</JobId>
        <Reserved>1618217794599</Reserved>
        <SignedSkillGroupIdList>["skg-default@ccc-test"]</SignedSkillGroupIdList>
    </UserContext>
</Data>
<Code>OK</Code>

JSON格式

{
	"RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
	"Message": "无",
	"HttpStatusCode": "200",
	"Params": "无",
	"Data": {
		"CallContext": {
			"InstanceId": "ccc-test",
			"CallType": "BACK2BACK",
			"JobId": "job-103415908907622400",
			"ChannelContexts": [{
				"Destination": "1014",
				"ChannelState": "NONE",
				"ReleaseReason": "无",
				"ReleaseInitiator": "无",
				"Originator": "010xxxx2157",
				"ChannelFlags": "[]",
				"UserId": "无",
				"UserExtension": "80011474",
				"CallType": "BACK2BACK",
				"AssociatedData": "无",
				"ChannelId": "ch:user:1318888888->80011474:1609225718294:job-65700074013925376",
				"Timestamp": "1618217874062",
				"JobId": "job-103415908907622400"
			}]
		},
		"UserContext": {
			"UserState": "OFFLINE",
			"InstanceId": "ccc-test",
			"DeviceId": "ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c",
			"BreakCode": "Warm-up",
			"OutboundScenario": "false",
			"Uri": "无",
			"Mobile": "86-132xxxx4730",
			"Extension": "80202301",
			"DeviceState": "无",
			"UserId": "user-test@ccc-test",
			"Heartbeat": "1618217872911",
			"WorkMode": "ON_SITE",
			"JobId": "job-103415908907622400",
			"Reserved": "1618217794599",
			"SignedSkillGroupIdList": "[\"skg-default@ccc-test\"]"
		}
	},
	"Code": "OK"
}

错误码

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

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