您使用本服務應當閱讀并遵守《中國東信通信能力技術服務協議》及本服務條款(中國東信即中國—東盟信息港股份有限公司,以下簡稱東信)。如遇《中國東信通信能力技術服務協議》與本服務條款不一致之處,優(yōu)先適用本服務條款。在滿足前述條件及東信規(guī)定的隱私號技術服務其他準入條件、提交相關資料后,經東信同意后開通隱私號技術服務,方可成為隱私號服務開發(fā)者。無論是否實際閱讀本協議,您通過網絡頁面點擊確認本條款或實際使用隱私號技術服務,均表示您與東信及服務提供方廣西東信易通科技有限公司已就本條款達成一致并同意接受本條款的全部約定內容。
第一條 定義
1.1 號碼隱私保護服務(以下簡稱本服務):指易通與基礎電信運營商合作為用戶提供的隱私保護服務,基礎運營商為用戶提供一個臨時號碼(以下簡稱小號),并將該小號與用戶常用手機號碼進行綁定,實現通過該小號接聽電話的功能。易通提供小號使用過程查詢及綁定關系管理的API接口服務。
1.2 號碼:指本服務中用于實現隱私保護的碼號,包括但不限于11位手機號碼、95擴位號碼等。用戶使用本服務無須實體SIM卡,服務到期用戶也無須辦理銷戶手續(xù)。
1.3 API接口:易通向用戶提供的接口,用戶通過接口獲得易通小號隱私保護服務能力,并基于該接口和能力自行開發(fā)和利用實現特定目的。
第二條 開通服務
您應按照本網站載明的號碼隱私保護業(yè)務權限申請要求提交信息,并對提交信息的真實性、合法性、有效性獨立承擔全部責任;易通有權根據您的信息進行綜合判斷,并保留決定您是否符合權限開通要求的權利
第三條 服務內容
3.1 易通向您提供API技術服務接口,您使用易通接口調用能力在業(yè)務場景中實現保護其用戶隱私的目的。
3.2 您通過本服務訂購的號碼可用于且僅可用于為您于網站填寫的業(yè)務場景及用途(以下簡稱“約定業(yè)務”)的用戶提供隱私保護服務。如需擴展業(yè)務場景您應另行提交申請,經易通同意后方可提供。舉例說明:
AXB:
(1)假設用戶王某號碼為A,用戶張某號碼為B,易通為用戶王某和張某提供一個臨時號碼X,并將號碼A與號碼B進行綁定,形成AXB關系。
(2)當王某撥打號碼X時,即可接通張某號碼B;當張某撥打號碼X時,即可接通王某號碼A。王某和張某的來電顯示均是X。
(3)其他號碼撥打X時,系統(tǒng)自動阻攔,將無法接通。
AXN:
(1)假設用戶王某號碼為A,易通為用戶王某提供一個臨時號碼X,并將號碼A與X進行綁定,形成AXN關系。
(2)當其他人撥打號碼X,即可接通王某號碼A。
錄音:
易通通信為客戶提供AXB、AXN過程錄音的服務能力;客戶可以根據自己需求開通此增值服務,客戶在使用此服務需要遵守錄音使用規(guī)范。
(1)錄音可用于且僅可用于對通話過程中服務質量監(jiān)控,同時需要在網站或app醒目位置提醒用戶“為了保證服務質量,您的通話過程會被錄音”等提示性語句。
(2)您有義務在法律規(guī)定范圍內對發(fā)送的錄音文件或文本做安全審核。文件或文本內容不得包含違反國家法律法規(guī)、反黨反政府反社會主義、色情、損壞安定團結社會的內容。由于您審核責任造成以上內容被播放所產生的法律責任全部由您負責。
3.3 易通通過技術手段,通過小號與常用號碼的綁定關系實現主叫、被叫時對用戶常用號碼的隱藏保護。同時,易通根據您的需求實現小號的分配、綁定和解綁,解綁后將無法通過該小號聯系。
3.4 在您提供營業(yè)執(zhí)照副本等開戶資料并經易通審核通過后,您將作為使用小號號碼的企業(yè)用戶獲得在協議期間內、按照約定用途的小號使用權,同時您應對所有使用的小號號碼承擔責任。
3.5 應國家實名制要求,您需記錄使用小號用戶的真實身份信息,包括但不限于姓名、身份證號碼、手機號碼等,并將前述信息同步提供給易通。
第四條 費用
易通有權制定本服務的費用標準及收費規(guī)則并公示于網站上,并有權隨時做出變更,亦可通過書面方式與您對費用標準及收費規(guī)則進行變更(如與網站不一致,以書面約定為準),您使用本服務即意味著您接受該費用,并同意易通有權單方判斷和決定您所使用的具體服務的類型及適用資費,如您不同意公布或變更的費用標準應立即停止使用本服務,否則使用或繼續(xù)使用將被視為您同意接受費用標準。
第五條 服務使用規(guī)范
5.1 您保證訂購的小號僅用于約定業(yè)務中用戶的隱私保護,超出該范圍使用小號的,易通有權停止服務,因此導致易通被國家機關、運營商、用戶等其他第三方追究責任或產生損失的,您應當予以賠償。
5.2 易通向您提供API接口,您通過調用易通API接口實現向易通訂購小號,并由易通提供技術服務以實現在訂購期(即您對小號與用戶常用號碼每次綁定至解綁的時段)內您的用戶使用訂購的小號撥打及接聽電話的功能。通過調用API接口來做小號的訂購,每購買成功一個新號碼計為使用一個號碼。在一個計費周期內(一個自然月)解綁后將原小號綁定到用戶新的常用號碼上,此次綁定不作為使用新號碼計算
5.3 易通為您提供小號購買、綁定狀態(tài)查詢的管理后臺,您可以在遵循業(yè)務規(guī)則自行配置使用小號。
5.4 東信為您使用隱私號平臺服務提供咨詢和服務支撐,服務期間提供在線客服的咨詢服務支持(工作日:早9:00—晚20:00)。
5.5 易通僅提供應用程序接口,您應自行編寫程序以調用小號服務,易通不對您的編程過程或程序應用結果承擔任何責任。
5.6 易通提供的小號號碼為隨機號碼,每個號碼訂購期結束后即收回。
5.7 您不得將易通提供的服務以任何方式向您用戶或其他第三方進行出售或進行任何利益交換,不得將本協議的全部或部分轉讓給第三方,否則易通有權解除本協議;但第三方為您關聯公司的情形除外。
5.8 在本協議有效期內,您對所訂購的小號一切行為承擔全部責任,如因您或您用戶使用本服務的行為導致易通為此承擔了相關的責任,您需全額賠償易通的相關支出及損失,包括但不限于律師費用、訴訟費等。
5.9 您按照本協議約定使用易通服務向您用戶提供隱私保護服務,應當取得用戶的同意,并由您自行承擔權利義務和責任,易通對于您與您用戶之間關于使用您提供服務的相關權利義務和糾紛不承擔責任。
5.10 您理解并應向您用戶提醒,為保證碼號資源的合理有效利用,通過本服務獲得的小號可能是易通在其他用戶停止使用并經過一定期間后收回的號碼,小號本身不提供短信發(fā)送功能。
5.11 您使用本服務的同時保證遵循易通小號產品的規(guī)則規(guī)范。
5.12 在使用易通API時,您不應有如下行為:
(1)修改、翻譯、改編、出租、轉許可、在信息網絡上傳播或轉讓易通提供的應用接口,也不得逆向工程、反編譯或試圖以其他方式發(fā)現易通提供的應用接口的源代碼(除易通明示許可外);
(2)進行任何破壞或試圖破壞網絡安全的行為(包括但不限于釣魚,黑客,網絡詐騙,網站或空間中含有或涉嫌散播:病毒、木馬、惡意代碼,及通過虛擬服務器對其他網站、服務器進行涉嫌攻擊行為如掃描、嗅探、ARP欺騙、DOS等);
(3)進行任何改變或試圖改變易通提供的系統(tǒng)配置或破壞系統(tǒng)安全的行為;
(4)未按照本協議以及易通就API在相關頁面上展示的規(guī)定、公告內容的行為,或侵犯易通及第三方的權利的行為;
(5)其它任何違反相關法律法規(guī)的行為。
5.13 您同意,在應國家機關要求或易通為處理投訴等需要時配合提供使用小號的用戶身份信息。
5.14 甲方應按照本協議約定的費用及結算標準按時足額支付費用,如逾期付款超過1個月,乙方有權解除您所有號碼的綁定關系,如逾期超過3個月,乙方將收回甲方訂購的所有小號,在小號被收回前甲方仍應按照本協議約定支付小號號碼月租費。
5.15 有下列情形之一的,易通有權單方解除協議、收回號碼,因此給易通造成損失的,您應當予以賠償:
(1)您使用小號從事本協議禁止的行為;
(2)您超出本協議范圍使用小號且經易通告知后仍拒絕更正的;
(3)您未按時支付服務費用。
5.16 您承諾不得利用易通號碼隱私保護能力對屬于您的用戶或對第三方進行呼叫騷擾,同時,當您收到投訴或您服務的用戶或第三方明確表示拒絕接收后,您不得再向該用戶或第三方進行呼叫,否則由此引起的投訴、法律責任全部由您負責承擔,易通亦有權要求您對易通所遭受的一切損失承擔相應的賠償。
5.17 易通為您提供號碼隱私保護服務的號碼需完成實名登記后方可提供服務,您應按照易通要求如實提供相應材料,包括但不限于企業(yè)資料、服務應用場景、服務話術。您亦同意易通將您實名登記材料提供給運營商備案。若發(fā)現您的資料不真實或無效的,易通有權在不通知您的情況下停止向您提供服務,您所購買的號碼隱私保護通話時長套餐包余量將不做退費處理。
5.18 您不得超出本協議范圍使用服務,不得直接或變相向第三方轉租轉售號碼隱私保護服務,為第三方提供號碼隱私保護服務,不得將本協議全部或任何一部分轉讓或出借給其他第三方使用。
5.19 您承諾規(guī)范使用易通提供的號碼隱私保護業(yè)務,不違規(guī)經營、不變更合同約定用途。您保證不會對號碼進行多次轉接以躲避號碼溯源與甄別。您承諾不私自轉接境外及港澳臺地區(qū)來話,不通過技術手段為非法VoIP、改號電話、網絡電話(PC軟件/APP等)提供語音呼叫落地。如您違反,易通有權停止向您提供服務并對您追究法律責任。
5.20 您理解并同意,當易通收到政府部門、運營商、12321舉報中心等通信管控渠道的投訴時,易通有權自行判斷問題的嚴重程度,并有權單方停止向您提供服務并對您追究法律責任,您所購買的號碼隱私保護通話時長套餐包余量將不做退費處理。
5.21 您理解并同意,當運營商或國家有關部門發(fā)現您的通話頻次異常、超約定用途使用或被政府部門通報等情況時,易通有權單方停止向您提供服務并對您追究法律責任。
5.22 您承諾建立有效的信息安全管理制度和技術保障措施,并配合政府部門、運營商或易通的管理、監(jiān)督和檢查,無條件配合落實相關整改舉措,直至符合相關法律及政策文件要求。
5.23 易通有權制定本服務的費用標準及收費規(guī)則并公示于網站上,并有權根據市場情況和業(yè)務投訴比例隨時做出變更,亦可通過書面方式與您對費用標準及收費規(guī)則進行變更(如與網站不一致,以書面約定為準),您使用本服務即意味著您接受該費用,并同意易通有權單方判斷和決定您所使用的具體服務的類型及適用資費,如您不同意公布或變更的費用標準應立即停止使用本服務,否則使用或繼續(xù)使用將被視為您同意接受費用標準。
5.24 易通有權對您使用的號碼隱私保護服務進行監(jiān)督、審核和監(jiān)測,且易通有權單方判斷和決定您是否違反本協議,并有權拒絕提供違反法律規(guī)定或本協議約定的服務,一經發(fā)現您違反法律規(guī)定或本協議約定的情況,有權立即停止提供服務,并有權視情節(jié)輕重要求您限期整改、暫停業(yè)務直至單方面解除合作協議,您已經繳納的但未使用完的費用,將作為違約金,易通有權不予退還,如不足以彌補易通損失的,易通有權向您進行追償。如果因您的用戶投訴導致易通號碼隱私保護服務被運營商停用,易通有權要求您對易通所遭受一切損失承擔相應的賠償責任。
5.25 禁止將號碼隱私保護服務用于國家法規(guī)或運營商禁止開展的業(yè)務,包括但不限于:色情、賭博、毒品、黨政、法律維權、眾籌、慈善募捐、宗教、迷信、股票、留學移民、面試招聘、博彩、貸款、催款還款、投資理財等業(yè)務。
5.26 因法律法規(guī)、政策或原因導致易通業(yè)務停止或受限,使本協議無法繼續(xù)履行,或因易通與運營商停止合作導致無法繼續(xù)提供隱私保護服務,或因其他不可預見的原因導致易通無法繼續(xù)開展隱私保護業(yè)務運營,易通應當提前7天通知您,本協議自易通通知載明的解除之日起終止,易通對此不承擔違約責任。但易通應當退還相應的您預付但未使用完的服務費用。
接口概述
第三方業(yè)務系統(tǒng)與小號業(yè)務系統(tǒng)之間,采用HTTP方式進行通信,數據內容以JSON格式作為HTTP的載荷。業(yè)務請求階段第三方業(yè)務系統(tǒng)作為客戶端,小號業(yè)務系統(tǒng)作為服務端。業(yè)務結果推送階段第三方業(yè)務系統(tǒng)作為服務端,小號業(yè)務系統(tǒng)作為客戶端。
通信模型
1. 業(yè)務消息交互
第三方業(yè)務系統(tǒng)作為業(yè)務的發(fā)起方,小號業(yè)務系統(tǒng)作為業(yè)務的受理方。雙方采用JSON over HTTP進行通信。
2. 業(yè)務消息格式
2.1 消息組成
消息由接口、請求頭、請求體三部分組成,包含在HTTP載荷中。
接口: method+URL 如:POST {url}/v2/axb
請求頭:key:value
請求體: json串
對象的取值為數字的,一律以字符串表示
消息都是以UTF-8編碼
接口風格
公共請求頭
"Accept", "application/json;charset=utf-8", "Content-Type", "application/json;charset=utf-8"
公共響應體
所有的響應Json都應符合下面的格式,其中code是返回碼,state是故障碼
{
"code": 0,
"message": "success",
"data": {
}
}
2.2 APPKEY的組成
第三方業(yè)務系統(tǒng)接入平臺時,需在消息頭傳入appkey參數,用來區(qū)分不同的APP接入。
appkey示例如下,由下劃線分割的兩部分組成,其中下劃線以前部分(四位定長字母)由平臺分配用來標識不同的接入商,下劃線后面部分XXXX(四位定長數字)由第三方業(yè)務系統(tǒng)自行定義,用來標識同一個接入商的不同APP。
例:"appkey":"ALPT_0001"
2.3 MSGDGT的生成
msgdgt是消息交換雙方進行數據校驗的摘要信息,用來保證數據在網絡傳輸過程中的數據一致性,剔除假冒和非法的請求數據。
系統(tǒng)采用共享秘鑰方式,秘鑰由業(yè)務平臺分配。
msgdgt生成規(guī)則如下:
1)把消息頭(appkey和ts)、消息體按key的字母順序排序
2)排序后將密鑰、消息頭(appkey和ts)和消息體的所有key、value串起來以UTF-8編碼進行MD5加密,如: MD5(secretkey1value1key2value2..)
3)生成32位大寫的摘要字符串,如:BA9854BED1A2986B061E2713F403C752
2.4 code返回碼定義
第三方業(yè)務系統(tǒng)應該檢查響應消息中的“返回碼”。如果結果不是成功,則第三方業(yè)務系統(tǒng)需要針對不同返回碼進行處理。
平臺返回碼
401
認證未通過
請求的來源或者請求的簽名未通過校驗。
402
號碼已有相關綁定關系
請求中要求綁定的小號已經被分配給其他用戶。
402
未找到對應號碼
請求綁定小號在號碼池中未找到
403
綁定關系不存在
第三方業(yè)務系統(tǒng)提交的請求中提供的“綁定關系標識”,在小號業(yè)務系統(tǒng)中不存在。
404
綁定數據不一致
請求中提供的“綁定關系標識”在小號業(yè)務系統(tǒng)中查詢獲得的“真實號碼”和“小號”綁定關系,與請求中提供的“真實號碼”與“小號”不一致。
429
請求過多
第三方業(yè)務系統(tǒng)在一定時間內提交了過多的請求。第三方業(yè)務系統(tǒng)在訪問某些特定服務接口時,可能會出現該錯誤。
501
小號使用異常
小號被下線或者與appkey不匹配時會出現該錯誤
502
請求報文有誤
請求報文有誤,檢查請求頭和請求體、請求方法是否按照文檔規(guī)范填寫
503
服務接口被禁止
小號業(yè)務系統(tǒng)已經關閉相關服務。后續(xù)對于該服務的請求是被禁止的。
業(yè)務開放接口
接入商可以通過業(yè)務開放接口對其配屬的X號碼進行設置,設置包括呼轉,查詢,放音;當X對應的綁定業(yè)務不存在時候,小號系統(tǒng)按業(yè)務開發(fā)屬性實現功能;
1. 外呼轉接配置
1.1 外呼轉接配置設置請求和響應
作用范圍為AXB類型的X號碼;
接口
PUT {url}/v2/axb/outtransfer
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telX": "13720056198",
"transferms": "13720056197",
"transfervoicecode": "1",
"transfercalldisplay": "0",
"transfercallrecording": "0",
"calldisplayshow": "0"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
transferms
string
轉接號碼
M
轉接號碼
transfervoicecode
string
轉接號碼設置放音編碼
M
設置轉接號碼的放音編碼
transfercalldisplay
string
來顯控制
M
轉接號碼的來顯控制,默認0
0:顯示X號碼
1:顯示真實號碼
transfercallrecording
string
錄音控制
M
默認是0(不開通錄音功能)。
0:不開通錄音功能
1:開通錄音功能
calldisplayshow
string
推送被叫來顯號碼控制
0
可選。僅下列值有效。默認是0。
0 推送中不攜帶被叫來顯號碼
1 推送中攜帶被叫來顯號碼
callcontrol
string
被叫接通控制
0
可選。其他號碼呼叫X時,對來顯進行鑒權,僅下列值有效。默認是0。
0 不對來話號碼鑒權
1 對來話號碼鑒權
selfvoivecode
string
放音編碼
0
當綁定的被轉接號碼撥打X號碼時聽到此放音
響應體
{
"code": "0",
"message": "success"
}
1.2 外呼轉接配置刪除請求和響應
接口
DELETE {url}/v2/axb/outtransfer/{telX}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應體
{
"code": "0",
"message": "success"
}
1.3 外呼轉接配置推送接口

呼叫開始推送,參考AXB呼叫開始推送

呼叫結束推送,參考AXB呼叫結束推送
AXB業(yè)務接口
1. AXB綁定解綁接口
AXB業(yè)務主要的請求和響應類型如下:
綁定
解綁
1.1 外呼轉接配置設置請求和響應
接口
POST {url}/v2/axb/{xmode}
xmode取值:
mode101:APP自帶x號碼
mode102:平臺分配x號碼
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13900000000",
"telX": "13720056199",
"telB": "13005711234",
"subts": "20150920190126",
"anucode": "1,2,3",
"areacode": "10",
"expiration": "7200",
"remark": "derc",
"extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1","calldisplayshow": "0","callunsub": "0","callpickup": "0"
}
}
appkey
string/header
應用id
M
ts
string/header
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
telX
string
小號號碼
0
101模式填該字段,102模式不填
subts
string
綁定時間
M
格式為yyyyMMddHHmmss。時間采用北京時間,24小時制。
anucode
放音編碼
M
AXB業(yè)務時必須設置。
放音編碼必須包含3個場景的編碼。按照“B->X,A->X,其他號碼->X”的順序填寫編碼,編碼之間以逗號分隔。
比如:“1,2,3”表示 B->X 放音編號為 1,A->X 放音編號為 2,其他號碼->X 放音編號為 3。
areacode
string
區(qū)號
0
例如:北京(10);在平臺分配X號碼模式中,平臺從號碼池中分配該地區(qū)的X號碼,避免產生呼叫長途費。101模式不填該字段,102模式需要填
expiration
string
過期時間
M
單位:秒, 自綁定時間開始后expiration秒自動解綁;0表示不限制時間,不會自動解綁
remark
string
接入商自有字段
0
接入商自有字段,不能超過30個字節(jié)
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認是0(不開通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來顯控制
0
可選。 針對AXB中的A或者B作為主叫時,是否在被叫上顯示來話的真實號碼。默認為0(不顯示真實號碼)。
0:不顯示真實號碼
1:顯示真實號碼
來顯控制按照“A->B時B上的顯示,B(N)->A時在A上的顯示”的順序填寫編碼,編碼之間以逗號分隔?!捌渌柎a”的來顯控制,同B(N)設置。
場景
A -> B
B(N)-> A
calldisplay
(1)
A 顯示為X
B(N)顯示為X
“0,0”
(2)
A 顯示為X
B(N)顯示為B(N)
“0,1”
(3)
A 顯示為A
B(N)顯示為X
“1,0”
(4)
A 顯示為A
B(N)顯示為B(N)
“1,1”
-callrestrict
string
呼叫控制
0
可選。
僅下列值有效。默認是1。
0 AXB不做呼叫控制,A和B(N)均有權限,即為現有的AXN模式
1 AXB做呼叫控制,A和B有權限,其他號碼無權限,即為現有的AXB
2 AXB的單通控制,A無權限,B有權限,其他號碼無權限
3 AXB的單通控制,A有權限,B以及其他號碼無權限
4 AXN的單通控制,A無權限,B以及其他號碼有權限
5 AXN的單通控制,A有權限,B以及其他號碼無權限
6?均無權限
-calldisplayshow
string
推送被叫來顯號碼控制
0
可選。
僅下列值有效。默認是0。
0 推送中不攜帶被叫來顯號碼
1 推送中攜帶被叫來顯號碼
-callunsub
string
解綁推送消息控制
0
可選。
僅下列值有效。默認是0。
0 解綁不推送消息
1 解綁推送消息
-ringpickup
string
被叫振鈴推送事件控制
0
可選。
僅下列值有效。默認是0。
0 不推送被叫振鈴事件
1 推送被叫振鈴事件
-callpickup
string
被叫接通推送事件控制
0
可選。
僅下列值有效。默認是0。
0 不推送被叫接通事件
1 推送被叫接通事件
-callcontrol
string
被叫接通控制
0
可選。其他號碼呼叫X時,對來顯進行鑒權,僅下列值有效。默認是0。
0 不對來話號碼鑒權
1 對來話號碼鑒權
-callduration
string
通話持續(xù)時間
0
可選,單位秒,如果出現則通話有效時長為此值,如果沒有出現按現在默認處理。
響應體
{
"code": "0",
"message": "success",
"data": { "subid": "100X571X0000000001", "telX": "13720056199"}
}
請求響應實例mode101:
/v2/axb/mode101 HTTP/1.0
X-Real-IP: 192.168.150.160
Host: localhost
X-Forwarded-For: 192.168.150.160
Connection: close
Content-Length: 182
Accept-Language: zh-cn
Accept: application/json;charset=utf-8
appkey: JD_0001
ts: 20161213110012564
msgdgt: 29050BBCCDBE07AB281DEDDEA32C6426
Content-Type: application/json;charset=utf-8
{"telX":"15601000100","expiration":"30000","requestId":"1234420","extra":{"callrecording":"1"},"subts":"20161213110012","telA":"13601000100","anucode":"1,2,3","telB":"15588760015"}
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
Date: Tue, 13 Dec 2016 03:00:12 GMT
Server: BSS/1.1
Content-Length: 90
Connection: close
{"code":0,"message":"SUCCESS","data":{"telX":"15601000100","subid":"A100X558X0000400025"}}
請求響應實例mode102:
POST /v2/axb/mode102 HTTP/1.0
X-Real-IP: 192.168.150.160
Host: localhost
X-Forwarded-For: 192.168.150.160
Connection: close
Content-Length: 177
Accept-Language: zh-cn
Accept: application/json;charset=utf-8
appkey: JD_0001
ts: 20161213105929124
msgdgt: 6908C8682BE4FF3996792A6142C0F16F
Content-Type: application/json;charset=utf-8
{"expiration":"30000","requestId":"1223537","extra":{"callrecording":"1"},"areacode":"556","subts":"20161213105929","telA":"1370000125","anucode":"1,2,3","telB":"15688760025"}
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
Date: Tue, 13 Dec 2016 02:59:29 GMT
Server: BSS/1.1
Content-Length: 90
Connection: close
{"code":0,"message":"SUCCESS","data":{"telX":"15601000101","subid":"A100X556X0000400024"}}
1.2 解綁請求和響應
接口
DELETE {url}/v2/axb/{subid}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string/header
應用id
M
ts
string/header
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
DELETE /v2/axb/A100X558X0000400023 HTTP/1.0
X-Real-IP: 192.168.150.160
Host: localhost
X-Forwarded-For: 192.168.150.160
Connection: close
Content-Length: 0
Accept-Language: zh-cn
Accept: application/json;charset=utf-8
appkey: JD_0001
ts: 20161213105808354
msgdgt: FB18E497C39505A84127D8C2B7A2DDAB
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
Date: Tue, 13 Dec 2016 02:58:08 GMT
Server: BSS/1.1
Content-Length: 30
Connection: close
{"code":0,"message":"SUCCESS"}
2. AXB業(yè)務設置接口
2.1 綁定更新請求和響應
接口
PUT {url}/v2/axb/{subid}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13900000000",
"telB": "13005711234",
"subts": "20150920190126",
"anucode": "1,2,3",
"expiration": "7200",
"extra": { "callrecording": "0","calldisplay": "0,0"
}
}
appkey
string/header
應用id
M
請求和綁定時的appkey必須一致;
ts
string/header
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
telA
string
真實號碼
0
telA,telB不允許同時更新
telB
string
對端號碼
0
telA,telB不允許同時更新
subts
string
綁定時間
M
格式為yyyyMMddHHmmss。時間采用北京時間,24小時制。
anucode
放音編碼
0
AXB業(yè)務時必須設置。
放音編碼必須包含3個場景的編碼。按照“A->X,B->X,其他號碼->X”的順序填寫編碼,編碼之間以逗號分隔。
比如:“1,2,3”表示A->X放音編號為1, B->X放音編號為2, 其他號碼->X放音編號為3。
expiration
string
過期時間
0
單位:秒, 自綁定時間開始后expiration秒自動解綁;0表示不限制時間,不會自動解綁
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認是0(不開通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來顯控制
0
可選。 針對AXB中的A或者B作為主叫時,是否在被叫上顯示來話的真實號碼。默認為0(不顯示真實號碼)。
0:不顯示真實號碼
1:顯示真實號碼
來顯控制按照“A->B時B上的顯示,B(N)->A時在A上的顯示”的順序填寫編碼,編碼之間以逗號分隔。“其他號碼”的來顯控制,同B(N)設置。
場景
A -> B
B(N)-> A
calldisplay
(1)
A 顯示為X
B(N)顯示為X
“0,0”
(2)
A 顯示為X
B(N)顯示為B(N)
“0,1”
(3)
A 顯示為A
B(N)顯示為X
“1,0”
(4)
A 顯示為A
B(N)顯示為B(N)
“1,1”
響應體
{
"code": "0",
"message": "success"
}
2.2 綁定查詢請求和響應
接口
GET?{url}/v2/axb/subid/{subid}
GET?{url}/v2/axb/xa/{telX}/{telA}
GET?{url}/v2/axb/xb/{telX}/{telB}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應體
{
"code": "0",
"message": "success",
"data": {
"telA": "13900000000",
"telX": "13720056199",
"telB": "13005711234",
"subts": "20150920190126",
"subid": "100X571X0000000001",
"anucode": "1,2,3",
"areacode": "10",
"expiration": "7200",
"extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1","calldisplayshow": "0"}
}
}
3 AXB業(yè)務推送接口
3.1 code返回碼定義
第三方APP返回碼:
401
認證未通過
推送的來源或者推送的簽名未通過校驗。
3.2 呼叫起始推送
接口
POST {url}/v2/axb/callin
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"calltime": "2016-11-03 20:22:20",
"callid":"14c821340104058b",
"callrecording": "0",
"calldisplay": "13720056197",
"smscnt": "1"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
remark
string
接入商自有字段
0
接入商自有字段,在綁定請求攜帶過來,不能超過30個字節(jié)
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
31:轉接短信
真實號碼為A
小號為X
對端號碼為B或者其它
calltime
string
發(fā)起呼叫時間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標識
M
唯一關聯標識
callrecording
string
錄音控制
M
同綁定接口定義
calldisplay
string
被叫來顯號碼
0
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
POST /v2/axb/callin HTTP/1.1
Connection: close
Contet-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
appkey: PRD-6-1-1472023876
msgdgt: 94872E3BA9A418E045911A7446201A6F
ts: 20161213151618497
Content-Length: 214
Host: 192.168.110.196:10010
User-Agent: Apache-HttpClient/4.3.2 (java 1.5)
Accept-Encoding: gzip,deflate
{"telX":"1560100106","callid":"0102030000000000","calltype":"10","requestId":"1119897972","calltime":"2016-12-13 15:16:17","callrecording":"1","telA":"1560000106","subid":"A102X0571X0000000002","telB":"1560200106"}
HTTP/1.0 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 35
Server: Werkzeug/0.11.11 Python/2.7.11
Date: Tue, 13 Dec 2016 07:15:25 GMT
{"message": "success", "code": 200}
3.3 呼叫結束推送
接口
POST {url}/v2/axb/finish
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"calltime": "2016-11-03 20:22:20",
"ringingtime": "2016-11-03 20:22:20",
"starttime": "2016-11-03 20:22:20",
"releasetime": "2016-11-03 20:22:20",
"callid": "14c821340104058b",
"releasedir": "1",
"releasecause": "1",
"callrecording": "0",
"recordUrl": "http://101.12.12.123:12000/record/ALPT_1234_14c8546501234567_18600000000_13800000000_20161204070000.mp3",
"recordMode": "2",
"telredir": "13720056197",
"redirreason": "1",
"calldisplay": "13720056195"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
真實號碼為A
小號為X
對端號碼為B或者其它
calltime
string
發(fā)起呼叫時間
M
格式: yyyy-MM-dd HH:mm:ss
ringingtime
string
振鈴開始時間
M
格式: yyyy-MM-dd HH:mm:ss
starttime
string
通話開始時間
M
格式: yyyy-MM-dd HH:mm:ss
releasetime
string
通話結束時間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標識
M
業(yè)務參考號
releasedir
string
釋放方向
M
1表示主叫,
2表示被叫,
0表示平臺釋放
releasecause
string
釋放原因
M
000 0001(1) 未分配的號碼
000 0010(2) 無路由到指定的轉接網
000 0011(3) 無路由到目的地
000 0100(4) 發(fā)送專用信息音
001 0000(16) 正常的呼叫拆線
001 0001(17) 用戶忙
001 0010(18) 用戶未響應
001 0011(19) 用戶未應答
001 0100(20) 用戶缺席
001 0101(21) 呼叫拒收
001 0110(22) 號碼改變
001 1011(27) 目的地不可達
001 1100(28) 無效的號碼格式(地址不全)
001 1101(29) 性能拒絕
001 1111(31) 正常—未指定
類別010,資源不可用類:
010 0010(34) 無電路/通路可用
010 1010(42) 交換設備擁塞
類別011,業(yè)務或任選不可用類:
011 0010(50) 所請求的性能未預定
011 0101(53) CUG中限制去呼叫
011 0111(55) CUG中限制來呼叫
011 1001(57) 承載能力無權
011 1010(58) 承載能力目前不可用
類別100,業(yè)務或任選未實現類:
100 0001(65) 承載能力未實現
100 0101(69) 所請求的性能未實現
類別101,無效的消息(例如參數超出范圍)類:
101 0111(87) 被叫用戶不是CUG的成員
101 1000(88) 不兼容的目的地
101 1010(90) 不存在的CUG
101 1011(91) 無效的轉接網選擇
101 1111(95) 無效的消息,未指定
類別110,協議錯誤(例如未知的消息)類:
110 0001(97) 消息類型不存在或未實現
110 0011(99) 參數不存在或未實現
110 0110(102)定時器終了時恢復
110 0101(103)參數不存在或未實現—傳遞
110 1110(110)消息帶有未被識別的參數—舍棄
110 1111(111)協議錯誤,未指定
類別111,互通類:
111 1111(127)互通,未指定
類別1100、1101,平臺拒絕類:
1100 1010(202)用戶忙,MSRN獲取失敗,平臺掛機
1100 1011(203)用戶去活,平臺掛機
1100 1100(204)用戶在平臺側關機,平臺掛機
1100 1101(205)用戶未開戶,平臺掛機
1100 1110(206)小號不允許呼叫,平臺掛機
1100 1111(207)主號撥打小號,平臺掛機
1101 0001(209)主叫打小號帶原始被叫,平臺掛機
callrecording
string
錄音控制
M
同綁定接口定義
recordMode
string
錄音模式
0
1:主叫在左聲道
2:主叫在右聲道
3:混音
redirreason
string
呼轉原因
0
0000(0) 未知
0001(1) 用戶忙
0010(2) 無應答
0011(3) 無條件
0110(6) 移動用戶不可及
calldisplay
string
被叫來顯號碼
0
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
POST /v2/axb/finish HTTP/1.1
Connection: close
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
appkey: PRD-6-1-1472023876
msgdgt: D6433F8A7677D38FC47AAA522743BE92
ts: 20161213151618499
Content-Length: 484
Host: 192.168.110.196:10010
User-Agent: Apache-HttpClient/4.3.2 (java 1.5)
Accept-Encoding: gzip,deflate
{"releasetime":"2016-12-13 15:16:22","ringingtime":"2016-12-13 15:16:17","releasedir":"1","starttime":"2016-12-13 15:16:17","requestId":"1225472050","calltype":"10","telA":"1560000106","telB":"1560200106","telX":"1560100106","releasecause":"16","callid":"0405060000000000","recordMode":"1","calltime":"2016-12-13 15:16:17","callrecording":"1","recordUrl":"http://192.168.110.196:10010/record/14c8000700189afa_15920210324_18029169766_20160818101010.mp3","subid":"A102X0571X0000000002"}
HTTP/1.0 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 35
Server: Werkzeug/0.11.11 Python/2.7.11
Date: Tue, 13 Dec 2016 07:15:25 GMT
{"message": "success", "code": 200}
3.4 解綁推送
接口
POST {url}/v2/axb/unsub
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"subid": "100X571X0000000001"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
3.5被叫接通推送
接口
POST {url}/v2/axb/pickup
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
真實號碼為A
小號為X
對端號碼為B或者其它
callid
string
通話標識
M
業(yè)務參考號
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
3.6 被叫振鈴推送
接口
POST {url}/v2/axb/ring
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
真實號碼為A
小號為X
對端號碼為B或者其它
callid
string
通話標識
M
業(yè)務參考號
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
AX業(yè)務接口
1. AX綁定解綁接口
AX業(yè)務主要處理的請求和響應類型如下:
綁定
解綁
1.1 綁定請求和響應
接口
POST {url}/v2/ax/{xmode}
xmode取值:
mode101:APP自帶x號碼
mode102:平臺分配x號碼
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13900000000",
"telX": "13720056199",
"subts": "20150920190126",
"name": "張三",
"cardtype": "0",
"cardno": "363333199912221022",
"areacode": "10",
"expiration": "7200",
"remark": "derc",
"extra": {"callrecording": "0","calldisplay": "0","anucodecalled": "123","anucodecaller": "124","callunsub": "0","callpickup": "0"}
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
telX
string
小號號碼
0
X號碼;平臺分配號碼模式下,該參數可不帶,系統(tǒng)忽略該參數
subts
string
綁定時間
M
格式為yyyyMMddHHmmss。時間采用北京時間,24小時制。
areacode
string
區(qū)號
0
例如:北京(10);在平臺分配X號碼模式中,平臺從號碼池中分配該地區(qū)的X號碼,避免產生呼叫長途費。
expiration
string
過期時間
M
單位:秒, 自綁定時間開始后expiration秒自動解綁;0表示不限制時間,不會自動解綁
remark
string
接入商自有字段
0
接入商自有字段,不能超過30個字節(jié)
-callrecording
string
錄音控制
0
可選。M
僅下列值有效。默認是0(不開通錄音功能)。
0、好, :不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來顯控制
0
可選。M
僅下列值有效。默認是0(顯示真實號碼)。
0:顯示真實號碼
1:顯示X號碼
2: 顯示Z號碼池中的號碼
在綁定時可自由選擇是否分配Z號碼池的開關。
-anucodecalled
string
放音編碼
0
可選。
其他號碼撥打X時,給其他號碼的放音
不帶,不放音。
-anucodecaller
string
放音編碼
0
可選。
其他號碼撥打X時,給A的放音
不帶,不放音。
-callunsub
string
解綁推送消息控制
0
可選。
僅下列值有效。默認是0。
0 解綁不推送消息
1 解綁推送消息
-callpickup
string
被叫接通推送事件控制
0
可選。
僅下列值有效。默認是0。
0 不推送被叫接通事件
1 推送被叫接通事件
-ringpickup
string
被叫振鈴推送事件控制
0
可選。
僅下列值有效。默認是0。
0 不推送被叫振鈴事件
1 推送被叫振鈴事件
-callcontrol
string
被叫接通控制
0
可選。其他號碼呼叫X時,對來顯進行鑒權,僅下列值有效。默認是0。
0 不對來話號碼鑒權
1 對來話號碼鑒權
-callduration
string
通話持續(xù)時間
0
可選,單位秒,如果出現則通話有效時長為此值,如果沒有出現按現在默認處理
響應體
{
"code": "0",
"message": "success",
"data": { "subid": "100X571X0000000001", "telX": "13720056199"}
}
請求響應實例mode101:
POST /v2/ax/mode101 HTTP/1.0
X-Real-IP: 192.168.150.160
Host: localhost
X-Forwarded-For: 192.168.150.160
Connection: close
Content-Length: 213
Accept-Language: zh-cn
Accept: application/json;charset=utf-8
appkey: RR_0001
ts: 20161213133955424
msgdgt: 25F024C797A7791501D79E4196D6F6AF
Content-Type: application/json;charset=utf-8
{"cardtype":"0","telX":"15601000116","expiration":"30000","requestId":"1212331","extra":{},"name":"landy............","areacode":"671","cardno":"341281198909237626","subts":"20161213133955","telA":"13500000023"}
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
Date: Tue, 13 Dec 2016 05:39:55 GMT
Server: BSS/1.1
Content-Length: 90
Connection: close
{"code":0,"message":"SUCCESS","data":{"telX":"15601000116","subid":"A202X671X0000400028"}}
請求響應實例mode102:
POST /v2/ax/mode102 HTTP/1.0
X-Real-IP: 192.168.150.160
Host: localhost
X-Forwarded-For: 192.168.150.160
Connection: close
Content-Length: 202
Accept-Language: zh-cn
Accept: application/json;charset=utf-8
appkey: RT_0001
ts: 20161213134329178
msgdgt: 1D2EC9FAC88FE07A276A1F92BF8F83F3
Content-Type: application/json;charset=utf-8
{"cardtype":"0","telX":"1234678900898","expiration":"30000","requestId":"1212324","extra":{},"name":"mary","areacode":"672","cardno":"341281199809234625","subts":"20161213134329","telA":"13500000017"}
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
Date: Tue, 13 Dec 2016 05:43:29 GMT
Server: BSS/1.1
Content-Length: 90
Connection: close
{"code":0,"message":"SUCCESS","data":{"telX":"15601000118","subid":"A204X672X0000400029"}}
1.2 解綁請求和響應
接口
DELETE {url}/v2/ax/{subid}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
DELETE /v2/ax/A204X672X0000400029 HTTP/1.0
X-Real-IP: 192.168.150.160
Host: localhost
X-Forwarded-For: 192.168.150.160
Connection: close
Content-Length: 0
Accept-Language: zh-cn
Accept: application/json;charset=utf-8
appkey: RT_0001
ts: 20161213134921749
msgdgt: B7E6D788450DB145016BD9ED67A5A7EA
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
Date: Tue, 13 Dec 2016 05:49:21 GMT
Server: BSS/1.1
Content-Length: 30
Connection: close
{"code":0,"message":"SUCCESS"}
2. AX業(yè)務設置接口
AX業(yè)務設置的請求和響應類型如下:
2.1 在線語音主叫請求和響應
接口
PUT {url}/v2/ax/onlinecall/{subid}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telB": "13720056198"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
PUT /v2/ax/onlinecall/15601000116 HTTP/1.0
X-Real-IP: 192.168.150.160
Host: localhost
X-Forwarded-For: 192.168.150.160
Connection: close
Content-Length: 46
Accept-Language: zh-cn
Accept: application/json;charset=utf-8
appkey: RR_0001
ts: 20161213135904517
msgdgt: 9C3C2D47B095EBEEFC41664ACAA10E72
Content-Type: application/json;charset=utf-8
{"requestId":"1234504","telB":"15600000005"}
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
Date: Tue, 13 Dec 2016 05:59:04 GMT
Server: BSS/1.1
Content-Length: 30
Connection: close
{"code":0,"message":"SUCCESS"}
2.2 綁定更新請求和響應
接口
PUT {url}/v2/ax/{subid}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13900000000",
"subts": "20150920190126",
"name": "張三",
"cardtype": "0",
"cardno": "363333199912221022",
"expiration": "7200",
"extra": {"callrecording": "0","calldisplay": "0","anucodecalled": "123"}
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
telA
string
真實號碼
0
不帶此參數,表示只更新其他屬性
subts
string
綁定時間
M
格式為yyyyMMddHHmmss。時間采用北京時間,24小時制。
expiration
string
過期時間
0
單位:秒, 自綁定時間開始后expiration秒自動解綁;0表示不限制時間,不會自動解綁
callrecording
string
錄音控制
0
可選。M
僅下列值有效。默認是0(不開通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
calldisplay
string
來顯控制
0
可選。M
僅下列值有效。默認是0(顯示真實號碼)。
0:顯示真實號碼
1:顯示X號碼
2: 顯示Z號碼池中的號碼
在綁定時可自由選擇是否分配Z號碼池的開關。
anucodecalled
string
放音編碼
0
可選。
其他號碼撥打X時給其他號碼的放音
不帶,不放音。
響應體
{
"code": "0",
"message": "success"
}
2.3 綁定查詢請求和響應
接口
GET {url}/v2/ax/subid/{subid}
GET {url}/v2/ax/telX/{telX}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應體
{
"code": "0",
"message": "success",
"data": {
"telA": "13900000000",
"telX": "13720056199",
"subts": "20150920190126",
"subid": "100X571X0000000001",
"name": "張三",
"cardtype": "0",
"cardno": "363333199912221022",
"expiration": "7200",
"extra": {"callrecording": "0","calldisplay": "0" ,"anucodecalled": "123"}
}
}
telX
string
隱私號碼
0
X號碼;平臺分配號碼模式下,該參數可不帶,系統(tǒng)忽略該參數
subts
string
綁定時間
M
格式為yyyyMMddHHmmss。時間采用北京時間,24小時制。
areacode
string
區(qū)號
0
例如:北京(10);在平臺分配X號碼模式中,平臺從號碼池中分配該地區(qū)的X號碼,避免產生呼叫長途費。
expiration
string
過期時間
M
單位:秒, 自綁定時間開始后expiration秒自動解綁;0表示不限制時間,不會自動解綁
callrecording
string
錄音控制
0
可選。M
僅下列值有效。默認是0(不開通錄音功能)。
0:不錄音
1:接通后錄音
calldisplay
string
來顯控制
0
可選。M
僅下列值有效。默認是0(顯示真實號碼)。
0:顯示真實號碼
1:顯示X號碼
2: 顯示Z號碼池中的號碼
在綁定時可自由選擇是否分配Z號碼池的開關。
anucodecalled
string
放音編碼
0
可選。
其他號碼撥打X時給其他號碼的放音
不帶,不放音。
3. AX業(yè)務推送接口
3.1 code返回碼定義
第三方APP返回碼:
401
認證未通過
推送的來源或者推送的簽名未通過校驗。
3.2 呼叫起始推送
接口
POST {url}/v2/ax/callin
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"subid": "100X571X0000000001",
"calltype": "10",
"calltime": "2016-11-03 20:22:20",
"callid":"14c821340104058b",
"calrecording": "0",
"telZ": "13720056196",
"smscnt": "1"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AX業(yè)務:(Bit7=0時為傳統(tǒng)CS方式,Bit7=1時為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實號碼為A
小號為X
calltime
string
通話開始時間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標識
M
唯一關聯標識
callrecording
string
錄音控制
M
同綁定接口定義
telZ
string
Z號碼
M
默認為空。在綁定請求中設置了來顯為Z號碼時,該值為顯示的Z號碼。
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
參考AXB業(yè)務呼叫起始推送。
3.3 呼叫結束推送
接口
POST {url}/v2/ax/finish
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"subid": "100X571X0000000001",
"calltype": "1",
"calltime": "2016-11-03 20:22:20",
"ringingtime": "2016-11-03 20:22:20",
"starttime": "2016-11-03 20:22:20",
"releasetime": "2016-11-03 20:22:20",
"callid": "14c821340104058b",
"releasedir": "1",
"releasecause": "1",
"callrecording": "0",
"recordUrl": "http://101.12.12.123:12000/record/ALPT_1234_14c8546501234567_18600000000_13800000000_20161204070000.mp3",
"recordMode": "2",
"telZ": "13720056196",
"userkey": "1234"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AX業(yè)務:(Bit7=0時為傳統(tǒng)CS方式,Bit7=1時為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實號碼為A
小號為X
calltime
string
通話開始時間
M
格式: yyyy-MM-dd HH:mm:ss
ringingtime
string
振鈴開始時間
M
格式: yyyy-MM-dd HH:mm:ss
starttime
string
通話開始時間
M
格式: yyyy-MM-dd HH:mm:ss
releasetime
string
通話結束時間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標識
M
業(yè)務參考號
releasedir
string
釋放方向
M
1 表示主叫,
2 表示被叫,
0 表示平臺釋放
releasecause
string
釋放原因
M
000 0001(1) 未分配的號碼
000 0010(2) 無路由到指定的轉接網
000 0011(3) 無路由到目的地
000 0100(4) 發(fā)送專用信息音
001 0000(16) 正常的呼叫拆線
001 0001(17) 用戶忙
001 0010(18) 用戶未響應
001 0011(19) 用戶未應答
001 0100(20) 用戶缺席
001 0101(21) 呼叫拒收
001 0110(22) 號碼改變
001 1011(27) 目的地不可達
001 1100(28) 無效的號碼格式(地址不全)
001 1101(29) 性能拒絕
001 1111(31) 正常—未指定
類別010,資源不可用類:
010 0010(34) 無電路/通路可用
010 1010(42) 交換設備擁塞
類別011,業(yè)務或任選不可用類:
011 0010(50) 所請求的性能未預定
011 0101(53) CUG中限制去呼叫
011 0111(55) CUG中限制來呼叫
011 1001(57) 承載能力無權
011 1010(58) 承載能力目前不可用
類別100,業(yè)務或任選未實現類:
100 0001(65) 承載能力未實現
100 0101(69) 所請求的性能未實現
類別101,無效的消息(例如參數超出范圍)類:
101 0111(87) 被叫用戶不是CUG的成員
101 1000(88) 不兼容的目的地
101 1010(90) 不存在的CUG
101 1011(91) 無效的轉接網選擇
101 1111(95) 無效的消息,未指定
類別110,協議錯誤(例如未知的消息)類:
110 0001(97) 消息類型不存在或未實現
110 0011(99) 參數不存在或未實現
110 0110(102)定時器終了時恢復
110 0101(103)參數不存在或未實現—傳遞
110 1110(110)消息帶有未被識別的參數—舍棄
110 1111(111)協議錯誤,未指定
類別111,互通類:
111 1111(127)互通,未指定
類別1100、1101,平臺拒絕類:
1100 1010(202)用戶忙,MSRN獲取失敗,平臺掛機
1100 1011(203)用戶去活,平臺掛機
1100 1100(204)用戶在平臺側關機,平臺掛機
1100 1101(205)用戶未開戶,平臺掛機
1100 1110(206)小號不允許呼叫,平臺掛機
1100 1111(207)主號撥打小號,平臺掛機
1101 0001(209)主叫打小號帶原始被叫,平臺掛機
callrecording
string
錄音控制
M
同綁定接口定義
recordMode
string
錄音模式
0
1:主叫在左聲道
2:主叫在右聲道
3:混音
telZ
string
Z號碼
0
在綁定請求中設置了來顯為Z號碼時,該值為顯示的Z號碼。
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
參考AXB業(yè)務呼叫結束推送。
3.4解綁推送
接口
POST {url}/v2/ax/unsub
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"subid": "100X571X0000000001"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
3.5 被叫接通推送
接口
POST {url}/v2/ax/pickup
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"subid": "100X571X0000000001",
"calltype": "1",
"callid": "14c821340104058b",
"callrecording": "0"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AX業(yè)務:(Bit7=0時為傳統(tǒng)CS方式,Bit7=1時為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實號碼為A
小號為X
callid
string
通話標識
M
業(yè)務參考號
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
3.6 被叫振鈴推送
接口
POST {url}/v2/ax/ring
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"subid": "100X571X0000000001",
"calltype": "1",
"callid": "14c821340104058b",
"callrecording": "0"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AX業(yè)務:(Bit7=0時為傳統(tǒng)CS方式,Bit7=1時為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實號碼為A
小號為X
callid
string
通話標識
M
業(yè)務參考號
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
AXN業(yè)務接口
1. AXN綁定解綁接口
AXN業(yè)務主要處理的請求和響應類型如下:
綁定
解綁
1.1 綁定請求和響應
接口
POST {url}/v2/axn/{xmode}
xmode取值:
mode101:APP自帶x號碼
mode102:平臺分配x號碼
請求體
{
"requestId": "1234567890",
"telA": "13900000000",
"telX": "13720056199",
"telB": "13005711234",
"subts": "20150920190126",
"anucode": "1,2,3",
"areacode": "10",
"expiration": "7200",
"remark": "derc",
"extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1","calldisplayshow": "0","callunsub": "0","callpickup": "0"
}
}
appkey
string/header
應用id
M
ts
string/header
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
telX
string
小號號碼
0
101模式填該字段,102模式不填
subts
string
綁定時間
M
格式為yyyyMMddHHmmss。時間采用北京時間,24小時制。
anucode
放音編碼
M
AXB業(yè)務時必須設置。
放音編碼必須包含3個場景的編碼。按照“B->X,A->X,其他號碼->X”的順序填寫編碼,編碼之間以逗號分隔。
比如:“1,2,3”表示 B->X 放音編號為 1,A->X 放音編號為 2,其他號碼->X 放音編號為 3。
areacode
string
區(qū)號
0
例如:北京(10);在平臺分配X號碼模式中,平臺從號碼池中分配該地區(qū)的X號碼,避免產生呼叫長途費。101模式不填該字段,102模式需要填
expiration
string
過期時間
M
單位:秒, 自綁定時間開始后expiration秒自動解綁;0表示不限制時間,不會自動解綁
remark
string
接入商自有字段
0
接入商自有字段,不能超過30個字節(jié)
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認是0(不開通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來顯控制
0
可選。 針對AXB中的A或者B作為主叫時,是否在被叫上顯示來話的真實號碼。默認為0(不顯示真實號碼)。
0:不顯示真實號碼
1:顯示真實號碼
-callrestrict
string
呼叫控制
0
可選。
僅下列值有效。默認是1。
0 AXB不做呼叫控制,A和B(N)均有權限,即為現有的AXN模式
1 AXB做呼叫控制,A和B有權限,其他號碼無權限,即為現有的AXB
2 AXB的單通控制,A無權限,B有權限,其他號碼無權限
3 AXB的單通控制,A有權限,B以及其他號碼無權限
4 AXN的單通控制,A無權限,B以及其他號碼有權限
5 AXN的單通控制,A有權限,B以及其他號碼無權限
6?均無權限
-calldisplayshow
string
推送被叫來顯號碼控制
0
可選。
僅下列值有效。默認是0。
0 推送中不攜帶被叫來顯號碼
1 推送中攜帶被叫來顯號碼
-callunsub
string
解綁推送消息控制
0
可選。
僅下列值有效。默認是0。
0 解綁不推送消息
1 解綁推送消息
-ringpickup
string
被叫振鈴推送事件控制
0
可選。
僅下列值有效。默認是0。
0 不推送被叫振鈴事件
1 推送被叫振鈴事件
-callpickup
string
被叫接通推送事件控制
0
可選。
僅下列值有效。默認是0。
0 不推送被叫接通事件
1 推送被叫接通事件
-callcontrol
string
被叫接通控制
0
可選。其他號碼呼叫X時,對來顯進行鑒權,僅下列值有效。默認是0。
0 不對來話號碼鑒權
1 對來話號碼鑒權
-callduration
string
通話持續(xù)時間
0
可選,單位秒,如果出現則通話有效時長為此值,如果沒有出現按現在默認處理。
響應體
{
"code": "0",
"message": "success",
"data": { "subid": "100X571X0000000001", "telX": "13720056199"}
}
1.2 解綁請求和響應
接口
DELETE {url}/v2/axn/{subid}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string/header
應用id
M
ts
string/header
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
響應體
{
"code": "0",
"message": "success"
}
2. AXN業(yè)務設置接口
2.1 綁定更新請求和響應
接口
PUT {url}/v2/axn/{subid}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13900000000",
"telB": "13005711234",
"subts": "20150920190126",
"anucode": "1,2,3",
"expiration": "7200",
"extra": { "callrecording": "0","calldisplay": "0,0"
}
}
appkey
string/header
應用id
M
請求和綁定時的appkey必須一致;
ts
string/header
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
telA
string
真實號碼
0
telA,telB不允許同時更新
telB
string
對端號碼
0
telA,telB不允許同時更新
subts
string
綁定時間
M
格式為yyyyMMddHHmmss。時間采用北京時間,24小時制。
anucode
放音編碼
0
AXB業(yè)務時必須設置。
放音編碼必須包含3個場景的編碼。按照“A->X,B->X,其他號碼->X”的順序填寫編碼,編碼之間以逗號分隔。
比如:“1,2,3”表示A->X放音編號為1, B->X放音編號為2, 其他號碼->X放音編號為3。
expiration
string
過期時間
0
單位:秒, 自綁定時間開始后expiration秒自動解綁;0表示不限制時間,不會自動解綁
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認是0(不開通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來顯控制
0
可選。 針對AXB中的A或者B作為主叫時,是否在被叫上顯示來話的真實號碼。默認為0(不顯示真實號碼)。
0:不顯示真實號碼
1:顯示真實號碼
來顯控制按照“A->B時B上的顯示,B(N)->A時在A上的顯示”的順序填寫編碼,編碼之間以逗號分隔?!捌渌柎a”的來顯控制,同B(N)設置。
場景
A -> B
B(N)-> A
calldisplay
(1)
A 顯示為X
B(N)顯示為X
“0,0”
(2)
A 顯示為X
B(N)顯示為B(N)
“0,1”
(3)
A 顯示為A
B(N)顯示為X
“1,0”
(4)
A 顯示為A
B(N)顯示為B(N)
“1,1”
響應體
{
"code": "0",
"message": "success"
}
2.2 AXN查詢請求和響應
接口
GET?{url}/v2/axn/subid/{subid}
GET?{url}/v2/axn/telx/{telX}
GET?{url}/v2/axn/tela/{telA}
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應體
如果有多個AXN的綁定關系,則出現多個object結構(array格式)
參數說明請參考綁定請求和響應。
{
"code": "0",
"message": "success",
"data": {
"telA": "13900000000",
"telX": "13720056199",
"telB": "13005711234",
"subts": "20150920190126",
"subid": "100X571X0000000001",
"anucode": "1,2,3",
"areacode": "10",
"expiration": "7200",
"extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1" ,"calldisplayshow": "0"}
}
}
3 AXN業(yè)務推送接口
3.1 呼叫起始推送
接口
POST {url}/v2/axn/callin
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"calltime": "2016-11-03 20:22:20",
"callid":"14c821340104058b",
"callrecording": "0",
"calldisplay": "13720056197",
"smscnt": "1"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
remark
string
接入商自有字段
0
接入商自有字段,在綁定請求攜帶過來,不能超過30個字節(jié)
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
31:轉接短信
真實號碼為A
小號為X
對端號碼為B或者其它
calltime
string
發(fā)起呼叫時間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標識
M
唯一關聯標識
callrecording
string
錄音控制
M
同綁定接口定義
calldisplay
string
被叫來顯號碼
0
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
POST /v2/axn/callin HTTP/1.1
Connection: close
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
appkey: PRD-6-1-1472023876
msgdgt: 94872E3BA9A418E045911A7446201A6F
ts: 20161213151618497
Content-Length: 214
Host: 192.168.110.196:10010
User-Agent: Apache-HttpClient/4.3.2 (java 1.5)
Accept-Encoding: gzip,deflate
{"telX":"1560100106","callid":"0102030000000000","calltype":"10","requestId":"1119897972","calltime":"2016-12-13 15:16:17","callrecording":"1","telA":"1560000106","subid":"A102X0571X0000000002","telB":"1560200106"}
HTTP/1.0 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 35
Server: Werkzeug/0.11.11 Python/2.7.11
Date: Tue, 13 Dec 2016 07:15:25 GMT
{"message": "success", "code": 200}
3.2 呼叫結束推送
接口
POST {url}/v2/axn/finish
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"calltime": "2016-11-03 20:22:20",
"ringingtime": "2016-11-03 20:22:20",
"starttime": "2016-11-03 20:22:20",
"releasetime": "2016-11-03 20:22:20",
"callid": "14c821340104058b",
"releasedir": "1",
"releasecause": "1",
"callrecording": "0",
"recordUrl": "http://101.12.12.123:12000/record/ALPT_1234_14c8546501234567_18600000000_13800000000_20161204070000.mp3",
"recordMode": "2",
"telredir": "13720056197",
"redirreason": "1",
"calldisplay": "13720056195"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
真實號碼為A
小號為X
對端號碼為B或者其它
calltime
string
發(fā)起呼叫時間
M
格式: yyyy-MM-dd HH:mm:ss
ringingtime
string
振鈴開始時間
M
格式: yyyy-MM-dd HH:mm:ss
starttime
string
通話開始時間
M
格式: yyyy-MM-dd HH:mm:ss
releasetime
string
通話結束時間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標識
M
業(yè)務參考號
releasedir
string
釋放方向
M
1 表示主叫,
2 表示被叫,
0 表示平臺釋放
releasecause
string
釋放原因
M
000 0001(1) 未分配的號碼
000 0010(2) 無路由到指定的轉接網
000 0011(3) 無路由到目的地
000 0100(4) 發(fā)送專用信息音
001 0000(16) 正常的呼叫拆線
001 0001(17) 用戶忙
001 0010(18) 用戶未響應
001 0011(19) 用戶未應答
001 0100(20) 用戶缺席
001 0101(21) 呼叫拒收
001 0110(22) 號碼改變
001 1011(27) 目的地不可達
001 1100(28) 無效的號碼格式(地址不全)
001 1101(29) 性能拒絕
001 1111(31) 正?!粗付?br/>
類別010,資源不可用類:
010 0010(34) 無電路/通路可用
010 1010(42) 交換設備擁塞
類別011,業(yè)務或任選不可用類:
011 0010(50) 所請求的性能未預定
011 0101(53) CUG中限制去呼叫
011 0111(55) CUG中限制來呼叫
011 1001(57) 承載能力無權
011 1010(58) 承載能力目前不可用
類別100,業(yè)務或任選未實現類:
100 0001(65) 承載能力未實現
100 0101(69) 所請求的性能未實現
類別101,無效的消息(例如參數超出范圍)類:
101 0111(87) 被叫用戶不是CUG的成員
101 1000(88) 不兼容的目的地
101 1010(90) 不存在的CUG
101 1011(91) 無效的轉接網選擇
101 1111(95) 無效的消息,未指定
類別110,協議錯誤(例如未知的消息)類:
110 0001(97) 消息類型不存在或未實現
110 0011(99) 參數不存在或未實現
110 0110(102)定時器終了時恢復
110 0101(103)參數不存在或未實現—傳遞
110 1110(110)消息帶有未被識別的參數—舍棄
110 1111(111)協議錯誤,未指定
類別111,互通類:
111 1111(127)互通,未指定
類別1100、1101,平臺拒絕類:
1100 1010(202)用戶忙,MSRN獲取失敗,平臺掛機
1100 1011(203)用戶去活,平臺掛機
1100 1100(204)用戶在平臺側關機,平臺掛機
1100 1101(205)用戶未開戶,平臺掛機
1100 1110(206)小號不允許呼叫,平臺掛機
1100 1111(207)主號撥打小號,平臺掛機
1101 0001(209)主叫打小號帶原始被叫,平臺掛機
callrecording
string
錄音控制
M
同綁定接口定義
recordMode
string
錄音模式
0
1:主叫在左聲道
2:主叫在右聲道
3:混音
redirreason
string
呼轉原因
0
0000(0) 未知
0001(1) 用戶忙
0010(2) 無應答
0011(3) 無條件
0110(6) 移動用戶不可及
calldisplay
string
被叫來顯號碼
0
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
請求響應實例:
POST /v2/axn/finish HTTP/1.1
Connection: close
Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8
appkey: PRD-6-1-1472023876
msgdgt: D6433F8A7677D38FC47AAA522743BE92
ts: 20161213151618499
Content-Length: 484
Host: 192.168.110.196:10010
User-Agent: Apache-HttpClient/4.3.2 (java 1.5)
Accept-Encoding: gzip,deflate
{"releasetime":"2016-12-13 15:16:22","ringingtime":"2016-12-13 15:16:17","releasedir":"1","starttime":"2016-12-13 15:16:17","requestId":"1225472050","calltype":"10","telA":"1560000106","telB":"1560200106","telX":"1560100106","releasecause":"16","callid":"0405060000000000","recordMode":"1","calltime":"2016-12-13 15:16:17","callrecording":"1","recordUrl":"http://192.168.110.196:10010/record/14c8000700189afa_15920210324_18029169766_20160818101010.mp3","subid":"A102X0571X0000000002"}
HTTP/1.0 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 35
Server: Werkzeug/0.11.11 Python/2.7.11
Date: Tue, 13 Dec 2016 07:15:25 GMT
{"message": "success", "code": 200}
3.3 解綁推送
接口
POST {url}/v2/axn/unsub
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"subid": "100X571X0000000001"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
3.4 被叫接通推送
接口
POST {url}/v2/axn/pickup
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
真實號碼為A
小號為X
對端號碼為B或者其它
callid
string
通話標識
M
業(yè)務參考號
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}
3.5 被叫振鈴推送
接口
POST {url}/v2/axn/ring
請求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
ts
string
業(yè)務時間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時間采用北京時間,24小時制,精確至毫秒,不能與當前標準時間相差超過5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務id
M
消息請求標識
calltype
string
呼叫類型
M
AXB業(yè)務:(針對被保護號碼A來分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開戶不允許
126: 雙呼
真實號碼為A
小號為X
對端號碼為B或者其它
callid
string
通話標識
M
業(yè)務參考號
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請求中攜帶,則響應中返回
響應體
{
"code": "0",
"message": "success"
}