调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PoolKey | string | 是 | 号码池Key。请登录号码隐私保护控制台,在号码池管理中查看号码池Key。 | FC2235**** |
AxgBindList | object [] | 是 | Axg绑定列表 | |
PhoneNoA | string | 是 | AXG中的A号码。 A号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。 | 13333333333 |
GroupId | string | 是 | AXG中的G组ID,即GID。 可以通过以下方式查看GID:
说明G号码组中必须有一个及以上的电话号码。 | 1234 |
PhoneNoB | string | 否 | AXG中的B号码,A号码拨打X号码时会转接到B号码,可通过接口UpdateSubscription更新B号码。 B号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。 | 13333333333 |
PhoneNoX | string | 否 | AXG中的X号码。未指定X号码时,将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。 说明X号码是您绑定号码前在控制台或通过接口BuySecretNo购买的电话号码,用于转接电话。 | 13333333333 |
ExpectCity | string | 否 | 指定城市进行X号码的选号。
| 北京 |
IsRecordingEnabled | boolean | 否 | 是否需要针对该绑定关系产生的所有通话进行通话录音。取值:
| False |
OutId | string | 否 | 外部业务扩展字段,通话记录回执消息中会回传此参数。 | 18223ad447910fd |
Expiration | string | 否 | 绑定关系的过期时间,时间单位精确到秒。 说明必须晚于当前时间1分钟以上。 | 2022-07-11 01:05:15 |
OutOrderId | string | 否 | 外部业务ID。 | 20220824021816883677 |
CallDisplayType | integer | 否 | 重置绑定关系中的号码显示逻辑。固定取值:1(主被叫显示中间号码X)。 说明由于运营商监管限制,呼叫时显示真实号码的设置不生效。 | 1 |
RingConfig | string | 否 | 设置AXG绑定级别企业彩铃放音,支持针对该绑定关系中设置,内容包括如下:
说明企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。 | {\"AXBRing_B\":\"100000002\",\"AXBRing_A\":\"100000001\"} |
ASRStatus | boolean | 否 | ASR状态。取值:
| true |
ASRModelId | string | 否 | ASR模型ID。可以在ASR模型管理页面查看ASR模型ID。 | 7ee372834d2f4cc7ac0d0ab2d0ae1aac |
CallRestrict | string | 否 | 单通呼叫限制的状态。取值:
| CONTROL_AX_DISABLE |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "5DCCA8CD-6C0A-50B4-A496-B1D2AB48A1C3",
"SecretBindList": {
"SecretBind": [
{
"SecretNo": "13333333333",
"SubsId": "1000085060515673",
"Extension": "257",
"GroupId": "1234",
"PhoneNoA": "13333333333",
"Code": "isv.INVALID_PARAMETERS",
"Message": "ringConfig invalid"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-27 | 新增 OpenAPI |