企业短信HTTP接口文档2.0.docVIP

企业短信HTTP接口文档2.0 目录 1 普通短信发送 3 1.1 短信接口地址 3 1.2 参数定义 3 1.3 短信提交响应 4 1.3.1 格式说明 4 1.3.2 示例 4 1.3.3 响应状态值说明 5 1.4 注意事项 6 1.5 短信发送例子 6 2 状态报告推送 6 2.1 参数定义 7 2.2 状态报告值 7 2.3 示例 7 3 短信接收 8 3.1 参数定义 8 3.2 示例 8 4 额度查询接口 9 4.1 接口地址 9 4.2 参数定义 9 4.3 提交响应 9 4.4 提交响应值 9 4.5 示例 10 5 附录 10  本文档主要定了短信平台对用户开放的主要接口和定义。 短信发送 用户通过HTTP的POST方式提交短信发送请求。短信发送接口如下。 短信接口地址 接口：/msg/HttpBatchSendSM。 参数定义 序号 参数 说明 1 account 必填参数。用户账号 2 pswd 必填参数。用户密码 3 mobile 必填参数。合法的手机号码 4 msg 必填参数。短信内容，验证码短信内容控制在70个字符内。使用URL方式编码为UTF-8格式。通知短信内容超过70个字符时，会被拆分成多条，然后以长短信的格式发送。 5 needstatus 必填参数。是否需要状态报告，取值true或false，true，表明需要状态报告；false不需要状态报告 6 product 可选参数。用户订购的产品id，不填写（针对老用户）系统采用用户的默认产品，用户订购多个产品时必填，否则会发生计费错误。 7 extno 请登陆网站用户中心——服务管理找到签名对应的extno并填写，线下用户请为空。 短信提交响应 用户短信通过http请求提交到服务器后，服务器返回响应码，响应码的格式如下： 格式说明 短信提交响应分为两行，第一行为响应时间和状态，第二行为服务器给出提交msgid。无论发送的号码是多少，一个发送请求只返回一个msgid，如果响应的状态不是“0”，则没有msgid即第二行数据。（每行以换行符(0x0a,即\n)分割） 注：needstatus参数需要等于true才会返回msgid 示例 提交成功 响应时间为20110725160412，响应状态为0 表明那个成功提交到服务器；1234567890100为返回的msgid，这个工状态报告匹配时使用。 提交失败 本示例表明用户提交失败，返回错误码为101，服务器端并未返回msgid。 响应状态值说明 代码 说明 0 提交成功 101 无此用户 102 密码错 103 提交过快（提交速度超过流速限制） 104 系统忙（因平台侧原因，暂时无法处理提交的短信） 105 敏感短信（短信内容包含敏感词） 106 消息长度错（536或=0） 107 包含错误的手机号码 108 手机号码个数错（群发50000或=0） 109 无发送额度（该用户可用短信数已使用完） 110 不在发送时间内(验证码通知7*24小时发送) 111 超出该账户当月发送额度限制 112 无此产品，用户没有订购该产品 113 extno格式错（非数字或者长度不对） 115 自动审核驳回 116 签名不合法，未带签名（用户必须带签名的前提下） 117 IP地址认证错,请求调用的IP地址不是系统登记的IP地址 118 用户没有相应的发送权限 119 用户已过期 120 内容不在白名单中 注意事项 用户发短信必须提前报备短信内容，如果发送未报备的内容会进入审核平台，则客户的短信必须经过管理人员的审核，审核通过后才能被提交到行业网关进行短信实际发送。 用户群发短信必须满足手机号码最低个数的限制，低于系统设定的群发最小手机号码数，则该提交请求会被拒绝，响应码为108。 短信发送例子 特别注意：请登陆网站用户中心——服务管理找到签名对应的extno并填写，线下用户请为空。 短信发送 /msg/HttpBatchSendSM?account=003547pswd=Sd123456mobilesg=您好，您的验证码：1234needstatus=trueextno= 状态报告推送 如果管理员设置用户账户需要状态报告，并且也配置了账户的状态报告接收地址，则用户可以接收到其发送短信的状态报告。用户侧启动一个HTTP服务用于接收状态报告。 参数定义 序号 参数 说明 1 receiver 接收状态报告验证的用户名（不是账户名），是按照用户要求配置的名称，可以为空 2 pswd 接收状态报告验证的密码，可以为空 3 msgid 提交短信时平台返回的msgid，参见1.2 4 repo