推立方短信API

一、短信发送

调用地址:
UTF8:
http://www.tui3.com/api/send/?k=发送密钥&r=执行结果格式&p=短信产品id&t=接收手机号&c=发送内容
GBK:http://www.tui3.com/api/send/?k=发送密钥&r=执行结果格式&p=短信产品id&t=接收手机号&cn=发送内容
 

参数说明:

k:  32位随机值,由系统自动产生,该值请到产品配置中获取。该值请注意安全保管,勿泄露。
p: 1:“推信”; 2:“推信DIY”。
r: 调用后返回的结果格式。json(默认)  xml
t:接收手机列表,多个手机号码请用,分隔(最多支持100个手机号)
c: 发送内容(utf8格式编码) cn: 发送内容(gbk格式编码)

返回结果(XML格式,JSON和此相同):

<result>
<err_code>错误代码</err_code>      // 0:正确处理
<err_msg>错误描述</err_msg>       // err_code非0时返回错误描述字符串
<tick_ids>id</tick_ids>    //发送后返回的查询ID。如果为多个手机号,则返回多个id,中间用, 分隔,如果tick_id为-1,则说明该手机号非法,不予发送
<sms_count>处理的短信数量</sms_count> //如果超过一条短信数量,系统将自动拆分进行发送。该值为最后发送的短信数量。
<remain_count>剩余短信数量</remain_count>
</result>
注:因为是异步发送(收到发送请求后立刻返回,由系统其它进程负责发送),所以返回的 sms_count, remain_count 均为估算值,并非精确值。

二、余额查询

调用地址:http://www.tui3.com/api/query/?k=密钥&r=执行结果格式

返回结果:

<result>
<err_code>错误代码</err_code>      // 0:正确处理
<err_msg>错误描述</err_msg>       // err_code非0时返回错误描述字符串
<count1>实时通道1剩余数量</count1>
<count2>实时通道2剩余数量</count2>
</result>

三、上行短信接收

本系统支持两种短信上行模式,一为PUSH模式,系统收到短信后,推送到用户设置好的接收地址。详见:短信通知接口

第二种为轮询模式:
调用地址:http://www.tui3.com/api/recv/?k=密钥&r=执行结果格式&id=最小id
说明:每次调用,系统最多返回记录编号大于id的50条记录。如果不指定id, 则返回最早的50条记录。
客户端在调用时,每次可以把最大的id值记录下来,下次调用时指定为 id 值 

返回结果:

<result>
<err_code>错误代码</err_code>      // 0:正确处理
<err_msg>错误描述</err_msg>       // err_code非0时返回错误描述字符串
<list>
<id>ID</id><sms><time>接收时间</time><mobile>手机号码</mobile><content>内容</content></sms>
....
</list>
</result>

四、短信发送状态

本系统支持两种短信发送状态查询,一为PUSH模式,系统发送短信后,推送状态到用户设置好的接收地址。详见:短信通知接口

第二种为查询模式:
调用地址:http://www.tui3.com/api/status/?k=密钥&r=执行结果格式&tick_ids=id列表
说明:用户调用API发送短信时,记录下发送的 tick_ids, 做为参数进行状态查询(id 间用逗号分隔,最多查询100条记录的状态)

返回结果:

<result>
<err_code>错误代码</err_code>      // 0:正确处理
<err_msg>错误描述</err_msg>       // err_code非0时返回错误描述字符串
<list>
<status>
<id>tickid</id>
<success>成功状态标志</success> //1:成功; 0:失败
<request_time>收到请求的时间</request_time>
<process_time>处理请求的时间</process_time>
<process_flag>处理状态</process_flag>  // 0: 收到请求 1:准备发送  2:处理完成
<count>短信数量</count>
<memo>描述</memo>
</status>
....
</list>
</result> 

 

五、错误代码:
0:正常
1:服务未开通
2:非法KEY
3:IP地址非法
4:无合法接收手机号码
5:有违禁内容,拒绝发送
6:短信格式未备案(实时短信)
7:发送短信内容不符合备案格式(实时短信)
8:余额不足
9:批量处理超过限额
10:参数不正确
11:发送过于频繁,超过频率限制
大于100:其它错误

 

六、备注

上述所列API均支持 HTTP GET和POST模式,数据量少推荐使用GET模式,数据量大请使用POST模式.

使用举例,请见:演示代码

API全文下载http://www.tui3.com/download/Tui3SMSSDK.zip