企信通短信平台接口文檔

客戶接口說明

客戶接口說明 1

第一章 發送接口 2

1.1 請求位址 2

1.2參數說明 2

1.3傳回值 2

第二章 餘額及已發送量查詢接口 3

2.1 請求位址 3

2.2參數說明 3

2.3傳回值 3

第三章 非法關鍵詞查詢 4

3.1 請求位址 4

3.2參數說明 4

3.3傳回值 4

第四章 狀态報告接口 5

4.1 請求位址 5

4.2參數說明 5

4.3傳回值 5

4.4錯誤傳回值——狀态報告請求錯誤傳回格式及對應值 6

第五章 上行接口 6

5.1 請求位址 6

5.2參數說明 6

5.3傳回值 7

5.4錯誤傳回值——回複請求錯誤傳回格式及對應值 7

接口說明：客戶接口部分提供http url方式的接口，根據客戶需求可以提供相應接口，接口編碼方式采用統一的UTF-8

第一章 發送接口

1.1 請求位址

請求位址是客戶接口程式調用時請求的url位址，采用的是http post 接口，位址是

http://114.55.11.126:8888/sms.aspx 對應UTF-8

入口位址一般不會發生變化，當發生變化的時候，會通知接口使用者

1.2參數說明

http:// 114.55.11.126:8888/sms.aspx

參數名稱 含義 說明

userid 企業id 企業ID

account 發送使用者帳号 使用者帳号，由系統管理者

password 發送帳号密碼 使用者賬号對應的密碼

mobile 全部被叫号碼 發信發送的目的号碼.多個号碼之間用半形逗號隔開

content 發送内容 短信的内容，内容需要UTF-8編碼

sendTime 定時發送時間 為空表示立即發送，定時發送格式2010-10-24 09:08:10

action 發送任務指令 設定為固定的:send

extno 擴充子号 請先詢問配置的通道是否支援擴充子号，如果不支援，請填空。子号隻能為數字，且最多5位數。

例如：

action=send&userid=12&account=賬号&password=密碼&mobile=,&content=内容&sendTime=&extno=

1.3傳回值

在接收到用戶端發送的http請求後，傳回以xml的方式傳回處理結果。格式為：

<?xml version="1.0" encoding="utf-8" ?> status ---------- 傳回狀态值：成功傳回Success 失敗傳回：Faild message ---------- 傳回資訊：見下表 remainpoint ---------- 傳回餘額

taskID ----------- 傳回本次任務的序列ID

successCounts --成功短信數：當成功後傳回送出成功短信數

傳回資訊提示 說明

Ok 送出成功

使用者名或密碼不能為空 送出的使用者名或密碼為空

發送内容包含sql注入字元 包含sql注入字元

使用者名或密碼錯誤 表示使用者名或密碼錯誤

短信号碼不能為空 送出的被叫号碼為空

短信内容不能為空 發送内容為空

包含非法字元： 表示檢查到不允許發送的非法字元

對不起，您目前要發送的量大于您目前餘額 當支付方式為預付費是，檢查到賬戶餘額不足

其他錯誤 其他資料庫操作方面的錯誤

第二章 餘額及已發送量查詢接口

2.1 請求位址

請求位址是客戶接口程式調用的時候請求的url位址，采用的是http post接口，位址是

http://www.idlmar.com

入口位址一般不會發生變化，當發生變化的時候，會通知接口使用者

2.2參數說明

參數名稱 含義 說明

userid 企業id 企業ID

account 使用者帳号 使用者帳号，由系統管理者

password 帳号密碼 使用者賬号對應的密碼

action 任務名稱 設定為固定的：overage

例如：

action=overage&userid=12&account=賬号&password=密碼

2.3傳回值

<?xml version="1.0" encoding="utf-8" ?> status-------傳回狀态值：成功傳回Success 失敗傳回：Faild message--------------傳回資訊提示：見下表 payinfo--------------傳回支付方式 後付費，預付費 overage-------------傳回餘額 sendTotal----傳回總點數 當支付方式為預付費是傳回總充值點數

傳回資訊提示 說明

傳回空 查詢成功

将傳回相應的支付方式、賬戶使用條數、總充值點數

使用者名或密碼不能為空 送出的使用者名或密碼為空

使用者名或密碼錯誤 表示使用者名或密碼錯誤

第三章 非法關鍵詞查詢

3.1 請求位址

請求位址是客戶接口程式調用的時候請求的url位址，采用的是http post接口，位址是

http:// 114.55.11.126:8888/sms.aspx

入口位址一般不會發生變化，當發生變化的時候，會通知接口使用者

3.2參數說明

參數名稱 含義 說明

userid 企業id 企業ID

account 使用者帳号 使用者帳号，由系統管理者

password 帳号密碼 使用者賬号對應的密碼

action 任務名稱 設定為固定的：checkkeyword

content 檢測發送内容 需要發送的内容

例如：

action=checkkeyword&userid=12&account=賬号&password=密碼&content=内容

3.3傳回值

<?xml version="1.0" encoding="utf-8" ?> message--------------傳回資訊提示：見下表

傳回資訊提示 說明

使用者名或密碼不能為空 送出的使用者名或密碼為空

使用者名或密碼錯誤 表示使用者名或密碼錯誤

包含非法字元 檢查出來包含非法關鍵詞

未包含非法字元 未檢查出非法關鍵詞

第四章 狀态報告接口

4.1 請求位址

請求位址是客戶接口程式調用的時候請求的url位址，采用的是http post接口，位址是

http:// 114.55.11.126:8888/statusApi.aspx

入口位址一般不會發生變化，當發生變化的時候，會通知接口使用者

4.2參數說明

參數名稱 含義 說明

userid 企業id 企業ID

account 使用者帳号 使用者帳号，由系統管理者

password 帳号密碼 使用者賬号對應的密碼

action 任務名稱 設定為固定的：query

例如：

action=query&userid=12&account=賬号&password=密碼

4.3傳回值

<?xml version="1.0" encoding="utf-8" ?> 15023239810-------------對應的手機号碼 1212-------------同一批任務ID 10---------狀态報告----10：發送成功，20：發送失敗 2011-12-02 22:12:11-------------接收時間 DELIVRD-上級網關傳回值，不同網關傳回值不同，僅作為參考 1212 20 2011-12-02 22:12:11 2 4.4錯誤傳回值——狀态報告請求錯誤傳回格式及對應值 <?xml version="1.0" encoding="utf-8" ?> 1-------------錯誤碼 使用者名或密碼不能為空-------------錯誤描述 1：使用者名或密碼不能為空 2：使用者名或密碼錯誤 3：該使用者不允許檢視狀态報告 4：參數不正确

第五章 上行接口

5.1 請求位址

請求位址是客戶接口程式調用的時候請求的url位址，采用的是http post接口，位址是

http:// 114.55.11.126:8888/callApi.aspx

入口位址一般不會發生變化，當發生變化的時候，會通知接口使用者

5.2參數說明

參數名稱 含義 說明

userid 企業id 企業ID

account 使用者帳号 使用者帳号，由系統管理者

password 帳号密碼 使用者賬号對應的密碼

action 任務名稱 設定為固定的：query

例如：

action=query&userid=12&account=賬号&password=密碼

5.3傳回值

<?xml version="1.0" encoding="utf-8" ?> 15023239810-------------對應的手機号碼 1212-------------同一批任務ID 你好，我不需要---------上行内容 2011-12-02 22:12:11-------------接收時間 15023239811 1212 你好，本次活動路線是怎麼的 2011-12-02 22:12:11 5.4錯誤傳回值——回複請求錯誤傳回格式及對應值 <?xml version="1.0" encoding="utf-8" ?> 1-------------錯誤碼 使用者名或密碼不能為空-------------錯誤描述 1：使用者名或密碼不能為空 2：使用者名或密碼錯誤 3：該使用者不允許檢視狀态報告 4：參數不正确