短信二次开发接口WEB文档.doc

HTTP短信接口文档 v52 必威体育精装版修改时间:2013-10-28 一、 工作方式 2 二、 响应格式 2 三、 短信发送接口 2 四、 批量短信接口(一对一发送) 4 五、 动态参数短信接口 6 六、 获取发送状态 9 七、 获取短信回复 10 八、 获取帐户余额 11 九、 修改接口密钥 12 工作方式 双方通过HTTP方式交互数据，第三方可以简单的”name=value”方式发送提交内容或响应请求内容。即通过HTTP的GET/POST方式交换。 交换数据统一使用UTF-8编码。 另外双方需要保证数据传输的完整性和安全性，每次发送请求都有响应(响应返回格式为XML)，安全验证使用32位认证密钥的方式。 响应格式 请求响应即每次向服务器提交(建议使用POST方式提交)请求后的返回值 响应值格式为XML： xml name=xxx result=0/ Name 为提交的接口名 Result　为返回的状态码 短信发送接口 接口参数说明: 参数名 参数字段 参数说明 ac 用户 发送短信的帐号（员工编号@企业编号） authkey 认证密钥 32位认证密钥（大写），企业管理员可以在软件或后台管理中获取 cgid 通道组编号 使用的通道组编号，在软件或后台管理可以查看可用的通道组 csid 签名编号 预设的企业签名编号，请使用自己企业已通过审核的签名编号 c 短信内容 发送内容(总长度应在1000个汉字以内)要使用UTF-8格式，如果不是请先转为UTF-8字符，再进行URL字符标准化转码。{URL字符编码说明:返回字符串，此字符串中除了-_.之外的所有非字母%）后跟+） ASP：server.URLEncode(短信内容) PHP：urlencode(短信内容) JAVA：.URLEncoder.encode(短信内容) m 发送号码 手机号码，如多个以英文逗号分隔（建议1000个及以内的手机号码，,超过系统上限将会返回参数错误）。 如:151****0086 t 发送时间 可选参数，无则立即发送，有则须在当前时间的一分钟之后，否则返回参数错误。格式:yyyyMMddHHmmss 如:20130721182038 例: /OpenPlatform/OpenApi?action=sendOnceac=1001@500008880001authkey=876557C2685137EB3B5DECcgid=80csid=101c=%E6%B5%8B%E8%AF%95m151****0086 成功时返回响应: xml name=sendOnce result=1 Item cid=xxx sid=xxx msgid=xxx total=2 price=0.10 remain=170.040/ /xml 失败时返回响应： xml name=sendOnce result=-1/ 返回参数说明: 参数名 参数字段 参数说明 cid 企业编号 发送短信的企业编号 sid 员工编号 发送短信的员工编号 msgid 发送编号 每次发送的消息编号 total 短信条数 任务需要的短信条数 price 单价 任务中每条短信的价格 remain 余额 本次发送后企业的帐户余额 返回状态码说明： 参数名 参数说明 1 操作成功 0 帐户不正确 -1 服务器拒绝(速度过快、限时或绑定IP不对等)如遇速度过快可延时再发 -2 密钥不正确 -3 密钥已锁定 -4 参数不正确(内容和号码不能为空，手机号码数过多，发送时间错误等) -5 无此帐户 帐户 -7 帐户未开启接口发送 -8 不可使用该通道组 -9 帐户 -10 内部错误 -11 扣费失败 批量短信接口(一对一发送) 批量发送短信接口也称一对一发送接口，用于一个手机号码对应一个发送内容的批量提交。每个号码和内容都不能为空，使用批量发送需要提交短信至少为2条，最多可以一次提交100个一对一短信。也可以定时发送一对一短信，只需要指定一个要发送的时间(要在当前时间的一分钟以后)即可。提交成功将返回每条短信的计费条数和发送以后的余额。 要注意批量短信是按一次发送的总条数计费，请保证帐户余额足够发送当次批量短信。如果帐户余额不足将会返回失败。 接口参数说明: 参数名 参数字段 参数说明 ac 用户 发送短信的帐号（员工编号@企业编号） authkey 认证密钥 32位认证密钥（大写），企业管理员可以在软件或后台管理中获取 cgid 通道组编号 使用的通道组编号，在软件或后台管理可以查看可用的通道组 csid 签名编号 预设的企业签名编号，请使用自己企业已通过审核的