哲合通短信接口说明文档.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:21"Fag": 1,
"mid”: "4C06","spid”: "922011",
"mobile": ","stal”："测试内曾，
"time": "2017-04-12 01:38:21"
}
]
字段
说明
status
请求结果，具体参见STATUS错误代码表
balance
当前账户余额，单位厘
list
详细状态报告列表
flag
0=手机用户上行
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:21""flag": 1,
"mid": "4C06","spid": "922011”,
"mobile”:
"stat": "DELIVRD","lime": "2017-04-12 01:38:21"
字段
说明
list
详细状态报告列表
flag
0-手机用户上行1=状态报告
mid
flag=l时，消息ID与提交时响应的消息ID匹配；flag=0时，表示该条上行的消息ID
spid
归属账号(可忽略)
mobile
WL号码
acccssCodc
接收号码,即SP服务号(I06XXXXXX )
content
手机上行的具体内容；flag=l时，该字段无效
stat
状态报告代码，具体参见STAT状态代码表；flag=O时，该字段无效
time
手机上行的具体时间
6.3 .客户端响应
客户端接收成功，响应文本OK即可OK
7. STATUS错误代码表
错误代码
具体含义
1
消息包格式错误
2
IP鉴权错误
3
账号密码不正确
4
版本号错误
5
其它错误
6
接入点错误（如账户本身开的是CMPP接入）
7
账号状态异常（账号已停用）
21
连接过多
100
系统内部错误，一般情况下例如：提交手机号码为电信,但是该账号没用可用的电 信接出点
102
单次提交的号码数过多（建议200以内）
8. RESULT错误代码表
错误代码
具体含义
10
原发号码错误，即extno错误
15
余额不足
17
账号签名无效
9. STAT状态代码表
荷吴代码
说明
DELIVRD
短信投
EXPIRED
Message validity period has expired
DELETED
Message has been deleted.
REJECTED
Message is in a rejected state
MA: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:NNNN
NNNN为对外提交过程中，上级网关的返回值,具体含义需上级网关解释
10.常见错误
错误码10提交短信过程中返回10 ,接入码错误，即ex（no=106XXXXXX不正确,
解决方法：填写正确的接入码（网关管理员可以从生产账号摘要中获取该接入号）错误码17
提交短信过程中返回17 ,签名错误解决方法:
提交内容中带上网关管理员已经报备的签名
网关管理员在（客户管理一账号签名报备）中关闭该账号的签名校验功能错误码15
提交短信过程中返回15余额不足 解决方法：
• 网关管理员对该账号充值网关管理员将该账号设置为后付费
H.接入示例PHP端示例
<?php namespace app\components;use Yii;
/**，短信平台
♦/ class SMS Verifier extends \Yii\base\Object
=":7862/sms/?”;
='999063';
='Zmed8X';
private static Sbaseurl private static Suscmamc
private static Spwd
private static Sextno
private static SverifyTemplate = *【哲合科技】短信验证码为：%verifyCode% , %duration%分钟内有 效,请勿将验证码提供给他人。'；
private static function getCodeCacheKey(Smobile)
{
return 'sms_' . Smobile;
}
public static function gctVcrifyCode($mohilc)
{
return Yii::$app->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 ($result['status'] = '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<String. String> params = new HashMap<String, String>();
("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：DOru'sms
请求方式可以POST和GET方式,建议采用POST方式12参数说明
参数需要URLENCODE ,编码方式采用UTF-8例如：
参数名称
含义
说明
action
请求动作
设置为固定的:send
account
发送用户帐号
用户帐号，由系统管理员
password
发送帐号密码
用户账号对应的密码
mobile
全部被叫号码
发信发送的目的号码.多个号码之间用半角逗号隔开、 最多500个号码
content
发送内容
短信的内容，内容需要UTF-8 URLEncode编码
extno
接入号
接入号，即SP服务号(106XXXXXX )
Ft
响应数据类型
json
littp:.7host:port,，sms?action=send&account=j!K'^'&password=^55&mobile=,&content=内容&extno=&rt=json
13响应数据{
"status": "0",
"balance":
"list”:[
{"mid”: "4C2CA",
"mobile”:也"result": 0
"mid": "4C2CA'\"mobile":
"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
请求动作
设置为固定的:p2p
account
发送用户帐号
用户帐号，由系统管理员
password
发送帐号密码
用户账号对应的密码
mobilcContcntList
号码短信内容列表
号码内容格式为：Mobile[TAB]Content 多个号码之间用换行分割如：
#下发内容1
#下发内容2
#下发内容3
#下发内容4
extno
接入号
接入号，即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": 0
"mid”: "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
请求动作
设置为固定的：balance
account
用户帐号
用户帐号，由系统管理员
password
帐号密码
用户账号对应的密码
rt
响应数据类型
json
例如：
3.3 .响应数据
("status":0,"balance":-,"chargeType":"POSTCHARGEn}
字段
说明
status
请求结果，具体参见STATUS错误代码表
balance
当前账户余额，单位厘
chargeType
POSTCHARGE=Jg付费 PRECHARGE"预付费
4 .客户端主动获取状态报告接口用于客户端到网关获取短信发送的状态报告
4.1 .请求地址http://host:port,，sms
请求方式可以采用POST和GET方式，建议采用POST方式42参数说明
参数需要URLENCODE ,编码方式采用UTF-8例如：
参数名称
含义
说明
action
请求动作
设置为固定的：report
account
用户帐号
用户帐号，由系统管理员
password
帐号密码
用户账号对应的密码
rt
响应数据类型
json
httD：,，''/host：Dort/sms?action=reDort&action=report&account=W^~&Dassword=密码&rt=ison
421 .响应数据{
"status": "0",
"balance":
"list":[
{Fag": 1,
"mid": "4C05","spid": "922011”，
"acccssCodc":
"mobile":也"stal”： "MA:0029",
"time": "2017-04-12 01:38:21°"flag": 1,
"mid": "4C06","spid": "922011",
"accessCode":
"mobile": ","stal": "MA:0029",
"time": "2017-04-12 01:38:21" }
]
字段
说明
status
请求结果，具体参见status错误代码表
balance
当前账户余额，单位厘
list
详细状态报告列表
flag
I-状态报告
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
响应数据类型
json
httD：,，7host：Dort.，''sms?action—nio&account=Q长号&oassword—密码&rt=ison
53响应数据
"status”: "0",
"balance":