创瑞---平台接口说明.doc

短信平台接口说明Version 1.1目录1普通短信发送41.1短信提交地址41.2参数定义41.3短信提交响应41.3.1格式说明51.3.2示例51.3.3响应状态值说明51.4短信发送例子62个性短信发送62.1短信提交地址62.2参数定义62.3短信提交响应72.3.1格式说明72.3.2示例73状态报告推送73.1参数定义83.2状态报告值83.3示例84短信接收94.1参数定义94.2示例95余额查询接口95.1接口地址95.2参数定义95.3提交响应105.4提交响应值105.5示例10版本修订历史项目日期修订内容备注12012-10-21技术支持： 邴立运 qq：613953603 手机文档主要定了短信平台对用户开放的主要接口和定义。1 普通短信发送用户通过HTTP的POST方式提交短信发送请求。编码采用UTF-8编码。1.1 短信提交地址URL地址为：/asmx/smsservice.aspx1.2 参数定义序号参数说明1name必填参数。用户账号2pwd必填参数。（web平台：基本资料中的接口密码）3content必填参数。发送内容（1-500 个汉字）UTF-8编码4mobile必填参数。手机号码。多个以英文逗号隔开5stime可选参数。发送时间，填写时已填写的时间发送，不填时为当前时间发送6sign可选参数。用户签名。7type必填参数。固定值 pt8extno可选参数，扩展码，用户定义扩展码，只能为数字1.3 短信提交响应用户短信通过http请求提交到服务器后，服务器返回响应码，响应码的格式如下：code,sendid,invalidcount,successcount,blackcount,msg1.3.1 格式说明短信提交响应为英文逗号隔开的一行数据，状态,发送编号,无效号码数,成功提交数,黑名单数和消息，无论发送的号码是多少，一个发送请求只返回一个sendid，如果响应的状态不是“0”，则只有状态和消息（提交失败的原因），并将提交的参数及值原样返回。1.3.2 示例 提交成功0, 20130821110353234137876543,0,500,0,提交成功20130821110353234137876543为返回的sendid，这个工状态报告匹配时使用。1,含有敏感词汇,?name=*&pwd=* 等参数和值 提交失败本示例表明用户提交失败，返回错误码为1，服务器端并未返回sendid等。提交失败时是英文逗号隔开的三个参数。但是最后一个参数可能也会有英文逗号，比如发送的内容中有。这样就会有多于3个英文逗号，请做好相应处理。1.3.3 响应状态值说明代码说明0提交成功1含有敏感词汇2余额不足3没有号码4包含sql语句10账号不存在11账号注销12账号停用13IP鉴权失败14格式错误-1系统异常1.4 短信发送例子/asmx/smsservice.aspx?name=test&pwd=112345&content=testmsg&mobile18655555555&stime=2012-08-01 8:20:23&sign=testsign&type=pt&extno=2 个性短信发送2.1 短信提交地址URL地址为：/asmx/smsservice.aspx2.2 参数定义序号参数说明1name必填参数。用户账号2pwd必填参数。（web平台：基本资料中的接口密码）3content必填参数。发送内容UTF-8编码，建议每次1000个格式：内容#号码#内容#号码例：你好张三你好李四#139999999994stime可选参数。发送时间，填写时已填写的时间发送，不填时为当前时间发送5sign可选参数。用户签名。6type必填参数。固定值 gx7extno可选参数，扩展码，用户定义扩展码，只能为数字2.3 短信提交响应用户短信通过http请求提交到服务器后，服务器返回响应码，响应码的格式如下：code,sendid,invalidcount,successcount,blackcount,msg2.3.1 格式说明短信提交响应为英文逗号隔开的一行数据，状态,发送编号,无效号码数,成功提交数,黑名单数和消息，无论发送的号码是多少，一个发送请求只返回一个sendid，如果响应的状态不是“0”，则只有状态和消息。Code值与普通短信含义相同2.3.2 示例 提交成功0, 20130821110353234137876543,0,500,0,提交成功20130821110353234137876543为返回的sendid，这个工状态报告匹配时使用。3 状态报告推送（post方式推送）如果管理员设置用户账户需要状态报告，并且也配置了账户的状态报告接收地址，则用户可以接收到其发送短信的状态报告。用户侧启动一个HTTP服务用于接收状态报告。POST方式推送3.1 参数定义序号参数说明1name接收状态报告验证的用户名（不是账户名），是按照用户要求配置的名称，可以为空2pwd接收状态报告验证的密码，可以为空3sendid提交短信时平台返回的sendid，参见1.24time报告时间（多个号码时，是第一个号码的时间）5mobile当多个号码状态相同时 手机号以英文逗号隔开；不同时 为单个手机号码6state状态报告数值3.2 状态报告值状态报告的值即，state后面的数据，如下状态值(字符串)说明DELIVRD短消息转发成功EXPIRED短消息超过有效期UNDELIV短消息是不可达的UNKNOWN未知短消息状态REJECTD短消息被短信中心拒绝DTBLACK目的号码是黑名单号码ERR:104系统忙REJECT审核驳回其他网关内部状态3.3 示例http:/pushUrl?name=admin&pwd=12345&sendid=12345&time=2013-08-20 20:11:34&mobilestate=DELIVRD其中，pushUrl为用户启动的服务地址。4 短信接收（与报告雷同 post方式推送）4.1 参数定义序号参数说明1name接收信息验证的用户名（不是账户名），是按照用户要求配置的名称，可以为空2pwd接收信息服务需验证的密码，可以为空3args手机号、内容、时间、系统扩展码+自定义扩展码；以 # 分割。(扩展码可能为空)多个上行以# 分割4.2 示例http:/pushMoUrl?name=admin&pwd=12345&argscontent1#2013-08-21 21:20:11#008123content2#2013-08-21 21:20:30#008456本例中 008为系统为该用户设置的扩展码，123和另外一个456是提交短信时用户自己加的自定义扩展码；即发送时extno=123系统扩展码可能变化，如果变化一般长度不变，建议通过长度来截取得到自定义扩展码其中，pushUrl为用户启动的服务地址。5 余额查询接口5.1 接口地址/asmx/smsservice.aspx5.2 参数定义序号参数说明1name必填参数。用户账号2pwd必填参数。用户密码3type必填参数。固定值 balance5.3 提