客户接口说明
1 接口说明 2
2 发送接口 2
2.1 调用接口 2
2.2 参数说明 2
2.3 请求和响应 3
2.3.1 SOAP 1.2请求 3
2.3.2 SOAP 1.2响应 4
2.3.3 HTTP POST请求 4
2.3.4 HTTP POST响应 4
3 余额接口 5
3.1 调用接口 5
3.2 参数说明 5
3.3 请求和响应 5
3.3.1 SOAP 1.2请求 6
3.3.2 SOAP 1.2响应 6
3.3.3 HTTP POST请求 7
3.3.4 HTTP POST响应 7
4 状态报告接口 8
4.1 调用接口 8
4.2 参数说明 8
4.3 请求和响应 8
4.3.1 SOAP 1.2请求 9
4.3.2 SOAP 1.2响应 9
4.3.3 HTTP POST请求 10
4.3.4 HTTP POST响应 10
5 上行回复接口 11
5.1 调用接口 11
5.2 参数说明 11
5.3 请求和响应 12
5.3.1 SOAP 1.2请求 12
5.3.2 SOAP 1.2响应 13
5.3.3 HTTP POST请求 14
5.3.4 HTTP POST响应 14
接口说明:客户接口部分提供WebService方式的接口,接口编码方式采用统一的UTF-8,如需HTTP协议接口,请联系客服
接口说明
请求地址是客户接口程序调用时请求的WebService地址,地址是
http://客户端地址/SmsWebService.asmx?wsdl
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
客户端地址 为域名或 IP:客户端端口
发送接口
调用接口
SendSms(string userid, string account, string password, string mobile, string content, string sendTime, string extno)
参数说明
参数名称
含义
说明
userid
企业id
企业ID
account
发送用户帐号
用户帐号
password
发送帐号密码
用户账号对应的密码
mobile
全部被叫号码
发信发送的目的号码.多个号码之间用半角逗号隔开
content
发送内容
短信的内容,内容需要UTF-8编码
sendTime
定时发送时间
为空表示立即发送,定时发送格式2010-10-24 09:08:10
extno
扩展子号
请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多10位数。
请求和响应
响应为WsSendResponse,具体定义如下:
元素名称
含义
说明
ReturnStatus
任务状态
Success 成功
Faild 失败
Message
描述
提交成功为 ok
其他为失败信息的描述
RemainPoint
剩余短信条数
剩余短信条数
TaskID
任务ID
每批次任务唯一的ID,用来匹配状态报告
SuccessCounts
成功条数
成功提交的号码数
SOAP 1.2请求
以下是 SOAP 1.2 请求和响应示例。所显示的占位符需替换为实际值。
POST /clientsite/SmsWebService.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
string
string
string
string
string
SOAP 1.2响应
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
int
int
int
HTTP POST请求
以下是 HTTP POST 请求和响应示例。所显示的占位符需替换为实际值。
POST /clientsite/SmsWebService.asmx/SendSms HTTP/1.1
Host: localhost
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userid=string&account=string&password=string&mobile=string&content=string&sendTime=string&extno=string
HTTP POST响应
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
string
int
int
int
余额接口
调用接口
QueryOverage(string userid, string account, string password)
参数说明
参数名称
含义
说明
userid
企业id
企业ID
account
用户帐号
用户帐号
password
帐号密码
用户账号对应的密码
请求和响应
响应为WsOverageResponse,具体定义如下:
元素名称
含义
说明
ReturnStatus
获取状态
Success 成功
Faild 失败
Message
描述
获取成功为 ok
其他为失败信息的描述
PayInfo
付费方式
预付费
后付费
Overage
余额
剩余余额
SendTotal
总条数
总充值条数
SOAP 1.2请求
以下是 SOAP 1.2 请求和响应示例。所显示的占位符需替换为实际值。
POST /clientsite/SmsWebService.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
string
SOAP 1.2响应
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
string
int