語音通知接口文檔v2.5

互億無線語音通知APIv2.5中國·上海4008808898互億無線語音通知APIv2.5接口說明文件標識Ihuyi_Voice_NoticeAPI版本編號V2.5發(fā)布者上海思銳信息技術有限公司發(fā)布日期2012-07-18最新更新2022-07-07

目錄TOC\o"1-3"\h\u1.概要 31.1文檔說明 31.2接口內(nèi)容 31.3提交方式 31.4加密方式 31.5APIID/APIKEY 31.6語音通知模版 32.語音通知發(fā)送 42.1接口描述 42.2請求地址 42.3請求參數(shù) 42.4響應示例 52.5響應參數(shù) 52.6GET請求示例 63.發(fā)送回執(zhí)推送 63.1接口描述 63.2推送參數(shù) 64.提交模板 74.1接口描述 74.2請求地址 84.3請求參數(shù) 84.4響應參數(shù) 84.5模板審核狀態(tài)推送 95.刪除模板 95.1接口描述 95.2請求地址 95.3請求參數(shù) 105.4響應參數(shù) 106.余額查詢 116.1接口描述 116.2請求地址 116.3請求參數(shù) 116.4響應示例 116.5響應參數(shù) 126.6GET請求示例 127.生成動態(tài)密碼方式 128.常見問題 138.1如何實現(xiàn)UNIX時間戳 139.語音通知DEMO 1410.聯(lián)系方式 151.概要1.1文檔說明本文檔主要提供給互億平臺的用戶對接接口的使用說明，開發(fā)者可以利用ihuyi提供的HTTP接口，調(diào)用ihuyi的語音通知服務。1.2接口內(nèi)容本文檔包含語音通知發(fā)送、余額查詢等。1.3提交方式GET/POST1.4加密方式1、采用HTTPS協(xié)議提交請求2、通過MD5動態(tài)簽名方式加密1.5APIID/APIKEY登錄用戶中心，進入【語音通知】模塊，在【產(chǎn)品總攬】頁面右上角，如下圖所示：1.6語音通知模版語音通知模板是對您將要發(fā)送的語音進行相似性提取后的內(nèi)容。舉個例子，A用戶是您的老會員，即將過生日，需要發(fā)送一條語音短信，內(nèi)容如下：您的客戶張茜將于2天后過生日，別忘記注意祝福哦~同時，B用戶是您的老會員，即將過生日，發(fā)送了如下語音短信：您的客戶趙鑫將于3天后過生日，別忘記注意祝福哦~我們提取相似度以后，可以制作以下語音模板：您的客戶【變量】將于【變量】天后過生日，別忘記注意祝福哦~其中，變量是可變的，可以是數(shù)字、字母、漢字。2.語音通知發(fā)送2.1接口描述通過POST、GET方式進行短信提交，數(shù)據(jù)編碼采用utf-8格式，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded，24小時全天發(fā)送。2.2請求地址/webservice/voice.php?method=Submit2.3請求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）是password1、APIKEY（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）是mobile支持中國內(nèi)地手機號碼及固話號碼。手機號：11位，示例：139****0000。固話號碼：{區(qū)號}{號碼}，示例：02151****29。接收手機號碼，只能提交一個號碼是content語音通知內(nèi)容（編碼格式為UTF-8）例如：您的訂單號是：9633。已由順風快遞發(fā)出，請注意查收。是timeUnix時間戳（10位整型數(shù)字，當使用動態(tài)密碼方式時為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認為xml）否用戶通過http或https提交發(fā)送短信請求到服務器后，服務器會返回一串xml格式的字符串，SubmitResult結(jié)構說明如下：參數(shù)名稱類型描述codeint返回值為2時，表示提交成功voiceidstring當提交成功后，此字段為流水號，否則為0msgstring提交結(jié)果描述2.4響應示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>2</code><msg>提交成功</msg><voiceid>60495654</voiceid></SubmitResult>示例（失?。?lt;?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>405</code><msg>用戶名或密碼不正確</msg><voiceid>0</voiceid></SubmitResult>2.5響應參數(shù)codemsg0提交失敗2提交成功400非法ip訪問401帳號不能為空402密碼不能為空403手機號碼不能為空4030手機號碼已被列入黑名單404語音內(nèi)容不能為空405用戶名或密碼不正確4050賬號被凍結(jié)4051剩余條數(shù)不足4052訪問ip與備案ip不符406手機格式不正確4071沒有提交備案模板4072提交的語音內(nèi)容必須與報備過的模板格式相匹配40722變量內(nèi)容超過指的的長度4077發(fā)送內(nèi)容未在運營商報備408您的帳戶疑被惡意利用，已被自動凍結(jié)，如有疑問請與客服聯(lián)系4080同一手機號碼同一秒鐘之內(nèi)發(fā)送頻率不能超過1條4081同一手機號一分鐘之內(nèi)發(fā)送超過3條4082超出同一手機號一天之內(nèi)10條短信限制2.6GET請求示例/webservice/voice.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=您的訂單號是：0648。已由順風快遞發(fā)出，請注意查收。3.發(fā)送回執(zhí)推送3.1接口描述用戶先提供數(shù)據(jù)接收地址，然后綁定到互億無線系統(tǒng)后臺，平臺會以POST方式實時的將回執(zhí)信息推送到此地址，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。注意：接口推送后請記錄數(shù)據(jù)并及時返回結(jié)果，業(yè)務邏輯采用異步處理，避免接口響應超時而導致重復推送。3.2推送參數(shù)參數(shù)名稱參數(shù)值描述code狀態(tài)值（2成功0失敗）msg回執(zhí)狀態(tài)說明mobilephone手機號碼talktime接聽時間（秒）voiceid流水號（對應提交時返回的voiceid）report_time回執(zhí)時間例：2018-05-2417:46:50注意:成功接收請輸出字符“success”（不包含引號）結(jié)束推送，否則以接收失敗處理。每個回執(zhí)最多推送3次。每次間隔疊加60秒。code參數(shù)說明codemsg2成功0未知錯誤-1關機-2停機-3暫時無法接通-4正在通話-5空號-6無人接聽-8呼入限制-9網(wǎng)絡忙-10呼出限制-11線路忙-12用戶拒接4.提交模板4.1接口描述通過POST、GET方式提交短信模版，數(shù)據(jù)編碼采用utf-8格式，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。4.2請求地址/webservice/voice.php?method=AddTemplate&account=APIID&password=APIKEY&content=您的訂單號是：【變量】。已由順風快遞發(fā)出，請注意查收。4.3請求參數(shù)參數(shù)名稱參數(shù)值描述methodAddTemplateaccountAPIID（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）password1、APIKEY（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）模板內(nèi)容模板內(nèi)容返回值AddTemplateResult結(jié)構說明：參數(shù)名稱類型描述codeint返回值為2時，表示添加成功msgstring提交狀態(tài)描述templateidint添加成功則返回模板ID4.4響應參數(shù)codemsg2添加成功400提交狀態(tài)描述401添加成功則返回模板ID402密碼不能為空404模板內(nèi)容不能為空405用戶名或密碼不正確4050賬號被凍結(jié)407模板內(nèi)容含有敏感字符408模板己存在4.5模板審核狀態(tài)推送在遵守HTTP協(xié)議規(guī)范的前提下，通過POST方式將回執(zhí)推送到用戶指定的URL地址。注意：接口推送后請記錄數(shù)據(jù)并及時返回結(jié)果，業(yè)務邏輯采用異步處理，避免接口響應超時而導致重復推送。參數(shù)說明：參數(shù)名稱參數(shù)值描述code狀態(tài)值（2成功0駁回）msg審核狀態(tài)描述templateid模板ID注意：1.成功接收請輸出字符“success”（不包含引號）結(jié)束推送，否則以接收失敗處理。2.每個回執(zhí)最多推送3次。每次間隔疊加60秒。3.code值說明2成功0駁回（原因請看msg字段）5.刪除模板5.1接口描述通過POST、GET方式提交短信模版，數(shù)據(jù)編碼采用utf-8格式，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。5.2請求地址/webservice/voice.php?method=DelTemplate&account=APIID&password=APIKEY&templateid=1235.3請求參數(shù)參數(shù)名稱參數(shù)值描述methodDelTemplateaccountAPIID（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）password1、APIKEY（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）templateid模板id返回值AddTemplateResult結(jié)構說明：參數(shù)名稱類型描述codeint返回值為2時，表示刪除成功msgstring提交狀態(tài)描述5.4響應參數(shù)codemsg2刪除成功400非法ip訪問401用戶名不能為空402密碼不能為空404模板ID不能為空或模板ID不存在405用戶名或密碼不正確4050賬號被凍結(jié)6.余額查詢6.1接口描述通過接口可以方便的查詢你的賬戶語音通知剩余條數(shù)。6.2請求地址/webservice/voice.php?method=GetNum6.3請求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）是password1、APIKEY（請登錄用戶中心【語音通知】-【產(chǎn)品總覽】查看）2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）是timeUnix時間戳（10位整型數(shù)字，當使用動態(tài)密碼方式時為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認為xml）否用戶通過http或https提交帳戶余額查詢請求到服務器后，服務器會返回一串xml格式的字符串，GetNumResult結(jié)構說明如下：參數(shù)名稱類型描述codeint狀態(tài)返回值msgstring查詢結(jié)果描述numstring剩余數(shù)量6.4響應示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns=""><code>2</code><msg>查詢成功</msg><voiceid>856</voiceid></GetNumResult>示例（失敗）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns=""><code>405</code><msg>用戶名或密碼不正確</msg><num>0</num></GetNumResult>6.5響應參數(shù)codemsg2查詢成功400非法ip訪問401帳號不能為空402密碼不能為空405用戶名或密碼不正確4050賬號被凍結(jié)6.6GET請求示例/webservice/voice.php?method=GetNum&account=APIID&password=APIKEY7.生成動態(tài)密碼方式以PHP為例，提交語音的生成方式：$time=time();$password=md5($account.$apikey.$mobile.$content.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機號：138xxxxxxxx內(nèi)容：1125time：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx11251451544941');查詢剩余條數(shù)的生成方式：$time=time();$password=md5($account.$apikey.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機號：138xxxxxxxxtime：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');Unix時間戳參考地址：/Tools/unixtime.aspx8.常見問題8.1如何實現(xiàn)UNIX時間戳語言代碼JAVAStringdate=newjava.text.SimpleDateFormat("dd/MM/yyyyHH:mm:ss").format(newjava.util.Date(Unixtimestamp*1000))Linuxdate-d@UnixtimestampCstrptime(datetime,"%Y-%m-%d%H:%M:%S",&tm_time);unixtime=mktime(&tm_time);C++std::time_tt=std::time(0);DELPHIusesDateUtils;DateTimeToUnix(Now)GOimport"time"cur:=time.Now()timestamp:=cur.UnixNano()/1000000Perl先my$time=Unixtimestamp然后my($sec,$min,$hour,$day,$month,$year)=(localtime($time))[0,1,2,3,4,5,6]PHPdate('r',Unixtimestamp)Node.jsvardate=newDate(time*1000);vartime=date.