AXB中間號,是將撥打關(guān)系限定在一對一關(guān)系中,用戶A可以通過中間號碼X聯(lián)系到用戶B,用戶B也可以通過中間號碼X聯(lián)系到用戶A。
接口說明
-
在調(diào)用此接口前,請確保您已在控制臺購買隱私號。
-
您可以使用此接口給 AXB 中間號綁定號碼,也可以在控制臺號碼管理頁面給 AXB 中間號綁定 A、B 號碼。
-
AXB 中間號,綁定號碼前建議您先明確業(yè)務(wù)場景中的 A 角色和 B 角色。例如:在打車應(yīng)用場景中,A 是乘客角色,B 是司機角色。
-
AXB 中間號主要應(yīng)用在 1 對 1 場景下的隱私保護,客戶把 A 號碼和 B 號碼通過號碼隱私服務(wù)實現(xiàn)綁定關(guān)系,A 撥打 X 轉(zhuǎn)接到 B,B 撥打 X 轉(zhuǎn)接到 A;一個 X 號碼可以供 200 對綁定關(guān)系復(fù)用,如 A1XB1、A2XB2、A3XB3......,只要 A、B 用戶手機號碼不重復(fù),一個 X 號碼可同時綁定 200 組手機號碼,通話也可以同時進行。
QPS 限制
本接口的單用戶 QPS 限制為 5000 次/秒。超過限制,API 調(diào)用會被限流,這可能會影響您的業(yè)務(wù),請合理調(diào)用。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dypls:BindAxb | create | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PoolKey | string | 是 | 號碼池 Key。 說明
在號碼隱私保護控制臺,號碼池管理頁面獲取號碼池 Key。
| FC10000016848**** |
PhoneNoA | string | 是 | AXB 中間號的 A 號碼。 說明
| 139****0000 |
PhoneNoB | string | 是 | AXB 中間號的 B 號碼。 說明
| 136****0000 |
PhoneNoX | string | 否 | 171****1893 | |
Expiration | string | 是 | 號碼綁定的過期時間。 說明
| 2021-09-05 12:00:00 |
ExpectCity | string | 否 | 指定城市進行 X 號碼的選號。 說明
| 北京 |
IsRecordingEnabled | boolean | 否 | 是否開啟通話錄音功能。取值:
說明
開啟通話錄音功能后,可在呼叫記錄中播放和下載語音文件。錄音文件按通話分鐘計費 0.010 元/分鐘。
| false |
OutId | string | 否 | 外部業(yè)務(wù)擴展字段,通話記錄回執(zhí)消息中會回傳此參數(shù)。 | abcdef |
OutOrderId | string | 否 | 外部業(yè)務(wù) ID。 | 34553330**** |
CallRestrict | string | 否 | 單次呼叫限制的狀態(tài)。取值:
| CONTROL_AX_DISABLE |
CallDisplayType | integer | 否 | 重置綁定關(guān)系中的號碼顯示邏輯。固定取值 1,即主叫和被叫顯示中間號碼 X。 說明
由于運營商監(jiān)管限制,呼叫時顯示真實號碼的設(shè)置不生效。
| 1 |
RingConfig | string | 否 | 彩鈴配置,AXB 中間號號碼綁定后,撥打 X 號碼的企業(yè)彩鈴;此參數(shù)請?zhí)顚?strong data-sourcepos="1:38-1:46">鈴音字段和彩鈴編碼。 鈴音字段如下:
彩鈴編碼:在號碼隱私保護控制臺企業(yè)彩鈴管理頁面獲取企業(yè)彩鈴編碼。 填寫示例: 如設(shè)置 B 號碼撥打 X 接通前的鈴音,填寫:"AXBRing_B": "1000****1"。 說明
企業(yè)彩鈴優(yōu)先使用綁定級別設(shè)置的彩鈴,如果未設(shè)置或設(shè)置未生效,則會使用號碼池級別的彩鈴音。
| { "AXBRing_B": "1000****1", "AXBRing_A": "1000****1" } |
ASRStatus | boolean | 否 | 是否開啟 ASR 服務(wù)功能。取值:
說明
開通功能后,可以將通話中的語音轉(zhuǎn)為文本,獲取錄音文件同時可獲取文本內(nèi)容。可在呼叫記錄中下載語音文本。 文本結(jié)果按通話分鐘計費,ASR 費用 0.060 元/分鐘。
| false |
ASRModelId | string | 否 | ASR 模型 ID。取值:
| 7ee372834d2f4cc7ac0d0ab2d0****** |
CallTimeout | integer | 否 | 順振時長。單位:秒。取值范圍為 5~20。 | 10秒 |
DtmfConfig | string | 否 | dtmf 按鍵配置,設(shè)置 AXB 中間號號碼綁定時使用,可配置內(nèi)容如下:
| { "endCallIvrPhoneNo":"A", "waitingDtmfTime":10, "maxLoop":3, "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav", "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav", "validKey":"1,2", "waitingEndCall":2 } |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "9297B722-A016-43FB-B51A-E54050******",
"SecretBindDTO": {
"Extension": "130",
"SubsId": "100017838816****",
"SecretNo": "171****1893"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-03-16 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |