短信平臺接口文檔說明書
2018-06-18 20:05:09 作者:必到牌軟件
瘦身必到牌軟件短信平臺接口說明
對接的時候有個參數(shù)userid 就是開賬號前面的客戶id


客戶接口說明 1
第一章 發(fā)送接口 2
1.1 請求地址 2
1.2參數(shù)說明 2
1.3返回值 2
第二章 余額及已發(fā)送量查詢接口 3
2.1 請求地址 3
2.2參數(shù)說明 3
2.3返回值 3
第三章 非法關(guān)鍵詞查詢 4
3.1 請求地址 4
3.2參數(shù)說明 4
3.3返回值 4
第四章 狀態(tài)報告接口 5
4.1 請求地址 5
4.2參數(shù)說明 5
4.3返回值 5
4.4錯誤返回值——狀態(tài)報告請求錯誤返回格式及對應(yīng)值 6
第五章 上行接口 6
5.1 請求地址 6
5.2參數(shù)說明 6
5.3返回值 7
5.4錯誤返回值——回復(fù)請求錯誤返回格式及對應(yīng)值 7


接口說明:客戶接口部分提供http url方式的接口,根據(jù)客戶需求可以提供相應(yīng)接口,接口編碼方式采用統(tǒng)一的UTF-8
第一章 發(fā)送接口
1.1 請求地址
請求地址是客戶接口程序調(diào)用時請求的url地址,采用的是http post 接口,地址是
http://bidaoda.com/sms.aspx 對應(yīng)UTF-8
http://bidaoda.com/smsGBK.aspx 對應(yīng)GB2312
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
1.2參數(shù)說明
http://bidaoda.com/sms.aspx
http://bidaoda.com/smsGBK.aspx
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 發(fā)送用戶帳號 用戶帳號,由系統(tǒng)管理員
password 發(fā)送帳號密碼 用戶賬號對應(yīng)的密碼
mobile 全部被叫號碼 發(fā)信發(fā)送的目的號碼.多個號碼之間用半角逗號隔開
content 發(fā)送內(nèi)容 短信的內(nèi)容,內(nèi)容需要UTF-8編碼
sendTime 定時發(fā)送時間 為空表示立即發(fā)送,定時發(fā)送格式2010-10-24 09:08:10
action 發(fā)送任務(wù)命令 設(shè)置為固定的:send
extno 擴展子號 請先詢問配置的通道是否支持擴展子號,如果不支持,請?zhí)羁�。子號只能為�?shù)字,且最多5位數(shù)。
例如:
action=send&userid=12&account=賬號&password=密碼&mobile=15023239810&content=內(nèi)容&sendTime=&extno=
1.3返回值
在接收到客戶端發(fā)送的http請求后,返回以xml的方式返回處理結(jié)果。格式為:


status---------- 返回狀態(tài)值:成功返回Success 失敗返回:Faild
message---------- 返回信息:見下表
remainpoint---------- 返回余額
taskID----------- 返回本次任務(wù)的序列ID
successCounts--成功短信數(shù):當成功后返回提交成功短信數(shù)
返回信息提示 說明
ok 提交成功
用戶名或密碼不能為空 提交的用戶名或密碼為空
發(fā)送內(nèi)容包含sql注入字符 包含sql注入字符
用戶名或密碼錯誤 表示用戶名或密碼錯誤
短信號碼不能為空 提交的被叫號碼為空
短信內(nèi)容不能為空 發(fā)送內(nèi)容為空
包含非法字符: 表示檢查到不允許發(fā)送的非法字符
對不起,您當前要發(fā)送的量大于您當前余額 當支付方式為預(yù)付費是,檢查到賬戶余額不足
其他錯誤 其他數(shù)據(jù)庫操作方面的錯誤
第二章 余額及已發(fā)送量查詢接口
2.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/sms.aspx
http://bidaoda.com/smsGBK.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
2.2參數(shù)說明
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:overage
例如:
action=overage&userid=12&account=賬號&password=密碼
2.3返回值
status-------返回狀態(tài)值:成功返回Success 失敗返回:Faild
message--------------返回信息提示:見下表
payinfo--------------返回支付方式 后付費,預(yù)付費
overage-------------返回余額
sendTotal----返回總點數(shù) 當支付方式為預(yù)付費是返回總充值點數(shù)
返回信息提示 說明
返回空 查詢成功
將返回相應(yīng)的支付方式、賬戶使用條數(shù)、總充值點數(shù)
用戶名或密碼不能為空 提交的用戶名或密碼為空
用戶名或密碼錯誤 表示用戶名或密碼錯誤
第三章 非法關(guān)鍵詞查詢
3.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/sms.aspx
http://bidaoda.com/smsGBK.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
3.2參數(shù)說明

參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:checkkeyword
content 檢測發(fā)送內(nèi)容 需要發(fā)送的內(nèi)容
例如:
action=checkkeyword&userid=12&account=賬號&password=密碼&content=內(nèi)容
3.3返回值
message--------------返回信息提示:見下表
返回信息提示 說明
用戶名或密碼不能為空 提交的用戶名或密碼為空
用戶名或密碼錯誤 表示用戶名或密碼錯誤
包含非法字符 檢查出來包含非法關(guān)鍵詞
未包含非法字符 未檢查出非法關(guān)鍵詞


第四章 狀態(tài)報告接口
4.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/statusApi.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
4.2參數(shù)說明
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:query
例如:
action=query&userid=12&account=賬號&password=密碼
4.3返回值


15023239810-------------對應(yīng)的手機號碼
1212-------------同一批任務(wù)ID
10---------狀態(tài)報告----10:發(fā)送成功,20:發(fā)送失敗
2011-12-02 22:12:11-------------接收時間
MK:0011-------------狀態(tài)返回值
15023239811
1212
20
2011-12-02 22:12:11
DELIVRD-------------狀態(tài)返回值

4.4錯誤返回值——狀態(tài)報告請求錯誤返回格式及對應(yīng)值
1-------------錯誤碼
用戶名或密碼不能為空-------------錯誤描述
1:用戶名或密碼不能為空
2:用戶名或密碼錯誤
3:該用戶不允許查看狀態(tài)報告
4:參數(shù)不正確


第五章 上行接口
5.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/callApi.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
5.2參數(shù)說明
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:query
例如:
action=query&userid=12&account=賬號&password=密碼
5.3返回值


15023239810-------------對應(yīng)的手機號碼
1212-------------同一批任務(wù)ID
你好,我不需要---------上行內(nèi)容
2011-12-02 22:12:11-------------接收時間
15023239811
1212
你好,本次活動路線是怎么的
2011-12-02 22:12:11
5.4錯誤返回值——回復(fù)請求錯誤返回格式及對應(yīng)值
1-------------錯誤碼
用戶名或密碼不能為空-------------錯誤描述


1:用戶名或密碼不能為空
2:用戶名或密碼錯誤
3:該用戶不允許查看狀態(tài)報告
4:參數(shù)不正確




對接的時候有個參數(shù)userid 就是開賬號前面的客戶id

客戶接口說明 1
第一章 發(fā)送接口 2
1.1 請求地址 2
1.2參數(shù)說明 2
1.3返回值 2
第二章 余額及已發(fā)送量查詢接口 3
2.1 請求地址 3
2.2參數(shù)說明 3
2.3返回值 3
第三章 非法關(guān)鍵詞查詢 4
3.1 請求地址 4
3.2參數(shù)說明 4
3.3返回值 4
第四章 狀態(tài)報告接口 5
4.1 請求地址 5
4.2參數(shù)說明 5
4.3返回值 5
4.4錯誤返回值——狀態(tài)報告請求錯誤返回格式及對應(yīng)值 6
第五章 上行接口 6
5.1 請求地址 6
5.2參數(shù)說明 6
5.3返回值 7
5.4錯誤返回值——回復(fù)請求錯誤返回格式及對應(yīng)值 7

接口說明:客戶接口部分提供http url方式的接口,根據(jù)客戶需求可以提供相應(yīng)接口,接口編碼方式采用統(tǒng)一的UTF-8
第一章 發(fā)送接口
1.1 請求地址
請求地址是客戶接口程序調(diào)用時請求的url地址,采用的是http post 接口,地址是
http://bidaoda.com/sms.aspx 對應(yīng)UTF-8
http://bidaoda.com/smsGBK.aspx 對應(yīng)GB2312
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
1.2參數(shù)說明
http://bidaoda.com/sms.aspx
http://bidaoda.com/smsGBK.aspx
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 發(fā)送用戶帳號 用戶帳號,由系統(tǒng)管理員
password 發(fā)送帳號密碼 用戶賬號對應(yīng)的密碼
mobile 全部被叫號碼 發(fā)信發(fā)送的目的號碼.多個號碼之間用半角逗號隔開
content 發(fā)送內(nèi)容 短信的內(nèi)容,內(nèi)容需要UTF-8編碼
sendTime 定時發(fā)送時間 為空表示立即發(fā)送,定時發(fā)送格式2010-10-24 09:08:10
action 發(fā)送任務(wù)命令 設(shè)置為固定的:send
extno 擴展子號 請先詢問配置的通道是否支持擴展子號,如果不支持,請?zhí)羁�。子號只能為�?shù)字,且最多5位數(shù)。
例如:
action=send&userid=12&account=賬號&password=密碼&mobile=15023239810&content=內(nèi)容&sendTime=&extno=
1.3返回值
在接收到客戶端發(fā)送的http請求后,返回以xml的方式返回處理結(jié)果。格式為:

status---------- 返回狀態(tài)值:成功返回Success 失敗返回:Faild
message---------- 返回信息:見下表
remainpoint---------- 返回余額
taskID----------- 返回本次任務(wù)的序列ID
successCounts--成功短信數(shù):當成功后返回提交成功短信數(shù)
返回信息提示 說明
ok 提交成功
用戶名或密碼不能為空 提交的用戶名或密碼為空
發(fā)送內(nèi)容包含sql注入字符 包含sql注入字符
用戶名或密碼錯誤 表示用戶名或密碼錯誤
短信號碼不能為空 提交的被叫號碼為空
短信內(nèi)容不能為空 發(fā)送內(nèi)容為空
包含非法字符: 表示檢查到不允許發(fā)送的非法字符
對不起,您當前要發(fā)送的量大于您當前余額 當支付方式為預(yù)付費是,檢查到賬戶余額不足
其他錯誤 其他數(shù)據(jù)庫操作方面的錯誤
第二章 余額及已發(fā)送量查詢接口
2.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/sms.aspx
http://bidaoda.com/smsGBK.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
2.2參數(shù)說明
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:overage
例如:
action=overage&userid=12&account=賬號&password=密碼
2.3返回值
status-------返回狀態(tài)值:成功返回Success 失敗返回:Faild
message--------------返回信息提示:見下表
payinfo--------------返回支付方式 后付費,預(yù)付費
overage-------------返回余額
sendTotal----返回總點數(shù) 當支付方式為預(yù)付費是返回總充值點數(shù)
返回信息提示 說明
返回空 查詢成功
將返回相應(yīng)的支付方式、賬戶使用條數(shù)、總充值點數(shù)
用戶名或密碼不能為空 提交的用戶名或密碼為空
用戶名或密碼錯誤 表示用戶名或密碼錯誤
第三章 非法關(guān)鍵詞查詢
3.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/sms.aspx
http://bidaoda.com/smsGBK.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
3.2參數(shù)說明

參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:checkkeyword
content 檢測發(fā)送內(nèi)容 需要發(fā)送的內(nèi)容
例如:
action=checkkeyword&userid=12&account=賬號&password=密碼&content=內(nèi)容
3.3返回值
message--------------返回信息提示:見下表
返回信息提示 說明
用戶名或密碼不能為空 提交的用戶名或密碼為空
用戶名或密碼錯誤 表示用戶名或密碼錯誤
包含非法字符 檢查出來包含非法關(guān)鍵詞
未包含非法字符 未檢查出非法關(guān)鍵詞

第四章 狀態(tài)報告接口
4.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/statusApi.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
4.2參數(shù)說明
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:query
例如:
action=query&userid=12&account=賬號&password=密碼
4.3返回值

15023239810-------------對應(yīng)的手機號碼
1212-------------同一批任務(wù)ID
10---------狀態(tài)報告----10:發(fā)送成功,20:發(fā)送失敗
2011-12-02 22:12:11-------------接收時間
MK:0011-------------狀態(tài)返回值
15023239811
1212
20
2011-12-02 22:12:11
DELIVRD-------------狀態(tài)返回值
4.4錯誤返回值——狀態(tài)報告請求錯誤返回格式及對應(yīng)值
1-------------錯誤碼
用戶名或密碼不能為空-------------錯誤描述
1:用戶名或密碼不能為空
2:用戶名或密碼錯誤
3:該用戶不允許查看狀態(tài)報告
4:參數(shù)不正確

第五章 上行接口
5.1 請求地址
請求地址是客戶接口程序調(diào)用的時候請求的url地址,采用的是http post接口,地址是
http://bidaoda.com/callApi.aspx
入口地址一般不會發(fā)生變化,當發(fā)生變化的時候,會通知接口用戶
5.2參數(shù)說明
參數(shù)名稱 含義 說明
userid 企業(yè)id 企業(yè)ID
account 用戶帳號 用戶帳號,由系統(tǒng)管理員
password 帳號密碼 用戶賬號對應(yīng)的密碼
action 任務(wù)名稱 設(shè)置為固定的:query
例如:
action=query&userid=12&account=賬號&password=密碼
5.3返回值

15023239810-------------對應(yīng)的手機號碼
1212-------------同一批任務(wù)ID
你好,我不需要---------上行內(nèi)容
2011-12-02 22:12:11-------------接收時間
15023239811
1212
你好,本次活動路線是怎么的
2011-12-02 22:12:11
5.4錯誤返回值——回復(fù)請求錯誤返回格式及對應(yīng)值
1-------------錯誤碼
用戶名或密碼不能為空-------------錯誤描述

1:用戶名或密碼不能為空
2:用戶名或密碼錯誤
3:該用戶不允許查看狀態(tài)報告
4:參數(shù)不正確




- 上一篇:會員短信營銷廣告話術(shù)模板怎么寫?(精選6條) [2018-06-18]
- 下一篇:裝飾公司營銷短信話術(shù)模板如何寫效果才好 [2018-06-18]




