哲合通短信接口说明文档.docx

哲合通短信接口说明文档2015-12-28接口说明：接口编码方式采用统一的UTF-8 ,请求方式采用HTTP REST ,支持GET/POST方式list1:flag: 0,mid: 4C05,spid: 922011”,mobile”: ,content:上行内容”，lime: 2017-04-12 01:38:21Fag: 1,mid”: 4C06,spid”: 922011,mobile: ,stal”：测试内曾，time: 2017-04-12 01:38:21字段说明status请求结果，具体参见STATUS错误代码表balance当前账户余额，单位厘list详细状态报告列表flag0=手机用户上行mid消息1D（与提交时响应的消息ID匹配）spid归属账号（可忽略）mobile手机号码accessCode接收号码，即SP服务号（I06XXXXXX ）content手机上行的具体内容lime手机上行的具体时间6.客户端被动接收上行和状态报告用于网关向客户端推送状态报告6.1 .请求地址由客户端向网关报备推送地址，请求方式由网关采用POST方式，推送到客户端6.2 .请求参数flag: 0,mid: 4C05,spid”: 922011”，mobile: ,content”：上行内容”，time: 2017-04-12 01:38:21flag: 1,mid: 4C06,spid: 922011”,mobile”:stat: DELIVRD,lime: 2017-04-12 01:38:21字段说明list详细状态报告列表flag0-手机用户上行1=状态报告midflag=l时，消息ID与提交时响应的消息ID匹配；flag=0时，表示该条上行的消息IDspid归属账号(可忽略)mobileWL号码acccssCodc接收号码,即SP服务号(I06XXXXXX )content手机上行的具体内容；flag=l时，该字段无效stat状态报告代码，具体参见STAT状态代码表；flag=O时，该字段无效time手机上行的具体时间6.3 .客户端响应客户端接收成功，响应文本OK即可OK7. STATUS错误代码表错误代码具体含义1消息包格式错误2IP鉴权错误3账号密码不正确4版本号错误5其它错误6接入点错误（如账户本身开的是CMPP接入）7账号状态异常（账号已停用）21连接过多100系统内部错误，一般情况下例如：提交手机号码为电信,但是该账号没用可用的电 信接出点102单次提交的号码数过多（建议200以内）8. RESULT错误代码表错误代码具体含义10原发号码错误，即extno错误15余额不足17账号签名无效9. STAT状态代码表荷吴代码说明DELIVRD短信投EXPIREDMessage validity period 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:001l未知系统内部错误MA:00l2防钓鱼MA:00l3非法错误的包时序MA:00l4非法的OP ISDN号段MA:0021号码格式蹴MA:0022号码超过半小时下发次数限制MA:0023客户黑名单号码MA:0024内容未报备MA:0025不支持该短信MA:0026分条发送，组包超时MA:0027通道黑名单MA:0028全局黑名单号段MA:0029通道黑名单号段MA:0030直接产生拒绝报告M0:200不支持分条短信MO:0254转发提交超时MO:0255转发提交过程中,连接断开MO:NNNNNNNN为对外提交过程中，上级网关的返回值,具体含义需上级网关解释10.常见错误错误码10提交短信过程中返回10 ,接入码错误，即ex（no=106XXXXXX不正确,解决方法：填写正确的接入码（网关管理员可以从生产账号摘要中获取该接入号）错误码17提交短信过程中返回17 ,签名错误解决方法:提交内容中带上网关管理员已经报备的签名网关管理员在（客户管理一账号签名报备）中关闭该账号的签名校验功能错误码15提交短信过程中返回15余额不足 解决方法： 网关管理员对该账号充值网关管理员将该账号设置为后付费H.接入示例PHP端示例cache-get(self:getCodeCacheKey(Smobile);public static function sendRcgVcrifyCodc(Smobilc)ScachcCodc = Yii:$app-cachc-gct(sclf:gctCodcCachcKcy($niobilc);if (ScacheCode = false) ScacheCode = (new Comtnon()-getCode(6);Sduration = 10; / 10 分钟Scontcnt = str_rcplace(%verifyCode%, duration%, ScachcCodc, Sduration, self:$vcrifyTem plate);Sres 一 self:send($mobile, Scontent);if (Sres) (Yii:$app-cache-set(self:getCodeCacheKey($mobile), ScacheCode, Sduration * 60);return ScacheCode; else return false;* mobile:手机号，可以是单个手机号，也可以是手机号数组* content:发送内容，UTF-8编码/public static function send(Smobile, Scontent)if (is array(Smobile) Smobilc = implode。,，Smobilc);Sargv =action = send*,account = self:$username,password* = self:$pwd,mobile = Smobile,content* = Scontcnt,extno = self:$extno,K = json,；Sflag = 0;Sparams =fbreach ($argv as Skey = Svalue) if (Sflag != 0) Sparams =Sparams .= Skey . urlencode($value);Sflag = 1;Suri = self:Sbaseurl . Sparams;Scon = (new Conunon()-curl($url, ,post);if (Scon) (Srcsult = json dccodc($con, true);if ($resultstatus = 0) return true;return false; else return false;11.1. Java端示例public static RepResult sendSms(String url, String account, String password. String mobile, String extno. String content) Map params = new HashMap();(action, “send”);(account, account);(password*, password);(mobile, mobile);(content,【哲合科技】+ content); (extno, extno);Crt, json);String result = (url, params);RcpRcsult rcpResult = null;try rcpResult = Objcct(rcsult,); catch (Exception e) e.printStackTracc();return rcpResult;文档目录哲合短信接口说明文档.错误!未定义书签。1. 短信发送接错误!未定义书签。1.1. 请求地址错误!未定义书签。1.2. 参数说明错误!未定义书签。1.3. 响应数据错误!未定义书签。2. 点对点发送.错误!未定义书签。2.1. 接口请求地址错误!未定义书签。2.2. 参数定义错误!未定义书签。2.3. 响应数据错误!未定义书签。3. 余额查询接口.错误!未定义书签。3.1. 请求地址错误!未定义书签。3.2. 参数说明错误!未定义书签。3.3. 响应数据错误!未定义书签。4客户端主动获取状态报告接口.错误!未定义书签。4.1. 请求错误!未定义书签。4.2. 参数说明错误!未定义书签。4.2.1. 响应数据错误!未定义书签。5. 客户端主动获取手机上行接口.错误!未定义书签。5.1. 请求地址愆吴!未定义书签。5.2. 参数说明错误!未定义书签。5.3. 响应数据错误!未定义书签。6. 客户端被动接收上行和状态报告.错误!未定义书签。6.1. 请求tfttlt错误!未定义书签。6.2. 请求参数错误!未定义书签。6.3. 客户端响应错误!未定义书签。7. STATUS错误代码表.错误!未定义书签。8. RESULT瞧代码表错误!未定义书签。9.STAT状态代码表错误!未定义书签。10. 常见能.错误!未定义书签。H.接入示例.错误!未定义书签。11.1. PHP端示例错误!未定义书签。H.2. Java端示例错误!未定义书签。1. 短信发送接口用户客户端向网关提交短信1.1 .请求地址him：ho$l：DOrusms请求方式可以POST和GET方式,建议采用POST方式12参数说明参数需要URLENCODE ,编码方式采用UTF-8例如：参数名称含义说明action请求动作设置为固定的:sendaccount发送用户帐号用户帐号，由系统管理员password发送帐号密码用户账号对应的密码mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开、 最多500个号码content发送内容短信的内容，内容需要UTF-8 URLEncode编码extno接入号接入号，即SP服务号(106XXXXXX )Ft响应数据类型jsonlittp:.7host:port,，sms?action=send&account=j!K&password=55&mobile=,&content=内容&extno=&rt=json13响应数据status: 0,balance:list”:mid”: 4C2CA,mobile”:也result: 0mid: 4C2CAmobile:result: 0字段说明status请求结果，具体参见STATUS错误代码表balance当前账户余额，单位厘list短信提交响应列表mid消息10(用于状态报告匹配)mobile手机号码result短信提交错误代码，参见RESULT错误代码表2. 点对点发送用于客户端向网关提交点对点短信，即一个号码一个内容的短信2.1 .接口请求地址httD：/host：Dort/sms请求方式可以POST和GET方式，建议采用POST方式22参数定义参数需要URLENCODE ,编码方式采用UTF-8例如：参数名称含义说明action请求动作设置为固定的:p2paccount发送用户帐号用户帐号，由系统管理员password发送帐号密码用户账号对应的密码mobilcContcntList号码短信内容列表号码内容格式为：MobileTABContent 多个号码之间用换行分割如：#下发内容1#下发内容2#下发内容3#下发内容4extno接入号接入号，即SP服务号(106XXXXXX )rt响应数据类型json:7822/sms?action=p2p&n=json&account=922011&password=123456&mobilcContcntList=%23%c4%b8%8b%c 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%e5%8f%91 %e5%86%85%e5%ae%b9 4%0d&extno=2.3 .响应数据status*: 0”，balance:list”：mid: 4C372C,mobile*:result: 0,mid”: 4C372C”,mobile: ,result: 0mid”: 4C372C,mobile: ,n, result: 0,mid”: 4C372CA,mobile”: , result: 0余额查询接口字段说明status请求结果，具体参见STATUS错误代码表balance当前账户余额，单位厘list短信提交响应列表mid消息ID（用于状态报告匹配）mobile手机号码result短信提交错误代码，参见RESULT错误代码表用于客户端查询当前账户余额3.1 .请求地址htm：/host：nort/snis请求方式可以POST和GET方式，建议采用POST方式32参数说明参数需要URLENCODE ,编码方式采用UTF-8参数名称含义说明action请求动作设置为固定的：balanceaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码rt响应数据类型json例如：3.3 .响应数据(status:0,balance:-,chargeType:POSTCHARGEn字段说明status请求结果，具体参见STATUS错误代码表balance当前账户余额，单位厘chargeTypePOSTCHARGE=Jg付费 PRECHARGE预付费4 .客户端主动获取状态报告接口用于客户端到网关获取短信发送的状态报告4.1 .请求地址http:/host:port,，sms请求方式可以采用POST和GET方式，建议采用POST方式42参数说明参数需要URLENCODE ,编码方式采用UTF-8例如：参数名称含义说明action请求动作设置为固定的：reportaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码rt响应数据类型jsonhttD：,，/host：Dort/sms?action=reDort&action=report&account=W&Dassword=密码&rt=ison421 .响应数据status: 0,balance:list:Fag: 1,mid: 4C05,spid: 922011”，acccssCodc:mobile:也stal”： MA:0029,time: 2017-04-12 01:38:21flag: 1,mid: 4C06,spid: 922011,accessCode:mobile: ,stal: MA:0029,time: 2017-04-12 01:38:21 字段说明status请求结果，具体参见status错误代码表balance当前账户余额，单位厘list详细状态报告列表flagI-状态报告mid消息ID（与提交时响应的消息ID匹配）spid归属账号（可忽略）mobile手机号码accessCode下发号码stat状态报告代码，参见STAT状态报告代码表time状态报告的具体时间5.客户端主动获取手机上行接口用户客户端向网关获取手机上行回复的短信5.1 .请求地址him:hoslDort/sms请求方式可以采用POST和GET方式，建议采用POST方式52参数说明参数需要URLENCODE ,编码方式采用UTF-8例如：参数名称含义说明action任务名称设置为固定的：m。account用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码rt响应数据类型jsonhttD：,，7host：Dort.，sms?actionnio&account=Q长号&oassword密码&rt=ison53响应数据status”: 0,balance: