美联API:定义新方式
全面覆盖微服务、消息、数据等技术解决方案
API文档
代码示例
首页 > API文档 > 云服务器

调用说明

验证码接口文档下载:点击下载
普通短信发送
用户在遵循HTTP协议或HTTPS的前提下,可通过GET和POST方式提交短信发送请求
普通短信发送
短信可以提交不超过50000个手机号码,每个号码用英文逗号间隔。 (一次提交发送超过200个手机号码,请使用POST请求)
URL地址为:

http://m.5c.com.cn/api/send/index.php

https://m.5c.com.cn/api/send/index.php

快速应用示例

序号 功能名称 API示例
1 发送短信 http://m.5c.com.cn/api/send/index.php?username= 用 户 名 &password_md5=32 位 MD5 密 码 &apikey= 密 钥 &mobile= 手 机 号 &content=%e9%aa%8c%e8%af%81%e7%a0%81%e6%98%af%ef%bc%9a1A1C%e3%80%90%e7%ad%be%e5%90%8d%e3%80%91%0a&encode=utf-8
2 HTTPS 发送短信 https://m.5c.com.cn/api/send/index.php?username= 用 户 名 &password_md5=32 位 MD5 密 码 &apikey= 密 钥 &mobile= 手 机 号 &content=%e9%aa%8c%e8%af%81%e7%a0%81%e6%98%af%ef%bc%9a1A1C%e3%80%90%e7%ad%be%e5%90%8d%e3%80%91%0a&encode=utf-8
3 发送定时短信 http://m.5c.com.cn/api/send/index.php?username= 用 户 名 &password_md5=32 位 MD5 密 码 &apikey= 密 钥 &mobile= 手 机 号 &content=%e9%aa%8c%e8%af%81%e7%a0%81%e6%98%af%ef%bc%9a1A1C%e3%80%90%e7%ad%be%e5%90%8d%e3%80%91%0a&encode=utf-8 &startTime= 1422526473 说明:startTime 采用 10 位 UNIX 时间戳
4 批量提交短信 http://m.5c.com.cn/api/send/sms_batch.php?format=xml&data={XML 数据} 说明:该接口为一次提交多个批次的不同内容或不同手机的信息
5 查询余额 http://m.5c.com.cn/api/query/index.php?username=用户名&password_md5= 32 位 MD5 密码 &apikey=32 位密钥
6 查询发送记录 http://m.5c.com.cn/api/query/index.php?username= 用 户 名 &password_md5= 32 位 MD5 密 码 &apikey=32 位 密 钥 &action=record&from=1398873600&to=1398960000
7 批量获取状态报告(申请) http://m.5c.com.cn/api/recv/index.php?username=test&password_md5= 32 位 MD5 密码 &apikey=231d1a3dc627ebd0a7cab5b35c397d3e
8 获取指定号码状态报告(申请) http://m.5c.com.cn/api/recv/index.php?username=test&password_md5= 32 位 MD5 密 码 &apikey=231d1a3dc627ebd0a7cab5b35c397d3e&from=1402903139&to=1403017200&mobile=单个手机号
9 批量获取短信回复(申请) http://m.5c.com.cn/api/reply/index.php?username=用户名&password_md5= 32 位 MD5 密码 &apikey=唯一识别码
10 绑定授权 IP 地址 http://m.5c.com.cn/api/bind/index.php?username=用户名&password_md5= 32 位 MD5 密码 &apikey=唯一识别码&ip=IP 地址列表 &action=0

短信发送接口

名称 选项 描述
username 必填 用户账号
password_md5 必填 使用 32 位加密密码提交短信
apikey 必填 APIKEY 密钥,请向业务人员索取
mobile 必填 收件人手机号,多个号码以半角逗号
content 必填 短信内容用 ,使用 urlencode 编码后 提交
startTime 选填 定时发送,UNIX 时间戳,为空立即发送
ext 选填 扩展号(供对代理商开放
encode 选填 GBK 或 UTF-8,如您的编码(文件)是 GBK/GB2312/ASCII,请传入 GBK。如您的编码为 UTF-8,请传入 UTF-8。该参数不区分大小写。示 例:encode=GBK 或 encode=UTF-8

发送接口返回结果

序号 参数 说明
1 success:msgid 提交成功
2 error:Missing username 用户名为空
3 error:Missing password 密码为空
4 error:Missing apikey APIKEY为空
5 error:Missing recipient 手机号为空
6 error:Missing message content 短信内容为空
7 error:Account is blocked 账号被禁用
8 error:Unrecognized encoding 编码未能识别
9 error:APIKEY or password error APIKEY或密码错误
10 error:Unauthorized IP address 未授权 IP 地址
11 error:Account balance is insufficient 余额不足

JSON发送接口

发送接口地址:http://m.5c.com.cn/api/send/index.php?format=json&data={json 数据格式}

请求方式:POST、GET
提交号码数量:不限
数据编码:UTF-8、GBK
提交示例:

{    "type":"send",
     "apikey":"d72f33697f8443b397bddba173e30410",
     "username":"mlrt",
     "password_md 5":"E10ADC3949BA59ABBE56E057F20F883E",
     "encode":"UTF-8",
     "mobile":"18600000001",
     "content":"%e9 %aa%8c%e8%af%81%e7%a0%81%e6%98%af%ef%bc%9a1A1C%e3%80%90%e7%ad%be%e5%90%8d%e3 %80%91%0a"
}

JSON接口输入参数

名称 选项 描述
format 必填 固定值:json
data 必填 JSON字符串

Xml发送接口

发送接口地址:http://m.5c.com.cn/api/send/index.php?format=xml&data={xml 数据格式}

请求方式:POST、GET
提交号码数量:不限
数据编码:UTF-8、GBK
提交示例:
<?xml version='1.0' encoding='utf-8'?>
<sms>
    <type>send</type>
    <apikey>d72f33697f8443b397bddba173e30410</apikey>
    <username>mlrt</username>
    <password_md5>123456</password_md5>
    <encode>UTF-8</encode>
    <mobile>13811299999</mobile>
    <content>%e9%aa%8c%e8%af%81%e7%a0%81%e6%98%af%ef%bc%9a1A1C%e3%80%90%e7%ad%be%e5%90%8d%e3%80%91%0a</content>
</sms>

 

Xml接口输入参数

名称 选项 描述
format 必填 固定值:xml
data 必填 xml字符串

WEB SERVICE发送接口

发送接口地址:http://m.5c.com.cn/api/send/sms_webservice.php?wsdl

请求方式:POST、GET
提交号码数量:不限
数据编码:UTF-8、GBK
提交示例:

$apikey = "请向业务人员索取或登陆平台查询"; $username = "用户名"; $password = "密码"; $mobile = "手机号"; $content = "短信内容"; $soapClient = new SoapClient ($url); $result = $soapClient->sendsms($apikey,$username,$password,$mobile,$content);

批量提交接口

发送接口地址:http://m.5c.com.cn/api/send/sms_batch.php?format=xml&data={xml 数据格式}

请求方式:POST、GET
提交号码数量:不限
数据编码:UTF-8、GBK
应用场景:一次提交多个批次的短信息,该接口仅适用于国内短信应用,暂未适配国际短信、彩信和语音能力。
提交示例:

 <?xml version="1.0" encoding="utf-8"?>
<sms>
    <account>
          <username>用户名</username>
          <password_md5>32 位 MD5 密码</password_md5>
          <apikey>APIKEY,请向业务人员索取或登陆平台查询</apikey>
          <encode>utf-8</encode>
    </account>
    <sms_list>
          <item>
           <mobile>13800000000</mobile>
           <content>%e9%aa%8c%e8%af%81%e7%a0%81%3a123 </content>
           <startTime>0</startTime>
          </item>
    </sms_list>
</sms>

发送速度及负载

业务类型 下发速率 并发数 发送方式 发送方式
通知、验证码(行业) 600 条/秒 <=300 快速下发 ≤10000 条/次
个性短信(行业/营销) 200 条/秒 慢速下发 慢速下发 1 条/次

说明:

1)根据业务类型,平台将自动适配用户的信息属性,提供最优下发速度及高负荷的负 载能力。
2)根据压力测试结果显示,负载均衡 HTTP API 接口在 3600 秒内可以有效处理 1000 万 次发送请求,如您需更高并发连接数请联系技术人员调整。

余额查询接口

余额查询接口地址:http://m.5c.com.cn/api/query/index.php

请求方式:POST、GET
查询余额示例:

http://m.5c.com.cn/api/query/index.php?username=用户名&password_md5=32 位 MD5 密码 &apikey=32 位密钥

查询余额返回结果

返回值 说明
数字/数字 查询成功。余额/总计充值
error:Missing from parameter 缺少开始日期
error:Missing to parameter 缺少结束日期

状态报告抓取接口

查询接口

重要说明: 状态 抓取接口需人工开启,系统默认 开启 :【推送状态】

请求方式:POST、GET
页面编码:UTF-8、GBK
返回数据:1 至 N 条,以半角分号分割
接口地址:

http://m.5c.com.cn/api/recv/index.php

批量获取报告

请求方式:POST、GET
页面编码:UTF-8、GBK
返回数据:1 至 N 条,以半角分号分割

批量获取状态报告示例:http://m.5c.com.cn/api/recv/index.php?username=test&password_md5=E10ADC3949BA59ABBE56E057F20F883E &apikey=231d1a3dc627ebd0a7cab5b35c397d3e

获取指定号码的报告

请求方式:POST、GET
页面编码:UTF-8、GBK
返回数据:一条或多条
开发建议:根据 msgid(流水号)+mobile(手机号)定位短信并设置相应的状态,同批 次短信的 msgid 为同一值。

指定号码获取状态报告示例:http://m.5c.com.cn/api/recv/index.php?username=test&password_md5=E10ADC3949BA59ABBE56E057F 20F883E&apikey=231d1a3dc627ebd0a7cab5b35c397d3e&from=1402903139&to=1403017200&mobile= 单个或多个手机号

指定号码输入参数

名称 选项 描述
username 必填 用户账号
password_md5 必填 用户登陆密码 MD5 值
apikey 必填 APIKEY 密钥,请向业务 人员索取
from 必填 查询开始时间
to 必填 查询结束时间
mobile 必填 手机号

状态报告返回结果

扩展号 流水号 编号 手机号 发送状态 发送时间
3456 13568864638358 2267476 13919214967 DELIVRD 2012-11-15 18:19:52;
5121 13572813669546 3921117 13910704663 DELIVRD 2012-11-15 19:39:12;

注:状态被获取后,将不再显示。暂时无返回状态返回时,显示:no record。如该用户不存在扩展号,则为空。 (扩展号为平台强制签名产生的唯一扩展号码)

状态报告参数说明

返回值 描述
no record 暂无报告
309111755558600,13811299999,DELIVRD,2013-09-12 09:09:31;309111755558598,13811299999,DELIVRD,20 13-09-12 09:09:32; MSGID+手机号+状态+报告时间+分隔符
3456,309111755558600,13811299999,DELIVRD,2013-0 9-12 09:09:31; 扩展号+MSGID+手机号+状态+报告时间+分隔符

状态报告推送接口

 

开通方式:默认开通
配置推送:登陆短信平台-->系统管理-->状态推送-->设置推送地址
推送地址:http://您的域名/目录/脚本文件
请求方式:POST 请求编码:UTF-8
成功返回:success
请求格式:字符串(默认)、JSON 或 XML 格式

字符串格式推送示例:http://www.baidu.com/dir/report.php?data=309111755558600,13811299999,DELIVRD,1456853866;309111755559999,13811299988,DELIVRD,456853877

上行回复抓取接口

接口地址:http://m.5c.com.cn/api/reply/index.php

重要说明: 上行抓取接口需人工开启,系统默认开启:【推送上行】
页面编码:UTF-8、GBK
请求方式:POST、GET
开通方式:人工申请开通
开发建议:由于中国大陆运营商返回的数据无对照 MSGID,建议技术人员根据“扩展号 +mobile(手机号)+date(日期)”将回复与相应手机号关联。

指定号码获取状态报告示例:http://m.5c.com.cn/api/recv/index.php?username=test&password_md5=E10ADC3949BA59ABBE56E057F 20F883E&apikey=231d1a3dc627ebd0a7cab5b35c397d3e&from=1402903139&to=1403017200&mobile= 单个或多个手机号

一次性抓取接口输入参数

名称 选项 描述
username 必填 用户账号
password_md5 必填 用户登陆密码 MD5 值
apikey 必填 APIKEY 密钥,请向业务 人员索取
encode 必填 该参数不区分大小写。示例: encode=GBK 或 encode=UTF-8
debug 必填 为空,非调试模式。为 1,调试模式, 抓取后不重置状态位。为空时,抓取后 将不再显示。

重复抓取接口输入参数

名称 选项 描述
username 必填 用户账号
password_md5 必填 用户登陆密码 MD5 值
apikey 必填 APIKEY 密钥,请向业务 人员索取
encode 必填 该参数不区分大小写。示例: encode=GBK 或 encode=UTF-8
action 必填 参数为:queryByCondition
from 必填 UNIX 时间戳,开始时间
to 必填 UNIX 时间戳,结束时间
mobile 必填 手机号码,一个或多个,多个手机号使 用半角逗号分隔,错误号码自动过滤
说明:因 GET 受 HTTP 协议长度限制,如需抓取 N 个号码,建议使用 POST 提交请求。

按时间段重复抓取回复记录

http://m.5c.com.cn/api/reply/index.php?username= 用 户 名 &password_md5=32 位 MD5 密 码 &apikey= 唯 一 识 别 码 &encode=UTF-8&action=queryByCondition&from=1462032000&to=1464537600

按时间段重复抓取指定号码回复记录:

http://m.5c.com.cn/api/reply/index.php?username= 用 户 名 &password_md5=32 位 MD5 密 码 &apikey= 唯 一 识 别 码 &encode=UTF-8&action=queryByCondition&from=1462032000&to=1464537600&mobile=13811299999,18610310000,N 个号 码或一个号码

上行回复推送接口

推送接口

开通方式:默认开通
配置推送:登陆短信平台-->系统管理-->上行推送-->设置推送地址
推送地址:http://您的域名/目录/脚本文件
请求方式:POST 请求编码:UTF-8
成功返回:success
请求格式:字符串(默认)、JSON 或 XML 格式

字符串格式推送示例:http://www.baidu.com/dir/report.php?data=309111755558600,13811299999,DELIVRD,1456853866;309111755559999,13811299988,DELIVRD,456853877

名称 类型 描述
ext 数值型 主动上行扩展号
replyid 数值型 上行记录的 ID 号
mobile 必填 上行用户手机号码
content 必填 上行回复短信内容,UTF-8 格式、 UrlEncode 编码
receivetime UNIX 时间戳 上行接收时间

联系我们
公众号
    扫描二维码关注
    微信ID:i5ComCn
增值电信业务经营许可证:B-20150482号 全国电信网码号证书:号[2016]00025-A01 ICP备案:京ICP备14058235号
Copyright © 2007-2017 MEILIAN Corporation, All Rights Reserved.

工商网监

经营单位

在线客服
点击在线咨询QQ客服
电话咨询 意见反馈
点击在线QQ反馈
  • 在线客服
  • 电话咨询
  • 意见反馈