您使用本服務(wù)應(yīng)當(dāng)閱讀并遵守《中國(guó)東信通信能力技術(shù)服務(wù)協(xié)議》及本服務(wù)條款(中國(guó)東信即中國(guó)—東盟信息港股份有限公司,以下簡(jiǎn)稱東信)。如遇《中國(guó)東信通信能力技術(shù)服務(wù)協(xié)議》與本服務(wù)條款不一致之處,優(yōu)先適用本服務(wù)條款。在滿足前述條件及東信規(guī)定的隱私號(hào)技術(shù)服務(wù)其他準(zhǔn)入條件、提交相關(guān)資料后,經(jīng)東信同意后開(kāi)通隱私號(hào)技術(shù)服務(wù),方可成為隱私號(hào)服務(wù)開(kāi)發(fā)者。無(wú)論是否實(shí)際閱讀本協(xié)議,您通過(guò)網(wǎng)絡(luò)頁(yè)面點(diǎn)擊確認(rèn)本條款或?qū)嶋H使用隱私號(hào)技術(shù)服務(wù),均表示您與東信及服務(wù)提供方廣西東信易通科技有限公司已就本條款達(dá)成一致并同意接受本條款的全部約定內(nèi)容。
第一條 定義
1.1 號(hào)碼隱私保護(hù)服務(wù)(以下簡(jiǎn)稱本服務(wù)):指易通與基礎(chǔ)電信運(yùn)營(yíng)商合作為用戶提供的隱私保護(hù)服務(wù),基礎(chǔ)運(yùn)營(yíng)商為用戶提供一個(gè)臨時(shí)號(hào)碼(以下簡(jiǎn)稱小號(hào)),并將該小號(hào)與用戶常用手機(jī)號(hào)碼進(jìn)行綁定,實(shí)現(xiàn)通過(guò)該小號(hào)接聽(tīng)電話的功能。易通提供小號(hào)使用過(guò)程查詢及綁定關(guān)系管理的API接口服務(wù)。
1.2 號(hào)碼:指本服務(wù)中用于實(shí)現(xiàn)隱私保護(hù)的碼號(hào),包括但不限于11位手機(jī)號(hào)碼、95擴(kuò)位號(hào)碼等。用戶使用本服務(wù)無(wú)須實(shí)體SIM卡,服務(wù)到期用戶也無(wú)須辦理銷(xiāo)戶手續(xù)。
1.3 API接口:易通向用戶提供的接口,用戶通過(guò)接口獲得易通小號(hào)隱私保護(hù)服務(wù)能力,并基于該接口和能力自行開(kāi)發(fā)和利用實(shí)現(xiàn)特定目的。
第二條 開(kāi)通服務(wù)
您應(yīng)按照本網(wǎng)站載明的號(hào)碼隱私保護(hù)業(yè)務(wù)權(quán)限申請(qǐng)要求提交信息,并對(duì)提交信息的真實(shí)性、合法性、有效性獨(dú)立承擔(dān)全部責(zé)任;易通有權(quán)根據(jù)您的信息進(jìn)行綜合判斷,并保留決定您是否符合權(quán)限開(kāi)通要求的權(quán)利
第三條 服務(wù)內(nèi)容
3.1 易通向您提供API技術(shù)服務(wù)接口,您使用易通接口調(diào)用能力在業(yè)務(wù)場(chǎng)景中實(shí)現(xiàn)保護(hù)其用戶隱私的目的。
3.2 您通過(guò)本服務(wù)訂購(gòu)的號(hào)碼可用于且僅可用于為您于網(wǎng)站填寫(xiě)的業(yè)務(wù)場(chǎng)景及用途(以下簡(jiǎn)稱“約定業(yè)務(wù)”)的用戶提供隱私保護(hù)服務(wù)。如需擴(kuò)展業(yè)務(wù)場(chǎng)景您應(yīng)另行提交申請(qǐng),經(jīng)易通同意后方可提供。舉例說(shuō)明:
AXB:
(1)假設(shè)用戶王某號(hào)碼為A,用戶張某號(hào)碼為B,易通為用戶王某和張某提供一個(gè)臨時(shí)號(hào)碼X,并將號(hào)碼A與號(hào)碼B進(jìn)行綁定,形成AXB關(guān)系。
(2)當(dāng)王某撥打號(hào)碼X時(shí),即可接通張某號(hào)碼B;當(dāng)張某撥打號(hào)碼X時(shí),即可接通王某號(hào)碼A。王某和張某的來(lái)電顯示均是X。
(3)其他號(hào)碼撥打X時(shí),系統(tǒng)自動(dòng)阻攔,將無(wú)法接通。
AXN:
(1)假設(shè)用戶王某號(hào)碼為A,易通為用戶王某提供一個(gè)臨時(shí)號(hào)碼X,并將號(hào)碼A與X進(jìn)行綁定,形成AXN關(guān)系。
(2)當(dāng)其他人撥打號(hào)碼X,即可接通王某號(hào)碼A。
錄音:
易通通信為客戶提供AXB、AXN過(guò)程錄音的服務(wù)能力;客戶可以根據(jù)自己需求開(kāi)通此增值服務(wù),客戶在使用此服務(wù)需要遵守錄音使用規(guī)范。
(1)錄音可用于且僅可用于對(duì)通話過(guò)程中服務(wù)質(zhì)量監(jiān)控,同時(shí)需要在網(wǎng)站或app醒目位置提醒用戶“為了保證服務(wù)質(zhì)量,您的通話過(guò)程會(huì)被錄音”等提示性語(yǔ)句。
(2)您有義務(wù)在法律規(guī)定范圍內(nèi)對(duì)發(fā)送的錄音文件或文本做安全審核。文件或文本內(nèi)容不得包含違反國(guó)家法律法規(guī)、反黨反政府反社會(huì)主義、色情、損壞安定團(tuán)結(jié)社會(huì)的內(nèi)容。由于您審核責(zé)任造成以上內(nèi)容被播放所產(chǎn)生的法律責(zé)任全部由您負(fù)責(zé)。
3.3 易通通過(guò)技術(shù)手段,通過(guò)小號(hào)與常用號(hào)碼的綁定關(guān)系實(shí)現(xiàn)主叫、被叫時(shí)對(duì)用戶常用號(hào)碼的隱藏保護(hù)。同時(shí),易通根據(jù)您的需求實(shí)現(xiàn)小號(hào)的分配、綁定和解綁,解綁后將無(wú)法通過(guò)該小號(hào)聯(lián)系。
3.4 在您提供營(yíng)業(yè)執(zhí)照副本等開(kāi)戶資料并經(jīng)易通審核通過(guò)后,您將作為使用小號(hào)號(hào)碼的企業(yè)用戶獲得在協(xié)議期間內(nèi)、按照約定用途的小號(hào)使用權(quán),同時(shí)您應(yīng)對(duì)所有使用的小號(hào)號(hào)碼承擔(dān)責(zé)任。
3.5 應(yīng)國(guó)家實(shí)名制要求,您需記錄使用小號(hào)用戶的真實(shí)身份信息,包括但不限于姓名、身份證號(hào)碼、手機(jī)號(hào)碼等,并將前述信息同步提供給易通。
第四條 費(fèi)用
易通有權(quán)制定本服務(wù)的費(fèi)用標(biāo)準(zhǔn)及收費(fèi)規(guī)則并公示于網(wǎng)站上,并有權(quán)隨時(shí)做出變更,亦可通過(guò)書(shū)面方式與您對(duì)費(fèi)用標(biāo)準(zhǔn)及收費(fèi)規(guī)則進(jìn)行變更(如與網(wǎng)站不一致,以書(shū)面約定為準(zhǔn)),您使用本服務(wù)即意味著您接受該費(fèi)用,并同意易通有權(quán)單方判斷和決定您所使用的具體服務(wù)的類型及適用資費(fèi),如您不同意公布或變更的費(fèi)用標(biāo)準(zhǔn)應(yīng)立即停止使用本服務(wù),否則使用或繼續(xù)使用將被視為您同意接受費(fèi)用標(biāo)準(zhǔn)。
第五條 服務(wù)使用規(guī)范
5.1 您保證訂購(gòu)的小號(hào)僅用于約定業(yè)務(wù)中用戶的隱私保護(hù),超出該范圍使用小號(hào)的,易通有權(quán)停止服務(wù),因此導(dǎo)致易通被國(guó)家機(jī)關(guān)、運(yùn)營(yíng)商、用戶等其他第三方追究責(zé)任或產(chǎn)生損失的,您應(yīng)當(dāng)予以賠償。
5.2 易通向您提供API接口,您通過(guò)調(diào)用易通API接口實(shí)現(xiàn)向易通訂購(gòu)小號(hào),并由易通提供技術(shù)服務(wù)以實(shí)現(xiàn)在訂購(gòu)期(即您對(duì)小號(hào)與用戶常用號(hào)碼每次綁定至解綁的時(shí)段)內(nèi)您的用戶使用訂購(gòu)的小號(hào)撥打及接聽(tīng)電話的功能。通過(guò)調(diào)用API接口來(lái)做小號(hào)的訂購(gòu),每購(gòu)買(mǎi)成功一個(gè)新號(hào)碼計(jì)為使用一個(gè)號(hào)碼。在一個(gè)計(jì)費(fèi)周期內(nèi)(一個(gè)自然月)解綁后將原小號(hào)綁定到用戶新的常用號(hào)碼上,此次綁定不作為使用新號(hào)碼計(jì)算
5.3 易通為您提供小號(hào)購(gòu)買(mǎi)、綁定狀態(tài)查詢的管理后臺(tái),您可以在遵循業(yè)務(wù)規(guī)則自行配置使用小號(hào)。
5.4 東信為您使用隱私號(hào)平臺(tái)服務(wù)提供咨詢和服務(wù)支撐,服務(wù)期間提供在線客服的咨詢服務(wù)支持(工作日:早9:00—晚20:00)。
5.5 易通僅提供應(yīng)用程序接口,您應(yīng)自行編寫(xiě)程序以調(diào)用小號(hào)服務(wù),易通不對(duì)您的編程過(guò)程或程序應(yīng)用結(jié)果承擔(dān)任何責(zé)任。
5.6 易通提供的小號(hào)號(hào)碼為隨機(jī)號(hào)碼,每個(gè)號(hào)碼訂購(gòu)期結(jié)束后即收回。
5.7 您不得將易通提供的服務(wù)以任何方式向您用戶或其他第三方進(jìn)行出售或進(jìn)行任何利益交換,不得將本協(xié)議的全部或部分轉(zhuǎn)讓給第三方,否則易通有權(quán)解除本協(xié)議;但第三方為您關(guān)聯(lián)公司的情形除外。
5.8 在本協(xié)議有效期內(nèi),您對(duì)所訂購(gòu)的小號(hào)一切行為承擔(dān)全部責(zé)任,如因您或您用戶使用本服務(wù)的行為導(dǎo)致易通為此承擔(dān)了相關(guān)的責(zé)任,您需全額賠償易通的相關(guān)支出及損失,包括但不限于律師費(fèi)用、訴訟費(fèi)等。
5.9 您按照本協(xié)議約定使用易通服務(wù)向您用戶提供隱私保護(hù)服務(wù),應(yīng)當(dāng)取得用戶的同意,并由您自行承擔(dān)權(quán)利義務(wù)和責(zé)任,易通對(duì)于您與您用戶之間關(guān)于使用您提供服務(wù)的相關(guān)權(quán)利義務(wù)和糾紛不承擔(dān)責(zé)任。
5.10 您理解并應(yīng)向您用戶提醒,為保證碼號(hào)資源的合理有效利用,通過(guò)本服務(wù)獲得的小號(hào)可能是易通在其他用戶停止使用并經(jīng)過(guò)一定期間后收回的號(hào)碼,小號(hào)本身不提供短信發(fā)送功能。
5.11 您使用本服務(wù)的同時(shí)保證遵循易通小號(hào)產(chǎn)品的規(guī)則規(guī)范。
5.12 在使用易通API時(shí),您不應(yīng)有如下行為:
(1)修改、翻譯、改編、出租、轉(zhuǎn)許可、在信息網(wǎng)絡(luò)上傳播或轉(zhuǎn)讓易通提供的應(yīng)用接口,也不得逆向工程、反編譯或試圖以其他方式發(fā)現(xiàn)易通提供的應(yīng)用接口的源代碼(除易通明示許可外);
(2)進(jìn)行任何破壞或試圖破壞網(wǎng)絡(luò)安全的行為(包括但不限于釣魚(yú),黑客,網(wǎng)絡(luò)詐騙,網(wǎng)站或空間中含有或涉嫌散播:病毒、木馬、惡意代碼,及通過(guò)虛擬服務(wù)器對(duì)其他網(wǎng)站、服務(wù)器進(jìn)行涉嫌攻擊行為如掃描、嗅探、ARP欺騙、DOS等);
(3)進(jìn)行任何改變或試圖改變易通提供的系統(tǒng)配置或破壞系統(tǒng)安全的行為;
(4)未按照本協(xié)議以及易通就API在相關(guān)頁(yè)面上展示的規(guī)定、公告內(nèi)容的行為,或侵犯易通及第三方的權(quán)利的行為;
(5)其它任何違反相關(guān)法律法規(guī)的行為。
5.13 您同意,在應(yīng)國(guó)家機(jī)關(guān)要求或易通為處理投訴等需要時(shí)配合提供使用小號(hào)的用戶身份信息。
5.14 甲方應(yīng)按照本協(xié)議約定的費(fèi)用及結(jié)算標(biāo)準(zhǔn)按時(shí)足額支付費(fèi)用,如逾期付款超過(guò)1個(gè)月,乙方有權(quán)解除您所有號(hào)碼的綁定關(guān)系,如逾期超過(guò)3個(gè)月,乙方將收回甲方訂購(gòu)的所有小號(hào),在小號(hào)被收回前甲方仍應(yīng)按照本協(xié)議約定支付小號(hào)號(hào)碼月租費(fèi)。
5.15 有下列情形之一的,易通有權(quán)單方解除協(xié)議、收回號(hào)碼,因此給易通造成損失的,您應(yīng)當(dāng)予以賠償:
(1)您使用小號(hào)從事本協(xié)議禁止的行為;
(2)您超出本協(xié)議范圍使用小號(hào)且經(jīng)易通告知后仍拒絕更正的;
(3)您未按時(shí)支付服務(wù)費(fèi)用。
5.16 您承諾不得利用易通號(hào)碼隱私保護(hù)能力對(duì)屬于您的用戶或?qū)Φ谌竭M(jìn)行呼叫騷擾,同時(shí),當(dāng)您收到投訴或您服務(wù)的用戶或第三方明確表示拒絕接收后,您不得再向該用戶或第三方進(jìn)行呼叫,否則由此引起的投訴、法律責(zé)任全部由您負(fù)責(zé)承擔(dān),易通亦有權(quán)要求您對(duì)易通所遭受的一切損失承擔(dān)相應(yīng)的賠償。
5.17 易通為您提供號(hào)碼隱私保護(hù)服務(wù)的號(hào)碼需完成實(shí)名登記后方可提供服務(wù),您應(yīng)按照易通要求如實(shí)提供相應(yīng)材料,包括但不限于企業(yè)資料、服務(wù)應(yīng)用場(chǎng)景、服務(wù)話術(shù)。您亦同意易通將您實(shí)名登記材料提供給運(yùn)營(yíng)商備案。若發(fā)現(xiàn)您的資料不真實(shí)或無(wú)效的,易通有權(quán)在不通知您的情況下停止向您提供服務(wù),您所購(gòu)買(mǎi)的號(hào)碼隱私保護(hù)通話時(shí)長(zhǎng)套餐包余量將不做退費(fèi)處理。
5.18 您不得超出本協(xié)議范圍使用服務(wù),不得直接或變相向第三方轉(zhuǎn)租轉(zhuǎn)售號(hào)碼隱私保護(hù)服務(wù),為第三方提供號(hào)碼隱私保護(hù)服務(wù),不得將本協(xié)議全部或任何一部分轉(zhuǎn)讓或出借給其他第三方使用。
5.19 您承諾規(guī)范使用易通提供的號(hào)碼隱私保護(hù)業(yè)務(wù),不違規(guī)經(jīng)營(yíng)、不變更合同約定用途。您保證不會(huì)對(duì)號(hào)碼進(jìn)行多次轉(zhuǎn)接以躲避號(hào)碼溯源與甄別。您承諾不私自轉(zhuǎn)接境外及港澳臺(tái)地區(qū)來(lái)話,不通過(guò)技術(shù)手段為非法VoIP、改號(hào)電話、網(wǎng)絡(luò)電話(PC軟件/APP等)提供語(yǔ)音呼叫落地。如您違反,易通有權(quán)停止向您提供服務(wù)并對(duì)您追究法律責(zé)任。
5.20 您理解并同意,當(dāng)易通收到政府部門(mén)、運(yùn)營(yíng)商、12321舉報(bào)中心等通信管控渠道的投訴時(shí),易通有權(quán)自行判斷問(wèn)題的嚴(yán)重程度,并有權(quán)單方停止向您提供服務(wù)并對(duì)您追究法律責(zé)任,您所購(gòu)買(mǎi)的號(hào)碼隱私保護(hù)通話時(shí)長(zhǎng)套餐包余量將不做退費(fèi)處理。
5.21 您理解并同意,當(dāng)運(yùn)營(yíng)商或國(guó)家有關(guān)部門(mén)發(fā)現(xiàn)您的通話頻次異常、超約定用途使用或被政府部門(mén)通報(bào)等情況時(shí),易通有權(quán)單方停止向您提供服務(wù)并對(duì)您追究法律責(zé)任。
5.22 您承諾建立有效的信息安全管理制度和技術(shù)保障措施,并配合政府部門(mén)、運(yùn)營(yíng)商或易通的管理、監(jiān)督和檢查,無(wú)條件配合落實(shí)相關(guān)整改舉措,直至符合相關(guān)法律及政策文件要求。
5.23 易通有權(quán)制定本服務(wù)的費(fèi)用標(biāo)準(zhǔn)及收費(fèi)規(guī)則并公示于網(wǎng)站上,并有權(quán)根據(jù)市場(chǎng)情況和業(yè)務(wù)投訴比例隨時(shí)做出變更,亦可通過(guò)書(shū)面方式與您對(duì)費(fèi)用標(biāo)準(zhǔn)及收費(fèi)規(guī)則進(jìn)行變更(如與網(wǎng)站不一致,以書(shū)面約定為準(zhǔn)),您使用本服務(wù)即意味著您接受該費(fèi)用,并同意易通有權(quán)單方判斷和決定您所使用的具體服務(wù)的類型及適用資費(fèi),如您不同意公布或變更的費(fèi)用標(biāo)準(zhǔn)應(yīng)立即停止使用本服務(wù),否則使用或繼續(xù)使用將被視為您同意接受費(fèi)用標(biāo)準(zhǔn)。
5.24 易通有權(quán)對(duì)您使用的號(hào)碼隱私保護(hù)服務(wù)進(jìn)行監(jiān)督、審核和監(jiān)測(cè),且易通有權(quán)單方判斷和決定您是否違反本協(xié)議,并有權(quán)拒絕提供違反法律規(guī)定或本協(xié)議約定的服務(wù),一經(jīng)發(fā)現(xiàn)您違反法律規(guī)定或本協(xié)議約定的情況,有權(quán)立即停止提供服務(wù),并有權(quán)視情節(jié)輕重要求您限期整改、暫停業(yè)務(wù)直至單方面解除合作協(xié)議,您已經(jīng)繳納的但未使用完的費(fèi)用,將作為違約金,易通有權(quán)不予退還,如不足以彌補(bǔ)易通損失的,易通有權(quán)向您進(jìn)行追償。如果因您的用戶投訴導(dǎo)致易通號(hào)碼隱私保護(hù)服務(wù)被運(yùn)營(yíng)商停用,易通有權(quán)要求您對(duì)易通所遭受一切損失承擔(dān)相應(yīng)的賠償責(zé)任。
5.25 禁止將號(hào)碼隱私保護(hù)服務(wù)用于國(guó)家法規(guī)或運(yùn)營(yíng)商禁止開(kāi)展的業(yè)務(wù),包括但不限于:色情、賭博、毒品、黨政、法律維權(quán)、眾籌、慈善募捐、宗教、迷信、股票、留學(xué)移民、面試招聘、博彩、貸款、催款還款、投資理財(cái)?shù)葮I(yè)務(wù)。
5.26 因法律法規(guī)、政策或原因?qū)е乱淄I(yè)務(wù)停止或受限,使本協(xié)議無(wú)法繼續(xù)履行,或因易通與運(yùn)營(yíng)商停止合作導(dǎo)致無(wú)法繼續(xù)提供隱私保護(hù)服務(wù),或因其他不可預(yù)見(jiàn)的原因?qū)е乱淄o(wú)法繼續(xù)開(kāi)展隱私保護(hù)業(yè)務(wù)運(yùn)營(yíng),易通應(yīng)當(dāng)提前7天通知您,本協(xié)議自易通通知載明的解除之日起終止,易通對(duì)此不承擔(dān)違約責(zé)任。但易通應(yīng)當(dāng)退還相應(yīng)的您預(yù)付但未使用完的服務(wù)費(fèi)用。
AXB業(yè)務(wù)接口
1. AXB綁定解綁接口
AXB業(yè)務(wù)主要的請(qǐng)求和響應(yīng)類型如下:
綁定
解綁
1.1 外呼轉(zhuǎn)接配置設(shè)置請(qǐng)求和響應(yīng)
接口
POST {url}/v2/axb/{xmode}
xmode取值:
mode101:APP自帶x號(hào)碼
mode102:平臺(tái)分配x號(hào)碼
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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
應(yīng)用id
M
ts
string/header
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
0
101模式填該字段,102模式不填
telB
string
對(duì)端號(hào)碼
M
subts
string
綁定時(shí)間
M
格式為yyyyMMddHHmmss。時(shí)間采用北京時(shí)間,24小時(shí)制。
anucode
放音編碼
M
AXB業(yè)務(wù)時(shí)必須設(shè)置。
放音編碼必須包含3個(gè)場(chǎng)景的編碼。按照“B->X,A->X,其他號(hào)碼->X”的順序填寫(xiě)編碼,編碼之間以逗號(hào)分隔。
比如:“1,2,3”表示 B->X 放音編號(hào)為 1,A->X 放音編號(hào)為 2,其他號(hào)碼->X 放音編號(hào)為 3。
其它號(hào)碼->X 放音編號(hào)
0-255
areacode
string
區(qū)號(hào)
0
例如:北京(10);在平臺(tái)分配X號(hào)碼模式中,平臺(tái)從號(hào)碼池中分配該地區(qū)的X號(hào)碼,避免產(chǎn)生呼叫長(zhǎng)途費(fèi)。101模式不填該字段,102模式需要填
expiration
string
過(guò)期時(shí)間
M
單位:秒, 自綁定時(shí)間開(kāi)始后expiration秒自動(dòng)解綁;0表示不限制時(shí)間,不會(huì)自動(dòng)解綁
remark
string
接入商自有字段
0
接入商自有字段,不能超過(guò)30個(gè)字節(jié)
extra
json
擴(kuò)展參數(shù)
0
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認(rèn)是0(不開(kāi)通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來(lái)顯控制
0
可選。 針對(duì)AXB中的A或者B作為主叫時(shí),是否在被叫上顯示來(lái)話的真實(shí)號(hào)碼。默認(rèn)為0(不顯示真實(shí)號(hào)碼)。
0:不顯示真實(shí)號(hào)碼
1:顯示真實(shí)號(hào)碼
來(lái)顯控制按照“A->B時(shí)B上的顯示,B(N)->A時(shí)在A上的顯示”的順序填寫(xiě)編碼,編碼之間以逗號(hào)分隔?!捌渌?hào)碼”的來(lái)顯控制,同B(N)設(shè)置。
場(chǎng)景
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
可選。
僅下列值有效。默認(rèn)是1。
0 AXB不做呼叫控制,A和B(N)均有權(quán)限,即為現(xiàn)有的AXN模式
1 AXB做呼叫控制,A和B有權(quán)限,其他號(hào)碼無(wú)權(quán)限,即為現(xiàn)有的AXB
2 AXB的單通控制,A無(wú)權(quán)限,B有權(quán)限,其他號(hào)碼無(wú)權(quán)限
3 AXB的單通控制,A有權(quán)限,B以及其他號(hào)碼無(wú)權(quán)限
4 AXN的單通控制,A無(wú)權(quán)限,B以及其他號(hào)碼有權(quán)限
5 AXN的單通控制,A有權(quán)限,B以及其他號(hào)碼無(wú)權(quán)限
6?均無(wú)權(quán)限
-calldisplayshow
string
推送被叫來(lái)顯號(hào)碼控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 推送中不攜帶被叫來(lái)顯號(hào)碼
1 推送中攜帶被叫來(lái)顯號(hào)碼
-callunsub
string
解綁推送消息控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 解綁不推送消息
1 解綁推送消息
-ringpickup
string
被叫振鈴?fù)扑褪录刂?
0
可選。
僅下列值有效。默認(rèn)是0。
0 不推送被叫振鈴事件
1 推送被叫振鈴事件
-callpickup
string
被叫接通推送事件控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 不推送被叫接通事件
1 推送被叫接通事件
-callcontrol
string
被叫接通控制
0
可選。其他號(hào)碼呼叫X時(shí),對(duì)來(lái)顯進(jìn)行鑒權(quán),僅下列值有效。默認(rèn)是0。
0 不對(duì)來(lái)話號(hào)碼鑒權(quán)
1 對(duì)來(lái)話號(hào)碼鑒權(quán)
-callduration
string
通話持續(xù)時(shí)間
0
可選,單位秒,如果出現(xiàn)則通話有效時(shí)長(zhǎng)為此值,如果沒(méi)有出現(xiàn)按現(xiàn)在默認(rèn)處理。
響應(yīng)體
{
"code": "0",
"message": "success",
"data": { "subid": "100X571X0000000001", "telX": "13720056199"}
}
請(qǐng)求響應(yīng)實(shí)例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"}}
請(qǐng)求響應(yīng)實(shí)例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 解綁請(qǐng)求和響應(yīng)
接口
DELETE {url}/v2/axb/{subid}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string/header
應(yīng)用id
M
ts
string/header
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
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è)務(wù)設(shè)置接口
2.1 綁定更新請(qǐng)求和響應(yīng)
接口
PUT {url}/v2/axb/{subid}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13900000000",
"telB": "13005711234",
"subts": "20150920190126",
"anucode": "1,2,3",
"expiration": "7200",
"extra": { "callrecording": "0","calldisplay": "0,0"
}
}
appkey
string/header
應(yīng)用id
M
請(qǐng)求和綁定時(shí)的appkey必須一致;
ts
string/header
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
0
telA,telB不允許同時(shí)更新
telB
string
對(duì)端號(hào)碼
0
telA,telB不允許同時(shí)更新
subts
string
綁定時(shí)間
M
格式為yyyyMMddHHmmss。時(shí)間采用北京時(shí)間,24小時(shí)制。
anucode
放音編碼
0
AXB業(yè)務(wù)時(shí)必須設(shè)置。
放音編碼必須包含3個(gè)場(chǎng)景的編碼。按照“A->X,B->X,其他號(hào)碼->X”的順序填寫(xiě)編碼,編碼之間以逗號(hào)分隔。
比如:“1,2,3”表示A->X放音編號(hào)為1, B->X放音編號(hào)為2, 其他號(hào)碼->X放音編號(hào)為3。
其它號(hào)碼->X 放音編號(hào)
0-255
expiration
string
過(guò)期時(shí)間
0
單位:秒, 自綁定時(shí)間開(kāi)始后expiration秒自動(dòng)解綁;0表示不限制時(shí)間,不會(huì)自動(dòng)解綁
extra
json
擴(kuò)展參數(shù)
0
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認(rèn)是0(不開(kāi)通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來(lái)顯控制
0
可選。 針對(duì)AXB中的A或者B作為主叫時(shí),是否在被叫上顯示來(lái)話的真實(shí)號(hào)碼。默認(rèn)為0(不顯示真實(shí)號(hào)碼)。
0:不顯示真實(shí)號(hào)碼
1:顯示真實(shí)號(hào)碼
來(lái)顯控制按照“A->B時(shí)B上的顯示,B(N)->A時(shí)在A上的顯示”的順序填寫(xiě)編碼,編碼之間以逗號(hào)分隔?!捌渌?hào)碼”的來(lái)顯控制,同B(N)設(shè)置。
場(chǎng)景
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”
響應(yīng)體
{
"code": "0",
"message": "success"
}
2.2 綁定查詢請(qǐng)求和響應(yīng)
接口
GET?{url}/v2/axb/subid/{subid}
GET?{url}/v2/axb/xa/{telX}/{telA}
GET?{url}/v2/axb/xb/{telX}/{telB}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應(yīng)體
{
"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è)務(wù)推送接口
3.1 code返回碼定義
第三方APP返回碼:
401
認(rèn)證未通過(guò)
推送的來(lái)源或者推送的簽名未通過(guò)校驗(yàn)。
3.2 呼叫起始推送
接口
POST {url}/v2/axb/callin
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
remark
string
接入商自有字段
0
接入商自有字段,在綁定請(qǐng)求攜帶過(guò)來(lái),不能超過(guò)30個(gè)字節(jié)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
31:轉(zhuǎn)接短信
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
calltime
string
發(fā)起呼叫時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標(biāo)識(shí)
M
唯一關(guān)聯(lián)標(biāo)識(shí)
callrecording
string
錄音控制
M
同綁定接口定義
calldisplay
string
被叫來(lái)顯號(hào)碼
0
smscnt
string
短信條數(shù)
0
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
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 呼叫結(jié)束推送
接口
POST {url}/v2/axb/finish
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
calltime
string
發(fā)起呼叫時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
ringingtime
string
振鈴開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
starttime
string
通話開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
releasetime
string
通話結(jié)束時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
releasedir
string
釋放方向
M
1表示主叫,
2表示被叫,
0表示平臺(tái)釋放
releasecause
string
釋放原因
M
000 0001(1) 未分配的號(hào)碼
000 0010(2) 無(wú)路由到指定的轉(zhuǎn)接網(wǎng)
000 0011(3) 無(wú)路由到目的地
000 0100(4) 發(fā)送專用信息音
001 0000(16) 正常的呼叫拆線
001 0001(17) 用戶忙
001 0010(18) 用戶未響應(yīng)
001 0011(19) 用戶未應(yīng)答
001 0100(20) 用戶缺席
001 0101(21) 呼叫拒收
001 0110(22) 號(hào)碼改變
001 1011(27) 目的地不可達(dá)
001 1100(28) 無(wú)效的號(hào)碼格式(地址不全)
001 1101(29) 性能拒絕
001 1111(31) 正常—未指定
類別010,資源不可用類:
010 0010(34) 無(wú)電路/通路可用
010 1010(42) 交換設(shè)備擁塞
類別011,業(yè)務(wù)或任選不可用類:
011 0010(50) 所請(qǐng)求的性能未預(yù)定
011 0101(53) CUG中限制去呼叫
011 0111(55) CUG中限制來(lái)呼叫
011 1001(57) 承載能力無(wú)權(quán)
011 1010(58) 承載能力目前不可用
類別100,業(yè)務(wù)或任選未實(shí)現(xiàn)類:
100 0001(65) 承載能力未實(shí)現(xiàn)
100 0101(69) 所請(qǐng)求的性能未實(shí)現(xiàn)
類別101,無(wú)效的消息(例如參數(shù)超出范圍)類:
101 0111(87) 被叫用戶不是CUG的成員
101 1000(88) 不兼容的目的地
101 1010(90) 不存在的CUG
101 1011(91) 無(wú)效的轉(zhuǎn)接網(wǎng)選擇
101 1111(95) 無(wú)效的消息,未指定
類別110,協(xié)議錯(cuò)誤(例如未知的消息)類:
110 0001(97) 消息類型不存在或未實(shí)現(xiàn)
110 0011(99) 參數(shù)不存在或未實(shí)現(xiàn)
110 0110(102)定時(shí)器終了時(shí)恢復(fù)
110 0101(103)參數(shù)不存在或未實(shí)現(xiàn)—傳遞
110 1110(110)消息帶有未被識(shí)別的參數(shù)—舍棄
110 1111(111)協(xié)議錯(cuò)誤,未指定
類別111,互通類:
111 1111(127)互通,未指定
類別1100、1101,平臺(tái)拒絕類:
1100 1010(202)用戶忙,MSRN獲取失敗,平臺(tái)掛機(jī)
1100 1011(203)用戶去活,平臺(tái)掛機(jī)
1100 1100(204)用戶在平臺(tái)側(cè)關(guān)機(jī),平臺(tái)掛機(jī)
1100 1101(205)用戶未開(kāi)戶,平臺(tái)掛機(jī)
1100 1110(206)小號(hào)不允許呼叫,平臺(tái)掛機(jī)
1100 1111(207)主號(hào)撥打小號(hào),平臺(tái)掛機(jī)
1101 0001(209)主叫打小號(hào)帶原始被叫,平臺(tái)掛機(jī)
callrecording
string
錄音控制
M
同綁定接口定義
recordMode
string
錄音模式
0
1:主叫在左聲道
2:主叫在右聲道
3:混音
telredir
string
呼轉(zhuǎn)號(hào)碼
0
redirreason
string
呼轉(zhuǎn)原因
0
0000(0) 未知
0001(1) 用戶忙
0010(2) 無(wú)應(yīng)答
0011(3) 無(wú)條件
0110(6) 移動(dòng)用戶不可及
calldisplay
string
被叫來(lái)顯號(hào)碼
0
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
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
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"subid": "100X571X0000000001"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
3.5被叫接通推送
接口
POST {url}/v2/axb/pickup
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
3.6 被叫振鈴?fù)扑?/div>
接口
POST {url}/v2/axb/ring
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
AX業(yè)務(wù)接口
1. AX綁定解綁接口
AX業(yè)務(wù)主要處理的請(qǐng)求和響應(yīng)類型如下:
綁定
解綁
1.1 綁定請(qǐng)求和響應(yīng)
接口
POST {url}/v2/ax/{xmode}
xmode取值:
mode101:APP自帶x號(hào)碼
mode102:平臺(tái)分配x號(hào)碼
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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"}
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
0
X號(hào)碼;平臺(tái)分配號(hào)碼模式下,該參數(shù)可不帶,系統(tǒng)忽略該參數(shù)
subts
string
綁定時(shí)間
M
格式為yyyyMMddHHmmss。時(shí)間采用北京時(shí)間,24小時(shí)制。
areacode
string
區(qū)號(hào)
0
例如:北京(10);在平臺(tái)分配X號(hào)碼模式中,平臺(tái)從號(hào)碼池中分配該地區(qū)的X號(hào)碼,避免產(chǎn)生呼叫長(zhǎng)途費(fèi)。
expiration
string
過(guò)期時(shí)間
M
單位:秒, 自綁定時(shí)間開(kāi)始后expiration秒自動(dòng)解綁;0表示不限制時(shí)間,不會(huì)自動(dòng)解綁
remark
string
接入商自有字段
0
接入商自有字段,不能超過(guò)30個(gè)字節(jié)
extra
json
擴(kuò)展參數(shù)
0
-callrecording
string
錄音控制
0
可選。M
僅下列值有效。默認(rèn)是0(不開(kāi)通錄音功能)。
0、好, :不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來(lái)顯控制
0
可選。M
僅下列值有效。默認(rèn)是0(顯示真實(shí)號(hào)碼)。
0:顯示真實(shí)號(hào)碼
1:顯示X號(hào)碼
2: 顯示Z號(hào)碼池中的號(hào)碼
在綁定時(shí)可自由選擇是否分配Z號(hào)碼池的開(kāi)關(guān)。
-anucodecalled
string
放音編碼
0
可選。
其他號(hào)碼撥打X時(shí),給其他號(hào)碼的放音
不帶,不放音。
-anucodecaller
string
放音編碼
0
可選。
其他號(hào)碼撥打X時(shí),給A的放音
不帶,不放音。
-callunsub
string
解綁推送消息控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 解綁不推送消息
1 解綁推送消息
-callpickup
string
被叫接通推送事件控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 不推送被叫接通事件
1 推送被叫接通事件
-ringpickup
string
被叫振鈴?fù)扑褪录刂?
0
可選。
僅下列值有效。默認(rèn)是0。
0 不推送被叫振鈴事件
1 推送被叫振鈴事件
-callcontrol
string
被叫接通控制
0
可選。其他號(hào)碼呼叫X時(shí),對(duì)來(lái)顯進(jìn)行鑒權(quán),僅下列值有效。默認(rèn)是0。
0 不對(duì)來(lái)話號(hào)碼鑒權(quán)
1 對(duì)來(lái)話號(hào)碼鑒權(quán)
-callduration
string
通話持續(xù)時(shí)間
0
可選,單位秒,如果出現(xiàn)則通話有效時(shí)長(zhǎng)為此值,如果沒(méi)有出現(xiàn)按現(xiàn)在默認(rèn)處理
響應(yīng)體
{
"code": "0",
"message": "success",
"data": { "subid": "100X571X0000000001", "telX": "13720056199"}
}
請(qǐng)求響應(yīng)實(shí)例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"}}
請(qǐng)求響應(yīng)實(shí)例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 解綁請(qǐng)求和響應(yīng)
接口
DELETE {url}/v2/ax/{subid}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
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è)務(wù)設(shè)置接口
AX業(yè)務(wù)設(shè)置的請(qǐng)求和響應(yīng)類型如下:
2.1 在線語(yǔ)音主叫請(qǐng)求和響應(yīng)
接口
PUT {url}/v2/ax/onlinecall/{subid}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telB": "13720056198"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
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 綁定更新請(qǐng)求和響應(yīng)
接口
PUT {url}/v2/ax/{subid}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13900000000",
"subts": "20150920190126",
"name": "張三",
"cardtype": "0",
"cardno": "363333199912221022",
"expiration": "7200",
"extra": {"callrecording": "0","calldisplay": "0","anucodecalled": "123"}
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
0
不帶此參數(shù),表示只更新其他屬性
subts
string
綁定時(shí)間
M
格式為yyyyMMddHHmmss。時(shí)間采用北京時(shí)間,24小時(shí)制。
expiration
string
過(guò)期時(shí)間
0
單位:秒, 自綁定時(shí)間開(kāi)始后expiration秒自動(dòng)解綁;0表示不限制時(shí)間,不會(huì)自動(dòng)解綁
extra
json
擴(kuò)展參數(shù)
0
callrecording
string
錄音控制
0
可選。M
僅下列值有效。默認(rèn)是0(不開(kāi)通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
calldisplay
string
來(lái)顯控制
0
可選。M
僅下列值有效。默認(rèn)是0(顯示真實(shí)號(hào)碼)。
0:顯示真實(shí)號(hào)碼
1:顯示X號(hào)碼
2: 顯示Z號(hào)碼池中的號(hào)碼
在綁定時(shí)可自由選擇是否分配Z號(hào)碼池的開(kāi)關(guān)。
anucodecalled
string
放音編碼
0
可選。
其他號(hào)碼撥打X時(shí)給其他號(hào)碼的放音
不帶,不放音。
響應(yīng)體
{
"code": "0",
"message": "success"
}
2.3 綁定查詢請(qǐng)求和響應(yīng)
接口
GET {url}/v2/ax/subid/{subid}
GET {url}/v2/ax/telX/{telX}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應(yīng)體
{
"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"}
}
}
telA
string
真實(shí)號(hào)碼
M
telX
string
隱私號(hào)碼
0
X號(hào)碼;平臺(tái)分配號(hào)碼模式下,該參數(shù)可不帶,系統(tǒng)忽略該參數(shù)
subts
string
綁定時(shí)間
M
格式為yyyyMMddHHmmss。時(shí)間采用北京時(shí)間,24小時(shí)制。
areacode
string
區(qū)號(hào)
0
例如:北京(10);在平臺(tái)分配X號(hào)碼模式中,平臺(tái)從號(hào)碼池中分配該地區(qū)的X號(hào)碼,避免產(chǎn)生呼叫長(zhǎng)途費(fèi)。
expiration
string
過(guò)期時(shí)間
M
單位:秒, 自綁定時(shí)間開(kāi)始后expiration秒自動(dòng)解綁;0表示不限制時(shí)間,不會(huì)自動(dòng)解綁
extra
json
擴(kuò)展參數(shù)
0
callrecording
string
錄音控制
0
可選。M
僅下列值有效。默認(rèn)是0(不開(kāi)通錄音功能)。
0:不錄音
1:接通后錄音
calldisplay
string
來(lái)顯控制
0
可選。M
僅下列值有效。默認(rèn)是0(顯示真實(shí)號(hào)碼)。
0:顯示真實(shí)號(hào)碼
1:顯示X號(hào)碼
2: 顯示Z號(hào)碼池中的號(hào)碼
在綁定時(shí)可自由選擇是否分配Z號(hào)碼池的開(kāi)關(guān)。
anucodecalled
string
放音編碼
0
可選。
其他號(hào)碼撥打X時(shí)給其他號(hào)碼的放音
不帶,不放音。
3. AX業(yè)務(wù)推送接口
3.1 code返回碼定義
第三方APP返回碼:
401
認(rèn)證未通過(guò)
推送的來(lái)源或者推送的簽名未通過(guò)校驗(yàn)。
3.2 呼叫起始推送
接口
POST {url}/v2/ax/callin
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AX業(yè)務(wù):(Bit7=0時(shí)為傳統(tǒng)CS方式,Bit7=1時(shí)為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
calltime
string
通話開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標(biāo)識(shí)
M
唯一關(guān)聯(lián)標(biāo)識(shí)
callrecording
string
錄音控制
M
同綁定接口定義
telZ
string
Z號(hào)碼
M
默認(rèn)為空。在綁定請(qǐng)求中設(shè)置了來(lái)顯為Z號(hào)碼時(shí),該值為顯示的Z號(hào)碼。
smscnt
string
短信條數(shù)
0
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
參考AXB業(yè)務(wù)呼叫起始推送。
3.3 呼叫結(jié)束推送
接口
POST {url}/v2/ax/finish
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AX業(yè)務(wù):(Bit7=0時(shí)為傳統(tǒng)CS方式,Bit7=1時(shí)為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
calltime
string
通話開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
ringingtime
string
振鈴開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
starttime
string
通話開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
releasetime
string
通話結(jié)束時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
releasedir
string
釋放方向
M
1 表示主叫,
2 表示被叫,
0 表示平臺(tái)釋放
releasecause
string
釋放原因
M
000 0001(1) 未分配的號(hào)碼
000 0010(2) 無(wú)路由到指定的轉(zhuǎn)接網(wǎng)
000 0011(3) 無(wú)路由到目的地
000 0100(4) 發(fā)送專用信息音
001 0000(16) 正常的呼叫拆線
001 0001(17) 用戶忙
001 0010(18) 用戶未響應(yīng)
001 0011(19) 用戶未應(yīng)答
001 0100(20) 用戶缺席
001 0101(21) 呼叫拒收
001 0110(22) 號(hào)碼改變
001 1011(27) 目的地不可達(dá)
001 1100(28) 無(wú)效的號(hào)碼格式(地址不全)
001 1101(29) 性能拒絕
001 1111(31) 正?!粗付?br/>
類別010,資源不可用類:
010 0010(34) 無(wú)電路/通路可用
010 1010(42) 交換設(shè)備擁塞
類別011,業(yè)務(wù)或任選不可用類:
011 0010(50) 所請(qǐng)求的性能未預(yù)定
011 0101(53) CUG中限制去呼叫
011 0111(55) CUG中限制來(lái)呼叫
011 1001(57) 承載能力無(wú)權(quán)
011 1010(58) 承載能力目前不可用
類別100,業(yè)務(wù)或任選未實(shí)現(xiàn)類:
100 0001(65) 承載能力未實(shí)現(xiàn)
100 0101(69) 所請(qǐng)求的性能未實(shí)現(xiàn)
類別101,無(wú)效的消息(例如參數(shù)超出范圍)類:
101 0111(87) 被叫用戶不是CUG的成員
101 1000(88) 不兼容的目的地
101 1010(90) 不存在的CUG
101 1011(91) 無(wú)效的轉(zhuǎn)接網(wǎng)選擇
101 1111(95) 無(wú)效的消息,未指定
類別110,協(xié)議錯(cuò)誤(例如未知的消息)類:
110 0001(97) 消息類型不存在或未實(shí)現(xiàn)
110 0011(99) 參數(shù)不存在或未實(shí)現(xiàn)
110 0110(102)定時(shí)器終了時(shí)恢復(fù)
110 0101(103)參數(shù)不存在或未實(shí)現(xiàn)—傳遞
110 1110(110)消息帶有未被識(shí)別的參數(shù)—舍棄
110 1111(111)協(xié)議錯(cuò)誤,未指定
類別111,互通類:
111 1111(127)互通,未指定
類別1100、1101,平臺(tái)拒絕類:
1100 1010(202)用戶忙,MSRN獲取失敗,平臺(tái)掛機(jī)
1100 1011(203)用戶去活,平臺(tái)掛機(jī)
1100 1100(204)用戶在平臺(tái)側(cè)關(guān)機(jī),平臺(tái)掛機(jī)
1100 1101(205)用戶未開(kāi)戶,平臺(tái)掛機(jī)
1100 1110(206)小號(hào)不允許呼叫,平臺(tái)掛機(jī)
1100 1111(207)主號(hào)撥打小號(hào),平臺(tái)掛機(jī)
1101 0001(209)主叫打小號(hào)帶原始被叫,平臺(tái)掛機(jī)
callrecording
string
錄音控制
M
同綁定接口定義
recordMode
string
錄音模式
0
1:主叫在左聲道
2:主叫在右聲道
3:混音
telZ
string
Z號(hào)碼
0
在綁定請(qǐng)求中設(shè)置了來(lái)顯為Z號(hào)碼時(shí),該值為顯示的Z號(hào)碼。
userkey
string
分機(jī)號(hào)
0
分機(jī)號(hào)
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
參考AXB業(yè)務(wù)呼叫結(jié)束推送。
3.4解綁推送
接口
POST {url}/v2/ax/unsub
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"subid": "100X571X0000000001"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
3.5 被叫接通推送
接口
POST {url}/v2/ax/pickup
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"subid": "100X571X0000000001",
"calltype": "1",
"callid": "14c821340104058b",
"callrecording": "0"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AX業(yè)務(wù):(Bit7=0時(shí)為傳統(tǒng)CS方式,Bit7=1時(shí)為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
3.6 被叫振鈴?fù)扑?/div>
接口
POST {url}/v2/ax/ring
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056197",
"subid": "100X571X0000000001",
"calltype": "1",
"callid": "14c821340104058b",
"callrecording": "0"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AX業(yè)務(wù):(Bit7=0時(shí)為傳統(tǒng)CS方式,Bit7=1時(shí)為PS方式)
0:DTMF方式通話主叫
1:通話被叫
2:短信發(fā)送
3:短信接收
128:PS方式通話主叫
127: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
AXN業(yè)務(wù)接口
1. AXN綁定解綁接口
AXN業(yè)務(wù)主要處理的請(qǐng)求和響應(yīng)類型如下:
綁定
解綁
1.1 綁定請(qǐng)求和響應(yīng)
接口
POST {url}/v2/axn/{xmode}
xmode取值:
mode101:APP自帶x號(hào)碼
mode102:平臺(tái)分配x號(hào)碼
請(qǐng)求體
{
"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
應(yīng)用id
M
ts
string/header
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
0
101模式填該字段,102模式不填
telB
string
對(duì)端號(hào)碼
M
subts
string
綁定時(shí)間
M
格式為yyyyMMddHHmmss。時(shí)間采用北京時(shí)間,24小時(shí)制。
anucode
放音編碼
M
AXB業(yè)務(wù)時(shí)必須設(shè)置。
放音編碼必須包含3個(gè)場(chǎng)景的編碼。按照“B->X,A->X,其他號(hào)碼->X”的順序填寫(xiě)編碼,編碼之間以逗號(hào)分隔。
比如:“1,2,3”表示 B->X 放音編號(hào)為 1,A->X 放音編號(hào)為 2,其他號(hào)碼->X 放音編號(hào)為 3。
其它號(hào)碼->X 放音編號(hào)
0-255
areacode
string
區(qū)號(hào)
0
例如:北京(10);在平臺(tái)分配X號(hào)碼模式中,平臺(tái)從號(hào)碼池中分配該地區(qū)的X號(hào)碼,避免產(chǎn)生呼叫長(zhǎng)途費(fèi)。101模式不填該字段,102模式需要填
expiration
string
過(guò)期時(shí)間
M
單位:秒, 自綁定時(shí)間開(kāi)始后expiration秒自動(dòng)解綁;0表示不限制時(shí)間,不會(huì)自動(dòng)解綁
remark
string
接入商自有字段
0
接入商自有字段,不能超過(guò)30個(gè)字節(jié)
extra
json
擴(kuò)展參數(shù)
0
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認(rèn)是0(不開(kāi)通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來(lái)顯控制
0
可選。 針對(duì)AXB中的A或者B作為主叫時(shí),是否在被叫上顯示來(lái)話的真實(shí)號(hào)碼。默認(rèn)為0(不顯示真實(shí)號(hào)碼)。
0:不顯示真實(shí)號(hào)碼
1:顯示真實(shí)號(hào)碼
-callrestrict
string
呼叫控制
0
可選。
僅下列值有效。默認(rèn)是1。
0 AXB不做呼叫控制,A和B(N)均有權(quán)限,即為現(xiàn)有的AXN模式
1 AXB做呼叫控制,A和B有權(quán)限,其他號(hào)碼無(wú)權(quán)限,即為現(xiàn)有的AXB
2 AXB的單通控制,A無(wú)權(quán)限,B有權(quán)限,其他號(hào)碼無(wú)權(quán)限
3 AXB的單通控制,A有權(quán)限,B以及其他號(hào)碼無(wú)權(quán)限
4 AXN的單通控制,A無(wú)權(quán)限,B以及其他號(hào)碼有權(quán)限
5 AXN的單通控制,A有權(quán)限,B以及其他號(hào)碼無(wú)權(quán)限
6?均無(wú)權(quán)限
-calldisplayshow
string
推送被叫來(lái)顯號(hào)碼控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 推送中不攜帶被叫來(lái)顯號(hào)碼
1 推送中攜帶被叫來(lái)顯號(hào)碼
-callunsub
string
解綁推送消息控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 解綁不推送消息
1 解綁推送消息
-ringpickup
string
被叫振鈴?fù)扑褪录刂?
0
可選。
僅下列值有效。默認(rèn)是0。
0 不推送被叫振鈴事件
1 推送被叫振鈴事件
-callpickup
string
被叫接通推送事件控制
0
可選。
僅下列值有效。默認(rèn)是0。
0 不推送被叫接通事件
1 推送被叫接通事件
-callcontrol
string
被叫接通控制
0
可選。其他號(hào)碼呼叫X時(shí),對(duì)來(lái)顯進(jìn)行鑒權(quán),僅下列值有效。默認(rèn)是0。
0 不對(duì)來(lái)話號(hào)碼鑒權(quán)
1 對(duì)來(lái)話號(hào)碼鑒權(quán)
-callduration
string
通話持續(xù)時(shí)間
0
可選,單位秒,如果出現(xiàn)則通話有效時(shí)長(zhǎng)為此值,如果沒(méi)有出現(xiàn)按現(xiàn)在默認(rèn)處理。
響應(yīng)體
{
"code": "0",
"message": "success",
"data": { "subid": "100X571X0000000001", "telX": "13720056199"}
}
1.2 解綁請(qǐng)求和響應(yīng)
接口
DELETE {url}/v2/axn/{subid}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string/header
應(yīng)用id
M
ts
string/header
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
響應(yīng)體
{
"code": "0",
"message": "success"
}
2. AXN業(yè)務(wù)設(shè)置接口
2.1 綁定更新請(qǐng)求和響應(yīng)
接口
PUT {url}/v2/axn/{subid}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13900000000",
"telB": "13005711234",
"subts": "20150920190126",
"anucode": "1,2,3",
"expiration": "7200",
"extra": { "callrecording": "0","calldisplay": "0,0"
}
}
appkey
string/header
應(yīng)用id
M
請(qǐng)求和綁定時(shí)的appkey必須一致;
ts
string/header
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string/header
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
0
telA,telB不允許同時(shí)更新
telB
string
對(duì)端號(hào)碼
0
telA,telB不允許同時(shí)更新
subts
string
綁定時(shí)間
M
格式為yyyyMMddHHmmss。時(shí)間采用北京時(shí)間,24小時(shí)制。
anucode
放音編碼
0
AXB業(yè)務(wù)時(shí)必須設(shè)置。
放音編碼必須包含3個(gè)場(chǎng)景的編碼。按照“A->X,B->X,其他號(hào)碼->X”的順序填寫(xiě)編碼,編碼之間以逗號(hào)分隔。
比如:“1,2,3”表示A->X放音編號(hào)為1, B->X放音編號(hào)為2, 其他號(hào)碼->X放音編號(hào)為3。
其它號(hào)碼->X 放音編號(hào)
0-255
expiration
string
過(guò)期時(shí)間
0
單位:秒, 自綁定時(shí)間開(kāi)始后expiration秒自動(dòng)解綁;0表示不限制時(shí)間,不會(huì)自動(dòng)解綁
extra
json
擴(kuò)展參數(shù)
0
-callrecording
string
錄音控制
0
可選。
僅下列值有效。默認(rèn)是0(不開(kāi)通錄音功能)。
0:不錄音
1:接通后錄音
2:被叫響鈴后錄音
-calldisplay
string
來(lái)顯控制
0
可選。 針對(duì)AXB中的A或者B作為主叫時(shí),是否在被叫上顯示來(lái)話的真實(shí)號(hào)碼。默認(rèn)為0(不顯示真實(shí)號(hào)碼)。
0:不顯示真實(shí)號(hào)碼
1:顯示真實(shí)號(hào)碼
來(lái)顯控制按照“A->B時(shí)B上的顯示,B(N)->A時(shí)在A上的顯示”的順序填寫(xiě)編碼,編碼之間以逗號(hào)分隔?!捌渌?hào)碼”的來(lái)顯控制,同B(N)設(shè)置。
場(chǎng)景
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”
響應(yīng)體
{
"code": "0",
"message": "success"
}
2.2 AXN查詢請(qǐng)求和響應(yīng)
接口
GET?{url}/v2/axn/subid/{subid}
GET?{url}/v2/axn/telx/{telX}
GET?{url}/v2/axn/tela/{telA}
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
響應(yīng)體
如果有多個(gè)AXN的綁定關(guān)系,則出現(xiàn)多個(gè)object結(jié)構(gòu)(array格式)
參數(shù)說(shuō)明請(qǐng)參考綁定請(qǐng)求和響應(yīng)。
{
"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è)務(wù)推送接口
3.1 呼叫起始推送
接口
POST {url}/v2/axn/callin
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
remark
string
接入商自有字段
0
接入商自有字段,在綁定請(qǐng)求攜帶過(guò)來(lái),不能超過(guò)30個(gè)字節(jié)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
31:轉(zhuǎn)接短信
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
calltime
string
發(fā)起呼叫時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標(biāo)識(shí)
M
唯一關(guān)聯(lián)標(biāo)識(shí)
callrecording
string
錄音控制
M
同綁定接口定義
calldisplay
string
被叫來(lái)顯號(hào)碼
0
smscnt
string
短信條數(shù)
0
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
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 呼叫結(jié)束推送
接口
POST {url}/v2/axn/finish
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"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"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
telC
string
對(duì)端號(hào)碼
0
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
calltime
string
發(fā)起呼叫時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
ringingtime
string
振鈴開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
starttime
string
通話開(kāi)始時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
releasetime
string
通話結(jié)束時(shí)間
M
格式: yyyy-MM-dd HH:mm:ss
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
releasedir
string
釋放方向
M
1 表示主叫,
2 表示被叫,
0 表示平臺(tái)釋放
releasecause
string
釋放原因
M
000 0001(1) 未分配的號(hào)碼
000 0010(2) 無(wú)路由到指定的轉(zhuǎn)接網(wǎng)
000 0011(3) 無(wú)路由到目的地
000 0100(4) 發(fā)送專用信息音
001 0000(16) 正常的呼叫拆線
001 0001(17) 用戶忙
001 0010(18) 用戶未響應(yīng)
001 0011(19) 用戶未應(yīng)答
001 0100(20) 用戶缺席
001 0101(21) 呼叫拒收
001 0110(22) 號(hào)碼改變
001 1011(27) 目的地不可達(dá)
001 1100(28) 無(wú)效的號(hào)碼格式(地址不全)
001 1101(29) 性能拒絕
001 1111(31) 正?!粗付?br/>
類別010,資源不可用類:
010 0010(34) 無(wú)電路/通路可用
010 1010(42) 交換設(shè)備擁塞
類別011,業(yè)務(wù)或任選不可用類:
011 0010(50) 所請(qǐng)求的性能未預(yù)定
011 0101(53) CUG中限制去呼叫
011 0111(55) CUG中限制來(lái)呼叫
011 1001(57) 承載能力無(wú)權(quán)
011 1010(58) 承載能力目前不可用
類別100,業(yè)務(wù)或任選未實(shí)現(xiàn)類:
100 0001(65) 承載能力未實(shí)現(xiàn)
100 0101(69) 所請(qǐng)求的性能未實(shí)現(xiàn)
類別101,無(wú)效的消息(例如參數(shù)超出范圍)類:
101 0111(87) 被叫用戶不是CUG的成員
101 1000(88) 不兼容的目的地
101 1010(90) 不存在的CUG
101 1011(91) 無(wú)效的轉(zhuǎn)接網(wǎng)選擇
101 1111(95) 無(wú)效的消息,未指定
類別110,協(xié)議錯(cuò)誤(例如未知的消息)類:
110 0001(97) 消息類型不存在或未實(shí)現(xiàn)
110 0011(99) 參數(shù)不存在或未實(shí)現(xiàn)
110 0110(102)定時(shí)器終了時(shí)恢復(fù)
110 0101(103)參數(shù)不存在或未實(shí)現(xiàn)—傳遞
110 1110(110)消息帶有未被識(shí)別的參數(shù)—舍棄
110 1111(111)協(xié)議錯(cuò)誤,未指定
類別111,互通類:
111 1111(127)互通,未指定
類別1100、1101,平臺(tái)拒絕類:
1100 1010(202)用戶忙,MSRN獲取失敗,平臺(tái)掛機(jī)
1100 1011(203)用戶去活,平臺(tái)掛機(jī)
1100 1100(204)用戶在平臺(tái)側(cè)關(guān)機(jī),平臺(tái)掛機(jī)
1100 1101(205)用戶未開(kāi)戶,平臺(tái)掛機(jī)
1100 1110(206)小號(hào)不允許呼叫,平臺(tái)掛機(jī)
1100 1111(207)主號(hào)撥打小號(hào),平臺(tái)掛機(jī)
1101 0001(209)主叫打小號(hào)帶原始被叫,平臺(tái)掛機(jī)
callrecording
string
錄音控制
M
同綁定接口定義
recordMode
string
錄音模式
0
1:主叫在左聲道
2:主叫在右聲道
3:混音
telredir
string
呼轉(zhuǎn)號(hào)碼
0
redirreason
string
呼轉(zhuǎn)原因
0
0000(0) 未知
0001(1) 用戶忙
0010(2) 無(wú)應(yīng)答
0011(3) 無(wú)條件
0110(6) 移動(dòng)用戶不可及
calldisplay
string
被叫來(lái)顯號(hào)碼
0
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
請(qǐng)求響應(yīng)實(shí)例:
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
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"subid": "100X571X0000000001"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
3.4 被叫接通推送
接口
POST {url}/v2/axn/pickup
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}
3.5 被叫振鈴?fù)扑?/div>
接口
POST {url}/v2/axn/ring
請(qǐng)求頭
"appkey": "ALPT_1234"
"ts": "20161114143116001"
"msgdgt": "BA9854BED1A2986B061E2713F403C752"
請(qǐng)求體
{
"requestId": "1234567890",
"telA": "13720056198",
"telX": "13720056199",
"telB": "13720056195",
"telC": "13720056196",
"subid": "100X571X0000000001",
"calltype": "10",
"callid": "14c821340104058b",
"callrecording": "0"
}
appkey
string
應(yīng)用id
M
ts
string
業(yè)務(wù)時(shí)間戳
M
格式y(tǒng)yyyMMddHHmmssSSS,時(shí)間采用北京時(shí)間,24小時(shí)制,精確至毫秒,不能與當(dāng)前標(biāo)準(zhǔn)時(shí)間相差超過(guò)5分鐘
msgdgt
string
簽名摘要
M
消息體的MD5摘要
requestId
string
業(yè)務(wù)id
M
消息請(qǐng)求標(biāo)識(shí)
telA
string
真實(shí)號(hào)碼
M
telX
string
小號(hào)號(hào)碼
M
telB
string
對(duì)端號(hào)碼
M
calltype
string
呼叫類型
M
AXB業(yè)務(wù):(針對(duì)被保護(hù)號(hào)碼A來(lái)分)
10:通話主叫
11:通話被叫
12:短信發(fā)送
13:短信接收
20:呼叫不允許
30:短信不允許
21: 未開(kāi)戶不允許
126: 雙呼
真實(shí)號(hào)碼為A
小號(hào)為X
對(duì)端號(hào)碼為B或者其它
callid
string
通話標(biāo)識(shí)
M
業(yè)務(wù)參考號(hào)
callrecording
string
錄音控制
M
同綁定接口定義
remark
string
接入商自有字段
0
接入商自有字段,如果請(qǐng)求中攜帶,則響應(yīng)中返回
響應(yīng)體
{
"code": "0",
"message": "success"
}