三网合一短信接口文档.doc

三网合一短信接口文档v2.0一、HTTP接口调用说明(支持POST和GET)HTTP网关地址:UTF8编码网关55:6000/utf8/web_api/SendSMS_V2.aspxGBK 编码网关55:6000/gbk/web_api/SendSMS_V2.aspx提示:HTTP调用URL接口时, 参数值必须URL编码后再调用1.1 参数说明序号参数名描述1X_sid会员编号2X_eid企业编号3X_uid会员帐号4X_pwd_md5MD5（MD5（密码）+本机外网ip）英文字母全是小写5X_ac操作指令10 发送普通短信70字12 发送长短信450字13发送打包短信不同内容20 接收回复短信30查询账户余额50修改接口密码100 获取外网IP，用于生成x_pwd_md56X_gate_id300固定不能修改7X_target_no接口短信手机号，多个号码用逗号分开，最多支持100条每次8X_memo短信发送内容，最多450字符,必须url编码1.2发送短信1.2.1发送普通短信（70字） 请求参数X_ac=10&x_eid=企业代码&x_uid=会员帐号&x_pwd_md5=访问密码&x_gate_id=300&x_target_no=接收手机号&x_memo=发送短信内容1.2.1发送长短信(450字) 请求参数X_ac=12&x_eid=企业代码&x_uid=会员帐号&x_pwd_md5=访问密码&x_gate_id=300&x_target_no=接收手机号&x_memo=发送短信内容返回值描述类型值int0(大于0) 成功计费条数=0 (小于等于0) 失败2.接收回复短信(分主动和被动两种接收)2.1主动接收回复短信(最小调用间隔30秒一次) 请求参数X_ac=20&x_eid=企业代码&x_uid=会员帐号&x_pwd_md5=访问密码&x_gate_id=300 返回XML格式（返回2条用户回复的短信）1(序列号可以忽略)1001（会员编号,如果有多个帐号情况下回复手机号)能收到我回复的测试短信么？（回复内容）2009-11-21 16:54:14(回复时间)10655059052084（回复到网关的号码）1200 (用户扩展码) 2100213020930000这是第二条测试短信!2009-11-21 16:13:3710655059052084101 2.2被动接收回复短信（如果有新回复短信，我们会主动以PUSH方式发送给用户指定的页面） 此方式采用http+xml+post技术，需要用户提供一个接收短信页面地址 以下是post+xml时的样本： 11001这个是被动回复过来的，能收到么？ 2008-03-14 23:07:39 1065810889988 101 3.查询短信余额请求参数X_ac=30&x_eid=企业代码&x_uid=会员帐号&x_pwd_md5=访问密码&x_gate_id=300 返回值Sms:10000,mms:5000描述Sms:指短信剩余条数，mms:指彩信剩余条数4.修改接口密码请求参数X_ac=50&x_eid=企业代码&x_uid=会员帐号&x_pwd_md5=访问密码&x_new_pwd=接口新密码MD5&x_gate_id=300 返回值 1 修改新密码成功，否则失败。5.打包提交不同内容短信(最多支持100个包),必须使用POST方式请求参数(只接受POST方式)X_ac=13&x_eid=企业代码&x_uid=会员帐号&x_pwd_md5=访问密码&x_gate_id=300&x_memo=xml格式x_memo格式如下 编号 (如果失败，会输出这个编号,保证此包里不要重复)用户手机号码1长短信，0普通短信,(超过70字自动设置1)扩展码 返回值(Int数字类型) 大于0成功，否则失败6.获取公网ip用于验证访问密码，x_pwd_md5需要用到这个值请求参数X_ac=100返回值00HTTP返回值参对表编号值说明1大于0发送成功,此次发送成功条数2-1参数无效3-2通道不存在或者当前业务不支持此通道4-3定时格式错误5-4接收号码无效6-5提交号码个数超过上限,每个通道都有批量提交的上限.详细值请参考通道说明7-6发送短信内容长度不符合要求,参考通道要求长度8-7当前账户余额不足9-8网关发送短信时出现异常10-9用户或者密码没输入11-10企业ID或者会员账号不存在12-11密码错误13-12账户锁定14-13网关状态关闭15-14验证用户时执行异常16-15网关初始化失败17-16当前IP已被系统屏蔽,可能是与您设置的接入IP不同或者是失败次数太多18-17发送异常19-18账号未审核20-19当前时间不允许此通道工作，主要对群发通道限制21-20传输密钥未设置，请登陆平台设置22-21提取密钥异常23-22签名验证失败24-23发现屏蔽关键字25-100到-199运营商返回失败代码二、WebService调用方式WS网关地址:Utf8网关 55:6000/utf8/ws_api/WebSMS_V2.asmxGBK网关55:6000/gbk/ws_api/WebSMS_V2.asmxWebService服务函数目录1.EditPWD 修改接口密码,平台登录密码不受影响 2.FastSend 快速发送短信,直接提交到运营商,本站不存储任何数据.返回值:SendResult 自定义类 3.FastSendLongSMS 发送长短信,最多支持450字.按64字计费,本站不存储任何数据.返回值:SendResult 自定义类 4.GetBalance 查询账户剩余短信/彩信条数,返回值:sms:100,mms:100 当前余额,否则返回失败代码 5.GetUpSMS 客户主动读取上行短信,最小间隔30秒,返回多个Woxp_UpSMS上行类。每条上行信息生成一个类,没有上行就返回NULL 6.SendXMLPack 打包发送短信，适合不同内容批量提交，以xml格式打包，上限100条.返回值:SendResult 公共参数调用描述eid_pwd_gateId，该参数是字符串类型，由多个值拼成所有函数都必须依赖这个参数来提供服务参数格式（ 会员编号-企业代码会员帐号MD5（MD5（接口密码）+登录IP）-通道号）各个参数用-分开参数例如（1）会员编号：15（2）企业代码：10001（3）会员帐号：smsone（4）登录MD5: e10adc3949ba59abbe56e057f20f883e, MD5（MD5（接口密码）+登录IP）登录IP可以由55:6000/utf8/web_api/SendSMS_V2.aspx?x_ac=100获取（5）通道号:300(这个是固定值)eid_pwd_gateId =15-10001-smsone-e10adc3949ba59abbe56e057f20f883e-300 (注意分隔符-半角下输入)1. 修改接口密码 public int EditPWD(string eid_pwd_md5, string newPwd_md5) 参数描述 newPwd_md5,新接口密码MD5值（32 位） 返回值 1成功，否则失败.2.发送普通短信70字 public SendResult FastSend(string eid_pwd_gateId, string TargetNo, string MsgContent, string SendTime, string strSubId)参数描述（1） TargetNo 发送手机号码，多个号码用逗号分开。最多支持100个号码（2） MsgContent 发送短信内容，最多70个字符（3） SendTime 定时发送时间，暂时为null,预留参数（4） strSubId 扩展码，确认不同用户回复返回值: SendResult自定义类 string int(是否成功由这个值确定，大于0成功其它值失败) string int string string string成功标识 RetCode值大于0代表发送成功，返回计费条数，否则就返回失败代码3.发送长短信450字public SendResult FastSendLongSMS(string eid_pwd_gateId, string TargetNo, string MsgContent, string SendTime, string strSubId)解释同【发送普通短信70字】一样，请参考FastSend上面说明.4.查询账户余额public string GetBalance(string eid_pwd_md5)调用成功后返回值Sms:1000,mms:1000该帐号剩余短信1000条，彩信1000条5.获取用户回复的短信public Woxp_UpSMS GetUpSMS(string eid_pwd_gateId)返回值， 如果有回复短信返回Woxp_UpSMS数组集合.每个数组存储回复详细信息。否则为NULL Woxp_UpSMS 自定义类型 int (上行编号，可以忽略) int (会员编号区分企业下面多个帐号) string (回复者的手机号) string (回复内容) string (回复时间) string (用户扩展码，区分哪个用户回复) stri