信易通短信业务Api接口文档.doc

信易通短信业务API接口 版本1.1 北京九易空间广告传媒有限公司一、概述 1 二、下行短信 1 三、状态报告推送 3 四、 上行短信 4 五、 额度查询 5 日期 版本 说明 作者 2012-12-30 V1.0 更新 技术何 2013-8-22 V1.1 更新状态报告、上行短信 技术高 一、概述 1、适用范围 本接口适用于任何短信群发平台短信业务对接。 2、专有名词 下行短信：站在平台方，是发出去的短信 上行短信：站在平台方，是接收到的短信 3、接口服务器 IP：4 端口：8087 二、下行短信 接口地址：http://IP地址:端口号/api/send 1、接口：采用Http协议，提交参数采用POST进行传输。 2、提交参数： 参数名称 说明 account 用户名，由我方提供给贵方 pwd 密码，由我方提供初始密码，贵方可以在客户端或Web发送系统进行修改 product 产品编号，由我方提供。 needstatus 是否需要状态报告，需要请填true，不需要可以不填或false mobile 手机号，多个手机号，用英文逗号分隔，每次最大只能提交5000条号码，超过5000，请分包处理。如： 138********,138********,138********,138******** message 短信发送内容，编码UTF-8格式 senddate 定时发送时间，如果为空，则立即发送。格式：YYYY-MM-DD HH:II:SS extno 扩展编码，范围000-999。根据对应的产品，若支持回复且需要回复，请指定 注意：为了使message支持多种特殊字符，请用urlencode编码。具体为： urlencode(utf-8(message)) 3、示例： 提交地址：http://IP地址:端口号/api/send POST数据： account=testpwd=testproduct=1060000123needstatus=falsemobile1370000000message=测试senddate=extno= 返回数据格式 状态码,响应时间 消息id 其中状态码见下表，响应时间是网关响应请求时间。消息id，是为了获取状态码而准备的。状态码与响应时间中间用逗号分隔，状态码、响应时间与消息id中间的分隔符是\n 状态码 状态码 说明 200 发送成功 -100 账号或密码不合法 -101 关键词不合法 -102 产品不存在 -103 敏感短信 -104 数据包过长 -105 数据包没号码或号码个数不足产品规定的最小阀值 -106 内容长度错 -107 提交过快 -108 不在发送时间内 -109 无发送额度 -110 扩展码格式错误 -111 系统维护中 0 未知错误 三、状态报告推送 采用推送的方式，需要贵方提供地址给我司，由我司推送给贵方。采用Http协议，提交参数采用GET进行传输。 1、提交参数 参数名称 说明 account 用户名，由我方提供给贵方 pwd 密码，由我方提供初始密码，贵方可以在客户端或Web发送系统进行修改 msgid 产品编号，由我方提供。 mobile 单条手机号 status 状态码 2、接收的状态码-status 状态码 说明 100 还有状态等待捕获 200 此任务状态返回已经完成 1 发送成功 0 发送未知 -1 发送失败 NULL 空号 MBBLACK 数据包没号码或号码个数不足产品规定的最小阀值 STOP 停机或关机 SUCCESS 成功 返回给我司的数据格式 状态码,个人手机号 3、状态码 状态码 说明 200 已经成功接收并保存 其它 未成功保存。有3次机会，系统将向后推迟10分钟，再次推送 上行短信 采用推送的方式，需要贵方提供地址给我司，由我司推送给贵方。采用Http协议，提交参数采用GET进行传输。 提交参数 参数名称 说明 api_user 用户名，与api_pwd共同鉴权。由贵方提供。可以为空 api_pwd 密码，与api_user共同鉴权。由贵方提供。可以为空 mobile 发上行短信的个人手机号。 target 个人手机收到的号码。如：106******* msg 上行短信内容 sendtime. 发送时间，Unix时间缀 返回数据格式 状态码,个人手机号 3、状态码 状态码 说明 200 已经成功接收并保存 其它 未成功保存。有3次机会，系统将向后推迟10分钟，再次推送 额度查询（未启用） 采用Http协议，提交参数采用POST进行