调用接口BindAxg添加AXG号码的绑定关系。
AXG隐私号是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案,其中G代表一个号码组,可以根据需要添加号码。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Expiration | String | 是 | 2019-09-05 12:00:00 |
绑定关系的过期时间。必须晚于当前时间1分钟以上。 |
GroupId | String | 是 | 1234 |
AXG中的G组ID,即GID。 可以通过以下方式查看GID:
说明 G号码组中必须有一个及以上的电话号码。
|
PhoneNoA | String | 是 | 15000000000 |
AXG中的A号码。 A号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符,例如057188992688。 |
PoolKey | String | 是 | FC123456 |
号码池Key。请登录号码隐私保护控制台,在号码池管理中查看号码池Key。 |
AccessKeyId | String | 否 | LTAIP00vvvvvvvvv |
主账号AccessKey的ID。 |
Action | String | 否 | BindAxg |
系统规定参数。取值:BindAxg。 |
CallDisplayType | Integer | 否 | 1 |
重置绑定关系中的号码显示逻辑,1:主被叫显示中间号码X;2:B/N侧号码呼叫时,给A侧号码显示B/N的真实号码;3:A侧号码呼叫时,给B/N侧号码显示真实号码。 |
ExpectCity | String | 否 | 北京 |
指定城市进行X号码的选号。 如果当前号池中没有该城市的可用号码,或未指定此参数,将从当前号码池中随机分配一个其他城市的号码作为X号码。 如果配置了严格模式,则不存在符合条件的号码时会提示分配错误。 |
IsRecordingEnabled | Boolean | 否 | true |
是否需要针对该绑定关系产生的所有通话录制通话录音。 |
OutId | String | 否 | abcdef |
外部业务扩展字段,通话记录回执消息中会回传此参数。 |
OutOrderId | String | 否 | abcdef |
外部业务ID。 |
PhoneNoB | String | 否 | 15000000001 |
AXG中的B号码,A号码拨打X号码时会转接到B号码,可通过接口UpdateSubscription更新B号码。 B号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符,例如057188992688。 |
PhoneNoX | String | 否 | 17000000000 |
AXG中的X号码。未指定X号码时,将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。 X号码是您绑定号码前在控制台或通过接口BuySecretNo购买的电话号码,用于转接电话。 |
RingConfig | String | 否 | {"AXGRing_AB":"100000001","AXGRing_A":"100000002","AXGRing_G":"100000003"} |
设置AXG绑定级别企业彩铃放音,支持针对该绑定关系中设置,内容包括如下:
特殊说明:企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK |
请求状态码。
|
Message | String | OK |
状态码的描述。 |
RequestId | String | F655A8D5-B967-440B-8683-DAD6FF8DE990 |
请求ID。 |
SecretBindDTO |
绑定成功后返回的结构体。 |
||
Extension | String | 2000000000000 |
绑定关系ID。分机号码。接口BindAxg不涉及分机号码,请忽略该返回参数。 |
SecretNo | String | 17100000000 |
隐私号码,即X号码。 |
SubsId | String | 1000000763890000 |
订购关系ID。 |
示例
请求示例
http(s)://[Endpoint]/?Expiration=2019-09-05 12:00:00
&GroupId=1234
&PhoneNoA=15000000000
&PoolKey=FC123456
&<公共请求参数>
正常返回示例
XML
格式
<BindAxgResponse>
<Message>OK</Message>
<RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>
<Code>OK</Code>
<SecretBindDTO>
<Extension>2000000000000</Extension>
<SecretNo>17100000000</SecretNo>
<SubsId>1000000763890000</SubsId>
</SecretBindDTO>
</BindAxgResponse>
JSON
格式
{
"Message":"OK",
"RequestId":"F655A8D5-B967-440B-8683-DAD6FF8DE990",
"Code":"OK",
"SecretBindDTO":{
"Extension":"2000000000000",
"SecretNo":"17100000000",
"SubsId":"1000000763890000"
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交