《SMS57-SMGW客户接口说明文档.docx》由会员分享，可在线阅读，更多相关《SMS57-SMGW客户接口说明文档.docx（19页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、SMS57-SMGW客户接口说明文档2015-12-28接口说明：接口编码方式采用统一的UTF-8 ,请求方式采用HTTP REST,支持GET/POST方式balance当前账户余额，单位厘chargeTypePOSTCHARGE=后付费 PRECHARGE=预付费4 .客户端主动获取状态报告接口用于客户端到网关获取短信发送的状态报告4.1 ,请求地址http:host:port/smshltps:/host/sms（使用https需要联系供应商是否支持）请求方式可以采用POST和GET方式，建议采用POST方式42参数说明参数需要URLENCODE ,编码方式采用UTF-8参数名称含义说明
2、action请求动作设置为固定的：reportaccount用户帐号用户帐号，由系统管理员password帐号密码非加密:password加密：MD5(password)size获取报告的数量默认1000 ,最小10 ,最大10000rt响应数据类型json例如：http:host:port/sms?action = report&action=】eDort&account =贝长号&password=密召马&size=10&rt =json421 ,响应数据有报告可以获取的示例：(“status“：“0“，balance0:“list”：(“flag”：1,“mid“： “4C05”，Hsp
3、idn: 922011,HaccessCoden:“mobile“：nstatn: MA:0029,time: 2017-04-12 01:38:21，(“flag”： 1，“mid： “40)6”，nspidH: 922011H,accessCode11:二“mobile“：Hstatn: MA:0029H, ntime: 2017-04-12 01:38:21”没有报告可以获取的示例：（“status“：“0，“balance：nlist:字段说明status请求结果，具体参见status错误代码表balance当前账户余额，单位厘list详细状态报告列表，没有报告可以获取时为空flag1
4、-状态才艮告mid消息ID（与提交时响应的消息ID匹配）spid归属账号（可忽略）mobile手机号码accessCode下发号码stat状态报告代码,参见STAT状态报告代码表time状态报告的具体时间5 .客户端主动获取手机上行接口用户客户端向网关获取手机上行回复的短信5.1 请求地址http:host:port/smshltps:/host/sms(使用https需要联系供应商是否支持)请求方式可以采用POST和GET方式，建议采用POST方式52参数说明参数需要URLENCODE ,编码方式采用UTF-8参数名称含义说明action任务名称设置为固定的：moaccount用户帐号用户帐
5、号，由系统管理员password帐号密码非加密：password加密:MD5(password)szie获取上行数量默认1000 ,最小10 ,最大100()rt响应数据类型json例如：http:host:port/sms?action二mo&account=贝长号&Dassword=密石马&size= 10&rt=json5.3 .响应数据有上行可以获取的示例：“status“：“0，balance*:“list”：(“flag”: 0,“mid“： “4C05”，nspidn: 92201 ln,accessCode: n 10690,“mobile： n,content1: 上行内容
6、1,“time”: u2017-04-12 01:38:21,(“flag”： 0,“mid“： “4co6”，spid: 922011M,accessCoden: n 10690,“mobile“：“content：”上行内容 2”，“time”: n2017-04-12 01:38:21没有上行可以获取的示例：“status“：“0, balance0: list:字段说明status请求结果，具体参见STATUS错误代码表balance当前账户余额，单位厘list详细上行列表,没有上行诃以获取时为空flag0二手机用户上行mid上行消息ID （可忽略）spid归属账号（可忽略）mobil
7、e手机号码accessCode接收号码，即SP月员务号（106XXXXXX ）content手机上行的具体内容time手机上行的具体时间6 .客户端被动接收上行和状态报告用于网关向客户端推送状态报告6.1 ,请求地址由客户端向网关报备推送地址，请求方式由网关采用POST方式，推送到客户端62请求参数(“flag”：0,“mid“： “4C05”，spid11: 922011H,accessCode: n 10690,“mobile：“content”：”上行内容:“time： “2017-04-12 01:38:21”，(“flag”： 1,“mid“： “4co6”，Hspidn: 9220
8、11H,accessCode: n 10690,“mobile“：Hstatn: DELIVRD,“time”： “2017-04-12 01:38:21字段说明flag。二手机用户上行状态报告midflag=l时，消息ID与提父时响应的消息ID匹配；flag=0时，表示该条上行的消息IDspid归属账号(可忽略)mobile手机号码accessCode接收号码，即SP服务号(106XXXXXX )content手机上行的具体内容；flag=l时，该字段无效stat状态报告代码,具体参见STAT状态代码表；flag=O时,该字段无效time手机上行的具体时间6.3 .客户端响应客户端接收成功，
9、响应文本OK即可OK7 . STATUS错误代码表错误代码具体含义1消息包格式错误2IP鉴权错误3账号密码不止确4版本号错误5其它错误6接入点错误（如账户本身开的是CMPP接入）7账号状态异常（账号已停用）21连接过多100系统内部错误,一般情况下例如：提父手机号码为电信，但是该账号没用可用的电 信接出点102单次提交的号码数过多（建议200以内）0鉴权成功8 . RESULT错误代码表错误代码具体含义10原发号码错误,即extno错误15余额不足17账号签名无效0提父成功9 . STAT状态代码表错误代码说明DELIVRD短信投递成功EXPIREDMessage validity perio
10、d has expiredDELETEDMessage has been deleted.REJECTEDMessage is in a rejected stateMA:0001全局黑名单号码MA:0002内容非法MA:0003无法找到下级路由MA:0004未知MA:0005目的号码格式错误MA:0006系统拒绝MA:0009未定义错误MA:0011未知系统内部错误MA:0012防钓鱼MA:0013非法错误的包时序MA:0014非法的OPJSDN号段MA:0021号码格式错误MA:0022号码超过半小时下发次数限制MA:0023客户黑名单号码MA:0024内谷未报备MA:0025不支持该短信
11、MA:0026分条发送，组包超时MA:0027通道黑名单MA:0028全局黑名单号段MA:0029通道黑名单号段文档目录SMS57-SMGW客户接口说明文档.1L短信发送接口.41.1. 请求地址41.2. 参数说明4L3.响应数据52 .点对点发送.62.1. 接口请求地址62.2. 参数定义62.3. 响应数据73 .余额查询接口.93.1. 请求地址93.2. 参数说明93.3. 响应数据94 .客户端主动获取状态报告接口.104.1. 请求地址104.2. 参数说明10MA:0030直接产生拒绝报告M0:200不支持分条短信MO:0254转发提交超时MO:0255转发提交过程中,连接断
12、开MO:NNNNNNNN为对外提交过程中，上级网关的返回值，具体含义需上级网关解释10.常见错误错误码10提交短信过程中返回10 ,接入码错误，即extno=106XXXXXX不正确，解决方法：填写正确的接入码（网关管理员可以从生产账号摘要中获取该接入号）错误码17提交短信过程中返回17 ,签名错误解决方法： 提交内容中带上网关管理员已经报备的签名 网关管理员在（客户管理;账号签名报备）中关闭该账号的签名校验功能错误码15提交短信过程中返回15余额不足解决方法： 网关管理员对该账号充值 网关管理员将该账号设置为后付费1.3. 响应数据115 .客户端主动获取手机上行接口.135.1. 请求地址
13、135.2. 参数说明135.3. 响应数据136 .客户端被动接收上行和状态报告.166.1. 请求地址166.2. 请求参数166.3. 客户端响应177 . STATUS错误代码表.178 . RESULT错误代码表189 . STAT状态代码表1810 .常见错误.201 .短信发送接口用户客户端向网关提交短信1.1 .请求地址htD：host:port/smshttps:/host/sms(使用https需要联系供应商是否支持) 请求方式可以POST和GET方式,建议采用POST方式12参数说明参数需要URLENCODE ,编码方式采用UTF-8参数名称含义说明action请求动作设
14、置为固定的:sendaccount发送用户帐号用户帐号，由系统管理员password发送帐号密码非加密：password加密:MD5(password+extno+content+mobile)mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开， 最多500个号码content发送内容短信的内容，内容需要UTF-8 URLEncode编码extno接入号接入号,即SP服务号(106XXXXXX )rt响应数据类型json例如：http:host:port/sms?action=send&account=账号&password=密码&mobile二,&content=内容&e
15、xtno=&rt=json1.3 .响应数据status: 0H,balance0:list:(“mid“： “4c2CA”,“mobile“：“result： 0，(“mid”: “4C2CA”,“mobile“： ”，“result： 0)字段说明status请求结果，具体参见STATUS错误代码表balance当前账户余额，单位厘list短信提交响应列表mid消息ID （用于状态报告匹配）mobile手机号码result短信提交错误代码，参见RESULT错误代码表2 .点对点发送用于客户端向网关提交点对点短信，即一个号码一个内容的短信2.1 ,接口请求地址http:host:port/s
16、mshttps:/host/sms（使用https需要联系供应商是否支持）请求方式可以POST和GET方式,建议采用POST方式22参数定义参数需要URLENCODE ,编码方式采用UTF-8参数名称含义说明action请求动作设置为固定的:p2Paccount发送用户帐号用户帐号，由系统管理员password发送帐号密码非加密:password力口密：MD5(password+extno+mobileContentList)(加密时mobileContentList换行符去掉)mobileContentList号码短信内谷列表号码内容格式为：Mobile#Content 多个号码之间用换行分
17、割如：#下发内容I#下发内容2#下发内容3#下发内容4extno接入号接入号,即SP服务号(106XXXXXX )rt响应数据类型json例如：:7822/sms?action=p2p&rt=json&account=92201 l&password=123456&mobileContentList=%23%e4%b8%8b%e 5%8f%91 %e5%86%85%e5%ae%b91 %0d%23%e4%b8%8b%e5%8f%91 %e5%86%85%e5%ae%b92%0d%23%e 4%b8%8b%e5%8f%91 %e5%86%85%e5%ae%b93%0d%23%e4%b8%8b%e
18、5%8f%91 %e5%86%85%e5%ae%b9 4%0d&extno=23响应数据(status: On,balance*:list:mid: 4C372C,mobile:“result”: 0，(“mid”： “4c372C”，“mobile“：“result： 0“mid”： “4c372C”,“mobile“：“result： 0,(“mid： “4C372CA”,“mobile“： ”，“result： 0)字段说明status请求结果,具体参见STATUS错误代码表balance当前账户余额，单位厘list短信提交响应列表mid消息ID （用于状态报告匹配）mobile手机号码
19、result短信提交错误代码，参见RESULT错误代码表3 .余额查询接口用于客户端查询当前账户余额3.1 ,请求地址http:host:port/smshltps:/host/sms（使用https需要联系供应商是否支持）请求方式可以POST和GET方式,建议采用POST方式32参数说明参数需要URLENCODE ,编码方式采用UTF-8参数名称含义说明action请求动作设置为固定的：balanceaccount用户帐号用户帐号，由系统管理员password帐号密码非加密：password加密：MD5(password)rt响应数据类型json例如：http:host:port/sms?action=balance&account=贝长号 password= 密石马&rt=ison33响应数据 status ： 0, balance11: chargeType : nPOSTCHARGEn 字段说明status请求结果，具体参见STATUS错误代码表