SMS57 for SMGW 客户接口说明文档
1.1. 请求地址
http://sms.lianluxinxi.com:7862/sms?action=send,建议采用POST方式
1.2. 参数说明
参数需要 URLENCODE,编码方式采用UTF-8
参数名称 | 含义 | 说明 |
action | 发送任务命令 | 设置为固定的:send |
account | 发送用户帐号 | 用户帐号,由系统管理员 |
password | 发送帐号密码 | 用户账号对应的密码 |
mobile | 全部被叫号码 | 发信发送的目的号码.多个号码之间用半角逗号隔开 |
content | 发送内容 | 短信的内容,内容需要UTF-8编码 |
extno | 接入号 | 接入号,即 10690XXXXXX类似的号码 |
例如:
http://sms.lianluxinxi.com:7862/sms?action=send&account=账号&password=密码&mobile=15023239810,13527576163&content=内容&extno=1069012345
1.3. 返回值
在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:
<?xml version='1.0' encoding='utf-8' ?>
<returnsms>
<returnstatus>status</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Failed
<message>message</message> ---------- 返回信息提示,正确情况下,返回“ok“,其他情况参见《MESSAGE错误代码表》
<remainpoint>remainpoint</remainpoint> ---------- 返回余额
<taskID>taskID</taskID> ----------- (忽略该字段,具体每条消息对应的消息ID见resplist)
<resplist>
<resp>MID1#@#MOBILE1#@# RESULTCODE</resp> ------MID1 消息ID,MOBILE1 提交的手机号码,参见《RESULTCODE》错误代码表
<resp>MID2#@#MOBILE2#@# RESULTCODE</resp>
<resp>MID3#@#MOBILE3#@# RESULTCODE</resp>
</resplist>
</returnsms>
2. 点对点发送
2.1. 接口请求地址
http://sms.lianluxinxi.com:7862/sms?action=p2p 请求方式建议采用POST方式
2.2. 参数定义
参数需要 URLENCODE,编码方式采用UTF-8
参数名称 | 含义 | 说明 |
action | 发送任务命令 | 设置为固定的:p2p |
account | 发送用户帐号 | 用户帐号,由系统管理员 |
password | 发送帐号密码 | 用户账号对应的密码 |
mobileContentList | 号码短信内容列表 | 号码内容格式为:Mobile[TAB]Content 13800000002 下发内容2 13800000003 下发内容3 13800000004 下发内容4 |
extno | 接入号 | 接入号,即 10690XXXXXX类似的号码 |
例如: http://host:port/sms?action=p2p&account=账号&password=密码&mobileContentList=13800000001%09%E4%B8%8B%E5%8F%91%E5%86%85%E5%AE%B91%0A13800000002%09%E4%B8%8B%E5%8F%91%E5%86%85%E5%AE%B92%0A13800000003%09%E4%B8%8B%E5%8F%91%E5%86%85%E5%AE%B93%0A13800000004%09%E4%B8%8B%E5%8F%91%E5%86%85%E5%AE%B94&extno=10690231221
2.3. 返回值
在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:
<?xml version='1.0' encoding='utf-8' ?>
<returnsms>
<returnstatus>status</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Failed
<message>message</message> ---------- 返回信息提示,正确情况下,返回“ok“,其他情况参见《MESSAGE错误代码表》
<remainpoint>remainpoint</remainpoint> ---------- 返回余额
<taskID>taskID</taskID> ----------- (忽略该字段,具体每条消息对应的消息ID见resplist)
<resplist>
<resp>MID1#@#MOBILE1#@# RESULTCODE</resp> ------MID1 消息ID,MOBILE1 提交的手机号码,参见《RESULTCODE》错误代码表
<resp>MID2#@#MOBILE2#@# RESULTCODE</resp>
<resp>MID3#@#MOBILE3#@# RESULTCODE</resp>
</resplist>
</returnsms>
3. 余额查询接口
3.1. 请求地址
http://sms.lianluxinxi.com:7862/sms?action=overage 请求方式可以 POST 和 GET方式,建议采用POST方式
3.2. 参数说明
参数需要 URLENCODE,编码方式采用UTF-8
参数名称 | 含义 | 说明 |
action | 任务名称 | 设置为固定的:overage |
account | 用户帐号 | 用户帐号,由系统管理员 |
password | 帐号密码 | 用户账号对应的密码 |
|
|
|
例如: http://sms.lianluxinxi.com:7862/sms?action=overage&account=账号&password=密码
3.3. 返回值
<?xml version='1.0' encoding='utf-8' ?>
<returnsms>
<returnstatus>status</returnstatus> -------返回状态值:成功返回Success 失败返回:Failed
<message>message</message> -----返回信息提示,正确情况下,返回ok,其他情况参见《MESSAGE错误代码表》
<payinfo>payinfo</payinfo> --------------返回支付方式 后付费,预付费
<overage>overage</overage> -------------返回余额
<sendTotal>sendTotal</sendTotal> ----返回总点数 (可忽略该字段)
</returnsms>
4. 状态报告接口
4.1. 请求地址
http://sms.lianluxinxi.com:7862/sms?action=report 请求方式可以采用 POST 和 GET方式,建议采用POST方式
参数需要 URLENCODE,编码方式采用UTF-8
参数名称 | 含义 | 说明 |
action | 任务名称 | 设置为固定的:report |
account | 用户帐号 | 用户帐号,由系统管理员 |
password | 帐号密码 | 用户账号对应的密码 |
|
|
|
例如:
http://sms.lianluxinxi.com:7862/sms?action=report&action=report&account=账号&password=密码
4.3. 返回值
<?xml version='1.0' encoding='utf-8' ?>
<returnsms>
<statusbox>
<mobile>15023239810</mobile> -------------对应的手机号码
<taskid>1212</taskid> -------------同一批任务ID
<status>10</status> ---------状态报告----10:发送成功,20:发送失败
<receivetime>2011-12-02 22:12:11</receivetime> -------------接收时间
<errorcode>DELIVRD <errorcode/> > -------------上级网关返回值,不同网关返回值不同,仅作为参考
<extno>01</extno> --------子号,即自定义扩展号
</statusbox>
<statusbox>
<mobile>15023239810</mobile>
<taskid>1212</taskid>
<status>20</status>
<receivetime>2011-12-02 22:12:11</receivetime>
<errorcode>2</errorcode>
<extno></extno>
</statusbox>
</returnsms>
4.4. 错误返回值——状态报告请求错误返回格式及对应值
<?xml version='1.0' encoding='utf-8' ?>
<returnsms>
<errorstatus>
<error>1</error> -------------错误码,参见错误代码表《MESSAGE错误代码表》
<remark></remark> -------------错误描述
</errorstatus>
</returnsms>
5. 上行接口
5.1. 请求地址
http://sms.lianluxinxi.com:7862/sms?action=mo 请求方式可以采用 POST 和 GET方式,建议采用POST方式
5.2. 参数说明
参数需要 URLENCODE,编码方式采用UTF-8
参数名称 | 含义 | 说明 |
action | 任务名称 | 设置为固定的:mo |
account | 用户帐号 | 用户帐号,由系统管理员 |
password | 帐号密码 | 用户账号对应的密码 |
|
|
|
例如: http://sms.lianluxinxi.com:7862/sms?action=mo&action=mo&account=账号&password=密码
5.3. 返回值
<?xml version='1.0' encoding='utf-8' ?>
<returnsms>
<callbox>
<mobile>15023239810</mobile> -------------对应的手机号码
<extno>1069012345</extno>
<taskid>1212</taskid> -------------同一批任务ID
<content>你好,我不需要</content> ---------上行内容
<receivetime>2011-12-02 22:12:11</receivetime> -------------接收时间
</callbox>
<callbox>
<mobile>15023239811</mobile>
<extno>1069012345</extno>
<taskid>1212</taskid>
<content>你好,本次活动路线是怎么的</content>
<receivetime>2011-12-02 22:12:11</receivetime>
</callbox>
</returnsms>
5.4. 错误返回值——回复请求错误返回格式及对应值
<?xml version='1.0' encoding='utf-8' ?>
<returnsms>
<errorstatus>
<error>1</error> -------------错误码,参见错误代码表《MESSAGE错误代码表》
<remark>用户名或密码不能为空</remark> -------------错误描述
</errorstatus>
</returnsms>
6. MESSAGE错误代码表
错误码 错误描述 解决办法
0 成功
2 IP错误 检查“接入账号管理”中,客户账号绑定IP是否正确
3 鉴权错误 检查客户账号密码是否有误
5 其他错误 联系网关技术人员处理
6 错误的接入点 检查“接入账号管理”中,修改账户的接入点;通常情况造成该原因是因为 账号开通的 SOAP 接入方式,而使用CMPP协议在接入或者相反;
7 错误的状态 检查“接入账号管理”中,客户账户状态是否为停用
15 余额不足 对客户账户进行充值;或者将账户该为“后付费”
21 连接过多 该错误通常是由于客户端发起过多连接造成的;一般情况下,可以断开客户端所有连接,等待30秒后重试;或者将客户账号的最大连接数 设置更大值
100 内部错误 联系网关技术人员处理
7. RESULTCODE错误代码表
错误码 错误描述 解决办法
0 提交成功
6 错误的消息长度 网关最大支持 500汉字提交;请检查短信内容是否超长
10 错误的原发号码,接入码错误 检查接入码是否与账号设定值一致;即SMS57-HTTP协议中的 extno=106XXXXX 是否正确,SOAP57 中的 AccessCode=106XXXXX
12 错误的目的号码 检查接收短信手机号码格式是否正确
15 余额不足 对客户账户进行充值;或者将账户该为“后付费”
16 该时间段内禁止下发 检查“接入账号管理”中,修改下发时间段;
17 签名无效 检查“账号签名报备”中,签名是否已经报备或者 关闭该账户签名校验;