WebService接口详述

Webservice 接口地址：http(s)://www.51miaoxin.com/services/sendService?wsdl

---

自定义短信发送接口

所谓自定义接口，是指发送的内容、签名都可以有客户自定义完成，通过接口传递到秒信云平台。

方法

• /send

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览
param	√	SmsMtSubmitParam	短信发送请求参数封装对象
param.mobiles	√	string	接受短信用户的手机号码，多个手机用半角字符“,”分开。 如：“18600001111,18600002222”，每个手机号11位数字。 账号开启加密后手机号则为加密后的密文。
param.content	√	string	具体短信内容，以UTF-8方式传递。 如果要对mobiles 多个目标用户下发不同的内容，这里请注意保持数量跟mobiles 分割后的数量保持一致。 content 参数使用 “|||”分割，如"【测试】测试|||【测试2】测试2"。 如果mobiles 参数出现多个目标号码，但是content只有一个内容，那么所有目标号码将会发送同一样的内容。
param.ext		string	客户的自定义扩展号码，将会出现在发送号码的尾部，具体可以扩展的位数请提前商定，超出12位会返回错误。
param.ref		string	客户可以对提交的短信加入reference参数以便后续进行跟踪，设置的ref参数最终会被短信状态回调的时候同步给客户。

接口应答数据含义

变量名	类型	详细描述
response	SmsSubmitResponse	接口应答内容封装对象
response.code	integer	0代表成功，负数代表失败
response.msg	string	code状态对应的中文解释
response.total	integer	代表本次收到多少个短信发送请求，数量会和mobiles的手机号数量一致
response.result	array	状态的汇报信息是一个数组，会对每一个手机号码的下发请求做单独的汇报
response.result.code	integer	0代表成功 负数代表失败，详见第三章：错误代码对应表 此code仅代表单条号码发送状态的标记
response.result.msg	string	reports.code状态对应的中文解释
response.result.orderId	string	代表秒信系统平台的订单id，可以用此id做订单状态的查询，此id为纯数字，订单id的前六位同时代表年月日
response.result.mobile	string	发送的目标客户手机号码。账号开启加密后手机号则为加密后的密文。
response.result.receiveTime	string	秒信系统平台接收此下发需求的时间

固签发送接口

通过固定签名接口，发送预先规定好的签名，内容中可以不带签名。

方法

• /sendFixedSignature

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览
smsParam	√	SmsMtSubmitSignatureParam	短信发送请求参数封装对象
smsParam.signatureId	√	long	对应的签名ID，请登录秒信云控制台申请通过后方可使用
smsParam.mobiles	√	string	接受短信用户的手机号码，多个手机用半角字符“,”分开。 如：“18600001111,18600002222”，每个手机号11位数字。 账号开启加密后手机号则为加密后的密文。
param.content	√	string	具体短信内容，以UTF-8方式传递。 如果要对mobiles 多个目标用户下发不同的内容，这里请注意保持数量跟mobiles 分割后的数量保持一致。 content 参数使用 “|||”分割，如"【测试】测试|||【测试2】测试2"。 如果mobiles 参数出现多个目标号码，但是content只有一个内容，那么所有目标号码将会发送同一样的内容。
smsParam.ext		string	客户的自定义扩展号码，将会出现在发送号码的尾部，具体可以扩展的位数请提前商定，超出12位会返回错误。可以不填，填写就只能填数字。
smsParam.ref		string	客户可以对提交的短信加入reference参数以便后续进行跟踪，设置的ref参数最终会被短信状态回调的时候同步给客户。

接口应答数据含义

变量名	类型	详细描述
response	SmsSubmitResponse	接口应答内容封装对象
response.code	integer	0代表成功，负数代表失败
response.msg	string	code状态对应的中文解释
response.total	integer	代表本次收到多少个短信发送请求，数量会和mobiles的手机号数量一致
response.result	array	状态的汇报信息是一个数组，会对每一个手机号码的下发请求做单独的汇报
response.result.code	integer	0代表成功 负数代表失败，详见第三章：错误代码对应表 此code仅代表单条号码发送状态的标记
response.result.msg	string	reports.code状态对应的中文解释
response.result.orderId	string	代表秒信系统平台的订单id，可以用此id做订单状态的查询，此id为纯数字，订单id的前六位同时代表年月日
response.result.mobile	string	发送的目标客户手机号码。账号开启加密后手机号则为加密后的密文。
response.result.receiveTime	string	秒信系统平台接收此下发需求的时间

模板发送接口

通过模板发送接口，发送预先申请好模板的短信。

方法

• /sendTemplateParamd

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览
smsParam	√	SmsMtSubmitTemplateParam	短信发送请求参数封装对象
smsParam.templateId	√	long	对应的模板ID，请登录秒信云控制台申请通过后方可使用
smsParam.mobiles	√	string	接受短信用户的手机号码，多个手机用半角字符“,”分开。 如：“18600001111,18600002222”，每个手机号11位数字。 账号开启加密后手机号则为加密后的密文。
smsParam.ext		string	客户的自定义扩展号码，将会出现在发送号码的尾部，具体可以扩展的位数请提前商定，超出12位会返回错误。
smsParam.ref		string	客户可以对提交的短信加入reference参数以便后续进行跟踪，设置的ref参数最终会被短信状态回调的时候同步给客户。
smsParam.param1		string	自定义参数1，内容不超过20个汉字，与模板的变量数对应
smsParam.param2		string	自定义参数2，内容不超过20个汉字，与模板的变量数对应
smsParam.param3		string	自定义参数3，内容不超过20个汉字，与模板的变量数对应
smsParam.param4		string	自定义参数4，内容不超过20个汉字，与模板的变量数对应
smsParam.param5		string	自定义参数5，内容不超过20个汉字，与模板的变量数对应
smsParam.param6		string	自定义参数6，内容不超过20个汉字，与模板的变量数对应
smsParam.param7		string	自定义参数7，内容不超过20个汉字，与模板的变量数对应
smsParam.param8		string	自定义参数8，内容不超过20个汉字，与模板的变量数对应

接口应答数据含义

变量名	类型	详细描述
response	SmsSubmitResponse	接口应答内容封装对象
response.code	integer	0代表成功，负数代表失败
response.msg	string	code状态对应的中文解释
response.total	integer	代表本次收到多少个短信发送请求，数量会和mobiles的手机号数量一致
response.result	array	状态的汇报信息是一个数组，会对每一个手机号码的下发请求做单独的汇报
response.result.code	integer	0代表成功 负数代表失败，详见第三章：错误代码对应表 此code仅代表单条号码发送状态的标记
response.result.msg	string	reports.code状态对应的中文解释
response.result.orderId	string	代表秒信系统平台的订单id，可以用此id做订单状态的查询，此id为纯数字，订单id的前六位同时代表年月日
response.result.mobile	string	发送的目标客户手机号码。账号开启加密后手机号则为加密后的密文。
response.result.receiveTime	string	秒信系统平台接收此下发需求的时间

短信发送报告查询

方法

• /check

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览
orderIds	√	String	可以一次查询一个订单或者多个订单，多个订单号用半角字符“,”分开

接口应答数据含义

变量名	类型	详细描述
response	SmsReportResponse	接口应答内容封装对象
response.code	integer	0代表成功，负数代表失败
response.msg	string	code状态对应的中文解释
response.mtReportTotal	integer	代表本次收到多少个订单查询的请求
response.mtReports	array	汇报内容是一个数组，会对每一个订单的下发请求做单独的详情汇报
response.mtReports.orderId	string	短信提交成功后的订单id
response.mtReports.mobile	string	订单对应下发的目标手机号码。账号开启加密后手机号则为加密后的密文。
response.mtReports.status	integer	状态报告：负数代表平台驳回，详见第三章：错误代码对应表, 0代表平台收到消息，还在处理, 1代表最终发送成功, 2代表测试状态模拟成功, 3代表正在发送中（未回状态）, 大于3代表运营商反馈发送失败
response.mtReports.msg	string	reports.status对应的中文解释
response.mtReports.requestTime	string	状态报告的时间
response.mtReports.pieces	integer	如果遇到长文本短信，会把一条短信拆成多次计费，pieces代表计费几次
response.mtReports.ext	string	扩展号
response.mtReports.ref	string	reference参数（如果有则返回）

短信状态及上行拉取

客户主动拉取，每次返回最多100条 建议客户3秒拉取一次，如果返回100条可以不停立刻继续 数据保留一星期，一个星期不拉取，自动删除

方法

• /pull

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览

接口应答数据含义

变量名	类型	详细描述
response	SmsReportResponse	接口应答内容封装对象
response.total	integer	代表本次返回多少个信息状态,上下行状态总和
response.mtReportTotal	integer	代表本次返回多少个下行MT信息状态
response.moReportTotal	integer	代表本次返回多少个上行MO信息状态
response.mtReports	array	汇报内容是一个数组，会对每一个订单的下发请求做单独的详情汇报
response.moReports	array	汇报内容是一个数组，记录每一条上行状态的详细信息
response.mtReports.order_id	string	短信提交成功后的订单id
response.mtReports.mobile	string	订单对应下发的目标手机号码
response.mtReports.status	integer	状态报告：负数代表平台驳回，详见第三章：错误代码对应表, 0代表平台收到消息，还在处理, 1代表最终发送成功, 2代表测试状态模拟成功, 3代表正在发送中（未回状态）, 大于3代表运营商反馈发送失败
response.mtReports.msg	string	reports.status对应的中文解释
response.mtReports.receive_time	string	状态报告的时间
response.mtReports.pieces	integer	如果遇到长文本短信，会把一条短信拆成多次计费，pieces代表计费几次
response.mtReports.ext	string	扩展号
response.mtReports.ref	string	reference参数（如果有则返回）
response.moReports.user_mobile	string	用户上行的手机号码
response.moReports.user_content	integer	用户上行的内容
response.moReports.channel_num	string	上行的通道号码
response.moReports.mo_time	string	上行时间

账号余额查询

方法

• /getBalance

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览

接口应答数据含义

变量名	类型	详细描述
response	SmsBalanceResponse	接口应答内容封装对象
response.code	integer	code 大于等于0 代表成功，负数是失败
response.msg	string	code对应的中文解释
response.money	integer	money代表剩余金额，单位为厘,1元=1000厘
response.RMB	string	对应RMB元的描述字符,如：99.99元

账号发送量查询

通过接口查询账号在近期的发送量情况。注意：统计数据会有延迟，此接口返回数据仅供参考，不做严格对账用。

方法

• /getSmsStats

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览
dateStart	x	string	yyyy-MM-dd格式日期，为空前一天，支持30天内结果查询。
dateEnd	x	string	yyyy-MM-dd格式日期，为空取dateStart，支持30天内结果查询，不可在dateStart前。

接口应答数据含义

变量名	类型	详细描述
response	SmsStatResponse	接口应答内容封装对象
response.code	integer	code 大于等于0 代表成功，负数是失败
response.msg	string	code对应的中文解释
response.reports	string	JSON数组，每个元素对应一天的统计结果
response.reports.date	string	天 yyyy-MM-dd 格式
response.reports.submitCount	integer	提交条数
response.reports.submitPiece	integer	提交计费条数
response.reports.successCount	integer	成功条数
response.reports.successPiece	integer	成功计费条数
response.reports.failCount	integer	失败条数
response.reports.failPiece	integer	失败计费条数
response.reports.errorCount	integer	驳回条数
response.reports.errorPiece	integer	驳回计费条数
response.reports.unknownCount	integer	未知条数
response.reports.unknownPiece	integer	未知计费条数

注1：Count与Piece的区别, 主要在长短信里，如1条长短信计费为3片（比如150个字），则Count为1、Piece为3。Piece条数参与计费、扣费。

注2：fail与error区别, error为系统驳回，不会计费扣费；fail为通道回执告知发送失败，参与扣费返款。

注3：submit=success + fail + error + unknown。

服务器时间查询

由于接口协议会验证时间有效性，超过10秒钟的请求会被抛弃，所以确保服务器之间时间同步，通过下面接口可以获取到秒信平台服务器上面的时间。用于跟客户方服务器时间做比对。

方法

• /serverTime
• 无需参数

接口应答数据含义

接口应答（两行）：
    2016-12-22 10:40:32 
    1482374432123

    第一行：yyyy-MM-dd HH:mm:ss
    第二行：时间戳