文档中心 > API类目 > 阿里通信API

alibaba.aliqin.axb.vendor.call.control (转呼控制接口)

转呼控制接口,用于查询小号绑定关系,控制呼叫转接目标

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
start_call_request StartCallRequest 可选 转接控制接口request对象
  • └ extension
  • String
  • 可选
  • 123
  • AXN分机号产品中通过IVR放音收取上来的用户输入的分机字符
  • └ secret_no
  • String
  • 必须
  • 17010000000
  • 中间号码
  • └ call_no
  • String
  • 必须
  • 13519000000
  • 主叫号码
  • └ call_time
  • Date
  • 必须
  • 2018-01-01 12:00:00
  • 呼叫开始时间
  • └ call_id
  • String
  • 必须
  • 435cf14f7f077e52
  • 唯一的呼叫ID,最大可支持字符串长度256
  • └ record_type
  • String
  • 必须
  • CALL
  • 行为类型,CALL:呼叫行为,SMS:短信行为
  • └ vendor_key
  • String
  • 必须
  • CMCC
  • 供应商KEY
  • └ call_phase
  • String
  • 可选
  • 0
  • 呼叫能力阶段,默认填0
  • └ b_call_history
  • String
  • 可选
  • 1
  • 如果有原始被叫号码信息填1
  • └ parse_result
  • String
  • 可选
  • 0
  • 当响应指令为“短信解析”时,供应商平台完成短信内容解析,在重新发起查询请求时会携带;短信解析结果,0:成功,1:失败

响应参数

名称 类型 示例值 描述
result Response result 转呼控制接口响应
  • └ message
  • String
  • xxx
  • 转呼控制msg
  • control_resp_dto
  • ControlRespDto
  • module
  • └ control_operate
  • String
  • CONTINUE
  • 接续控制信息:CONTINUE(接续),REJECT(拦截),IVR(收取用户键盘输入内容)
  • └ control_msg
  • String
  • OK
  • controlMsg
  • └ product_type
  • String
  • AXB
  • 对应到小号平台的能力类型:AXB、AXN、AXN_EXTENSION_REUSE(AXN分机复用)
  • └ call_no_play_code
  • String
  • 185
  • 主叫放音编码,多个文件用英文逗号分隔。
  • └ called_no_play_code
  • String
  • 187
  • 被叫放音编码,多个文件用英文逗号分隔。
  • subs
  • Subs
  • Subs
  • 对应到阿里侧的绑定信息
  • └ called_no
  • String
  • 132xxxxxxx
  • 被叫号码
  • sequence_calls
  • SequenceCalls []
  • 顺振参数
  • └ call_no_play_code
  • String
  • 185
  • 主叫放音
  • └ called_no
  • String
  • 15958178699
  • 被叫号码
  • └ called_display_no
  • String
  • 13049840017
  • 被叫号显
  • └ called_no_play_code
  • String
  • 185
  • 被叫放音
  • └ called_no_caller_play_code
  • String
  • 187
  • 摘机后主叫侧的放音编码,多个文件用英文逗号分隔。
  • └ polling_no
  • Number
  • 1
  • 顺振序号,从1开始
  • └ sms_channel
  • String
  • SMS_INTERCEPT
  • 短信通道方式SMS_INTERCEPT(拦截推送阿里),SMS_NORMAL_SEND(正常现网下发),SMS_INTERCEPT_SEND(截取并转发),SMS_DROP(拦截丢弃),
  • └ call_type
  • String
  • MASTER
  • 呼叫类型MASTER(A->X->B), CALLED(B->X->A), SMS_SENDER, SMS_RECEIVER
  • └ rec_type
  • String
  • mp3
  • 录音类型,mp3/wav
  • └ subs_id
  • String
  • 1000113049470172
  • 订购关系ID;目前字符串长度为16位,建议预留32位
  • └ sequence_timeout
  • Number
  • 15
  • 顺振超时时间
  • └ need_record
  • Boolean
  • true
  • 是否需要录音
  • └ called_display_no
  • String
  • 170xxxxxxx
  • 被叫显号
  • └ record_mode
  • String
  • 1
  • 录音模式,1:仅录制通话录音、2:放音录音+通话录音
  • └ fast_record
  • String
  • 0
  • 是否需要优先下载录音,0:否、1:是
  • └ rrds_control
  • Number
  • 0
  • 是否开启铃音检测 0:不开启 1:开启
  • └ ws_addr
  • String
  • ws://127.0.0.1:8001/wsProxy
  • 主叫媒体流推送地址
  • └ ws_addr_called
  • String
  • ws://127.0.0.1:8001/wsProxy
  • 被叫媒体流推送地址
  • └ out_id
  • String
  • 1234abc
  • 外部回传字段
  • └ need_realtime_media
  • Boolean
  • true
  • 是否实时媒体
  • └ rtp_type
  • String
  • 1
  • 实时媒体类型1 彩铃 2 通话 3 彩铃和通话
  • end_call_ivr
  • EndCallIvr
  • 挂机IVR参数
  • └ end_call_ivr
  • String
  • enable
  • 挂机ivr开关
  • └ step1_file
  • String
  • 1.wav
  • 第一步放音文件
  • └ step2_file
  • String
  • 2.wav
  • 第二步放音文件
  • └ valid_key
  • String
  • 1,2
  • 有效按键
  • └ waiting_dtmf_time
  • Number
  • 3
  • 最大等待时长,单位秒
  • └ max_loop
  • Number
  • 3
  • 循环次数
  • └ waiting_end_call
  • Number
  • 3
  • 挂机等待时长
  • └ direction
  • Number
  • 0
  • 0:主叫,1:被叫
  • sequence_call_rule
  • SequenceCallRule
  • 顺振规则
  • └ call_no_ringing
  • String
  • 1
  • 无振铃无法接通时,顺振到下一个号码,例如空号、停机、关机等。该参数不传时默认为1。1:生效
  • └ call_forwarded
  • String
  • 1
  • 忙呼转的情况,指被叫本身设置了【呼叫转移号码】(181信令),出现呼叫转移时顺振到下一个号码。该参数不传时默认为1。1:生效
  • └ busy_reject
  • String
  • 1
  • 忙拒绝情况,指【被叫忙】以及【被叫拒接】时,顺振到下一个号码。该参数不传时默认为1。1:生效
  • └ call_timeout
  • String
  • 15
  • 振铃无响应超时顺振,传入数字n,表示振铃后n秒后顺振到下一个号码。该参数不传时默认为30(也即是30秒顺振下一个号码),单位秒
  • └ content_format
  • String
  • #[号码]#[字符]
  • 格式定义
  • └ status_report
  • Number
  • 0
  • 是否需要状态报告,0:不需要,1:需要
  • └ media_degrade
  • Boolean
  • true
  • 是否媒体资源降级,放弃录音放音功能;接入方无此相关功能,可忽略
  • └ call_duration
  • Number
  • 10
  • 通话持续时长,可选,单位秒,如果出现则通话有效时长为此值,如果没有出现按现在默认处理
  • └ called_no_caller_play_code
  • String
  • 187
  • 摘机后主叫侧的放音编码,多个文件用英文逗号分隔。
  • └ real_no_trans_degrade
  • Boolean
  • true
  • 是否允许透传降级
  • └ mid_biz_mode
  • String
  • AXB
  • 中间号业务模式
  • └ bind_info
  • String
  • {"bindTime":"20250429163920","expireTime":"20250606235959","numberA":"1313****851","numberB":"1303****459","numberX":"1861****347"}
  • 中间号绑定关系
  • └ practitioner_no
  • String
  • 170xxxxxxxx
  • 从业者号码
  • └ consumer_no
  • String
  • 170xxxxxxxx
  • 消费者号码
  • └ code
  • String
  • OK
  • code

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAliqinAxbVendorCallControlRequest req = new AlibabaAliqinAxbVendorCallControlRequest();
AlibabaAliqinAxbVendorCallControlRequest.StartCallRequest obj1 = new AlibabaAliqinAxbVendorCallControlRequest.StartCallRequest();
obj1.setExtension("123");
obj1.setSecretNo("17010000000");
obj1.setCallNo("13519000000");
obj1.setCallTime(StringUtils.parseDateTime("2018-01-01 12:00:00"));
obj1.setCallId("435cf14f7f077e52");
obj1.setRecordType("CALL");
obj1.setVendorKey("CMCC");
obj1.setCallPhase("0");
obj1.setBCallHistory("1");
obj1.setParseResult("0");
req.setStartCallRequest(obj1);
AlibabaAliqinAxbVendorCallControlResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_aliqin_axb_vendor_call_control_response>
    <result>
        <message>xxx</message>
        <control_resp_dto>
            <control_operate>CONTINUE</control_operate>
            <control_msg>OK</control_msg>
            <product_type>AXB</product_type>
            <call_no_play_code>185</call_no_play_code>
            <called_no_play_code>187</called_no_play_code>
            <subs>
                <called_no>132xxxxxxx</called_no>
                <sequence_calls>
                    <sequence_calls>
                        <call_no_play_code>185</call_no_play_code>
                        <called_no>15958178699</called_no>
                        <called_display_no>13049840017</called_display_no>
                        <called_no_play_code>185</called_no_play_code>
                        <called_no_caller_play_code>187</called_no_caller_play_code>
                        <polling_no>1</polling_no>
                    </sequence_calls>
                </sequence_calls>
                <sms_channel>SMS_INTERCEPT</sms_channel>
                <call_type>MASTER</call_type>
                <rec_type>mp3</rec_type>
                <subs_id>1000113049470172</subs_id>
                <sequence_timeout>15</sequence_timeout>
                <need_record>true</need_record>
                <called_display_no>170xxxxxxx</called_display_no>
                <record_mode>1</record_mode>
                <fast_record>0</fast_record>
                <rrds_control>0</rrds_control>
                <ws_addr>ws://127.0.0.1:8001/wsProxy</ws_addr>
                <ws_addr_called>ws://127.0.0.1:8001/wsProxy</ws_addr_called>
                <out_id>1234abc</out_id>
                <need_realtime_media>true</need_realtime_media>
                <rtp_type>1</rtp_type>
                <end_call_ivr>
                    <end_call_ivr>enable</end_call_ivr>
                    <step1_file>1.wav</step1_file>
                    <step2_file>2.wav</step2_file>
                    <valid_key>1,2</valid_key>
                    <waiting_dtmf_time>3</waiting_dtmf_time>
                    <max_loop>3</max_loop>
                    <waiting_end_call>3</waiting_end_call>
                    <direction>0</direction>
                </end_call_ivr>
                <sequence_call_rule>
                    <call_no_ringing>1</call_no_ringing>
                    <call_forwarded>1</call_forwarded>
                    <busy_reject>1</busy_reject>
                    <call_timeout>15</call_timeout>
                </sequence_call_rule>
                <content_format>#[号码]#[字符]</content_format>
                <status_report>0</status_report>
            </subs>
            <media_degrade>true</media_degrade>
            <call_duration>10</call_duration>
            <called_no_caller_play_code>187</called_no_caller_play_code>
            <real_no_trans_degrade>true</real_no_trans_degrade>
            <mid_biz_mode>AXB</mid_biz_mode>
            <bind_info>{&quot;bindTime&quot;:&quot;20250429163920&quot;,&quot;expireTime&quot;:&quot;20250606235959&quot;,&quot;numberA&quot;:&quot;1313****851&quot;,&quot;numberB&quot;:&quot;1303****459&quot;,&quot;numberX&quot;:&quot;1861****347&quot;}</bind_info>
            <practitioner_no>170xxxxxxxx</practitioner_no>
            <consumer_no>170xxxxxxxx</consumer_no>
        </control_resp_dto>
        <code>OK</code>
    </result>
</alibaba_aliqin_axb_vendor_call_control_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部