提示:若接入平台有任何问题,欢迎联系平台技术人员协助。技术支持QQ:2114927217、客服QQ:393218519。

API接口说明 通信方式:本平台采用HTTP协议(GET/POST)方式通信
API接口地址:http://api.51ym.me/UserInterface.aspx
调用方式: GET/POST
默认编码:UTF8(GB2312请添加传入参数encode=gb2312)

特别提示:
1、首先请调用登录接口或进入用户中心获取Token,才能调用其他接口;
1、下表中带“*”的参数为可选参数,可根据需要选择是否提交该参数;
2、接口地址和参数不区分大小写;
3、接口调用成功则会返回“success”或以“success|”开头的返回值,如果失败则返回相应的【错误代码】;
4、修改账号密码后原有Token自动失效,请重新调用登陆接口获取新的token;
5、获取号码在10分钟内没有被用户释放,系统会强制释放;
6、接入专属对接只需要在易码网站上操作,用户随时可以创建、接入和退出,不需要在接口上传参数
7、开发者请在“获取电话号码”接口处添加传入参数coderid=你的软件作者ID[请登录系统获取]。
   
下载链接 C#示例代码】【易语言示例代码】【按键精灵示例代码(PC版)】【按键精灵示例代码(Android)】【Android触动精灵示例代码(LUA)】【Android示例代码(LUA)
 
接口名称 接口描述
登录 调用登录接口或进入用户中心获取Token,同一个帐号可以在多处同时使用,互不影响。
  http://api.51ym.me/UserInterface.aspx?action=login&username=用户名&password=密码
  传入参数:
username:用户名
password:密码

成功返回值: success|token,除登录外的其他接口调用都需要该参数。(Token长期有效,修改账号密码后原有Token自动失效,请重新获取。)
   
获取账户信息 获取当前用户的账户信息
  http://api.51ym.me/UserInterface.aspx?action=getaccountinfo&token=token
  传入参数:
*format=1,指定返回JSON格式数据,若该参数为空,则返回格式为“|”分割的字符串。

成功返回值:
字符串格式:success|用户名|账户状态|账户等级|账户余额|冻结金额|账户折扣|获取号码最大数量,“|”是分隔符(默认返回数据格式)
JSON格式:success|JSON数据(参数中指定format=1时返回数据格式)
   
获取电话号码 获取电话号码,同一项目同一号码在未释放前可以获取多条短信;如果要用同一号码同时做多个项目,请先按第一个项目获取一个号码,再通过获取指定号码的方式取得该号码在其他项目上的使用权全部项目获取成功后,再开始使用。
  http://api.51ym.me/UserInterface.aspx?action=getmobile&itemid=项目编号&token=token
  传入参数:
itemid=项目编号
*country=国家代码 查看
*province=省代码 查看
*city=市代码 查看
*isp=运营商代码 查看
*mobile=电话号码,指定要获取的号码
*【专属对接】只需要在易码网站上操作创建、接入和退出,不需要在接口上传参数
*excludeno=排除号段,如:不获取170和188号段的号码,则设置为excludeno=170|180。

成功返回值: success|电话号码
   
释放电话号码 释放指定的电话号码,如果号码不再使用请及时释放,否则你未释放的号码达到获取号码上限后将不能获取到新的号码。
  http://api.51ym.me/UserInterface.aspx?action=release&mobile=电话号码&itemid=项目编号&token=token
  传入参数:
*mobile=电话号码
*itemid=项目编号

成功返回值: success
   
释放全部电话号码 释放该用户下的所有号码(包括不同终端获取的全部号码)
  http://api.51ym.me/UserInterface.aspx?action=releaseall&token=token
  传入参数:


成功返回值: success
   
拉黑电话号码 如果该号码无法使用,请将该号码放入黑名单,以后将不会再获取到该号码。
  http://api.51ym.me/UserInterface.aspx?action=addignore&mobile=电话号码&itemid=项目编号&token=token
  传入参数:
mobile=电话号码
itemid=项目编号

成功返回值: success
   
获取短信 在你使用获取到的电话号码后,调用该接口获取短信。因短信可能延迟,建议每5秒调用一次,调用60秒以上(可增加获取成功率)。
  http://api.51ym.me/UserInterface.aspx?action=getsms&mobile=电话号码&itemid=项目编号&token=token
  传入参数:
mobile=电话号码
itemid=项目编号
*release=1,获取短信并释放号码,若要继续使用该号码,请勿带入该参数。

成功返回值: success|短信内容
   
发送短信 向该项目对应的号码发送短信
  http://api.51ym.me/UserInterface.aspx?action=sendsms&mobile=电话号码&itemid=项目编号&sms=发送内容&token=token
  传入参数:
mobile=电话号码,是你获取到的用来发送短信的号码
itemid=项目编号
sms=短信发送内容,建议对发送内容进行URL编码,避免因特殊符号导致参数错误。

成功返回值: success,该处返回success只表示成功提交发送任务,不代表短信已经成功发送,获取发送结果请调用“获取短信发送状态”接口。
   
获取短信发送状态 获取短信发送的状态,因短信发送有一定的延迟,建议每5秒调用一次,调用120秒
  http://api.51ym.me/UserInterface.aspx?action=getsendsmsstate&mobile=电话号码&itemid=项目编号&token=token
  传入参数:
mobile=电话号码,是指你用来发送短信的号码
itemid=项目编号


成功返回值: success:发送成功,fail:发送失败
   
返回错误代码 1001:参数token不能为空
1002:参数action不能为空
1003:参数action错误
1004:token失效
1005:用户名或密码错误
1006:用户名不能为空
1007:密码不能为空
1008:账户余额不足
1009:账户被禁用
1010:参数错误
1011:账户待审核
1012:登录数达到上限
2001:参数itemid不能为空
2002:项目不存在
2003:项目未启用
2004:暂时没有可用的号码
2005:获取号码数量已达到上限
2006:参数mobile不能为空
2007:号码已被释放
2008:号码已离线
2009:发送内容不能为空
2010:号码正在使用中
3001:尚未收到短信
3002:等待发送
3003:正在发送
3004:发送失败
3005:订单不存在
3006:专属通道不存在
3007:专属通道未启用
3008:专属通道密码与项目不匹配
9001:系统错误
9002:系统异常
9003:系统繁忙
   
国家代码 0:默认值
1:中国
2:美国
   
运营商代码 0:默认值
1:移动
2:联通
3:电信
   
省市代码 110000:北京市
    110100:北京市
120000:天津市
    120100:天津市
130000:河北省
    130100:石家庄市
    130200:唐山市
    130300:秦皇岛市
    130400:邯郸市
    130500:邢台市
    130600:保定市
    130700:张家口市
    130800:承德市
    130900:沧州市
    131000:廊坊市
    131100:衡水市
140000:山西省
    140100:太原市
    140200:大同市
    140300:阳泉市
    140400:长治市
    140500:晋城市
    140600:朔州市
    140700:晋中市
    140800:运城市
    140900:忻州市
    141000:临汾市
    141100:吕梁市
150000:内蒙古自治区
    150100:呼和浩特市
    150200:包头市
    150300:乌海市
    150400:赤峰市
    150500:通辽市
    150600:鄂尔多斯市
    150700:呼伦贝尔市
    150800:巴彦淖尔市
    150900:乌兰察布市
    152200:兴安盟
    152500:锡林郭勒盟
    152900:阿拉善盟
210000:辽宁省
    210100:沈阳市
    210200:大连市
    210300:鞍山市
    210400:抚顺市
    210500:本溪市
    210600:丹东市
    210700:锦州市
    210800:营口市
    210900:阜新市
    211000:辽阳市
    211100:盘锦市
    211200:铁岭市
    211300:朝阳市
    211400:葫芦岛市
220000:吉林省
    220100:长春市
    220200:吉林市
    220300:四平市
    220400:辽源市
    220500:通化市
    220600:白山市
    220700:松原市
    220800:白城市
    222400:延边朝鲜族自治州
230000:黑龙江省
    230100:哈尔滨市
    230200:齐齐哈尔市
    230300:鸡西市
    230400:鹤岗市
    230500:双鸭山市
    230600:大庆市
    230700:伊春市
    230800:佳木斯市
    230900:七台河市
    231000:牡丹江市
    231100:黑河市
    231200:绥化市
    232700:大兴安岭地区
310000:上海市
    310100:上海市
320000:江苏省
    320100:南京市
    320200:无锡市
    320300:徐州市
    320400:常州市
    320500:苏州市
    320600:南通市
    320700:连云港市
    320800:淮安市
    320900:盐城市
    321000:扬州市
    321100:镇江市
    321200:泰州市
    321300:宿迁市
330000:浙江省
    330100:杭州市
    330200:宁波市
    330300:温州市
    330400:嘉兴市
    330500:湖州市
    330600:绍兴市
    330700:金华市
    330800:衢州市
    330900:舟山市
    331000:台州市
    331100:丽水市
340000:安徽省
    340100:合肥市
    340200:芜湖市
    340300:蚌埠市
    340400:淮南市
    340500:马鞍山市
    340600:淮北市
    340700:铜陵市
    340800:安庆市
    341000:黄山市
    341100:滁州市
    341200:阜阳市
    341300:宿州市
    341500:六安市
    341600:亳州市
    341700:池州市
    341800:宣城市
350000:福建省
    350100:福州市
    350200:厦门市
    350300:莆田市
    350400:三明市
    350500:泉州市
    350600:漳州市
    350700:南平市
    350800:龙岩市
    350900:宁德市
360000:江西省
    360100:南昌市
    360200:景德镇市
    360300:萍乡市
    360400:九江市
    360500:新余市
    360600:鹰潭市
    360700:赣州市
    360800:吉安市
    360900:宜春市
    361000:抚州市
    361100:上饶市
370000:山东省
    370100:济南市
    370200:青岛市
    370300:淄博市
    370400:枣庄市
    370500:东营市
    370600:烟台市
    370700:潍坊市
    370800:济宁市
    370900:泰安市
    371000:威海市
    371100:日照市
    371200:莱芜市
    371300:临沂市
    371400:德州市
    371500:聊城市
    371600:滨州市
    371700:菏泽市
410000:河南省
    410100:郑州市
    410200:开封市
    410300:洛阳市
    410400:平顶山市
    410500:安阳市
    410600:鹤壁市
    410700:新乡市
    410800:焦作市
    410900:濮阳市
    411000:许昌市
    411100:漯河市
    411200:三门峡市
    411300:南阳市
    411400:商丘市
    411500:信阳市
    411600:周口市
    411700:驻马店市
    419000:省直辖县级行政区划
420000:湖北省
    420100:武汉市
    420200:黄石市
    420300:十堰市
    420500:宜昌市
    420600:襄阳市
    420700:鄂州市
    420800:荆门市
    420900:孝感市
    421000:荆州市
    421100:黄冈市
    421200:咸宁市
    421300:随州市
    422800:恩施土家族苗族自治州
    429000:省直辖县级行政区划
430000:湖南省
    430100:长沙市
    430200:株洲市
    430300:湘潭市
    430400:衡阳市
    430500:邵阳市
    430600:岳阳市
    430700:常德市
    430800:张家界市
    430900:益阳市
    431000:郴州市
    431100:永州市
    431200:怀化市
    431300:娄底市
    433100:湘西土家族苗族自治州
440000:广东省
    440100:广州市
    440200:韶关市
    440300:深圳市
    440400:珠海市
    440500:汕头市
    440600:佛山市
    440700:江门市
    440800:湛江市
    440900:茂名市
    441200:肇庆市
    441300:惠州市
    441400:梅州市
    441500:汕尾市
    441600:河源市
    441700:阳江市
    441800:清远市
    441900:东莞市
    442000:中山市
    445100:潮州市
    445200:揭阳市
    445300:云浮市
450000:广西壮族自治区
    450100:南宁市
    450200:柳州市
    450300:桂林市
    450400:梧州市
    450500:北海市
    450600:防城港市
    450700:钦州市
    450800:贵港市
    450900:玉林市
    451000:百色市
    451100:贺州市
    451200:河池市
    451300:来宾市
    451400:崇左市
460000:海南省
    460100:海口市
    460200:三亚市
    460300:三沙市
    469000:省直辖县级行政区划
500000:重庆市
    500100:重庆市
510000:四川省
    510100:成都市
    510300:自贡市
    510400:攀枝花市
    510500:泸州市
    510600:德阳市
    510700:绵阳市
    510800:广元市
    510900:遂宁市
    511000:内江市
    511100:乐山市
    511300:南充市
    511400:眉山市
    511500:宜宾市
    511600:广安市
    511700:达州市
    511800:雅安市
    511900:巴中市
    512000:资阳市
    513200:阿坝藏族羌族自治州
    513300:甘孜藏族自治州
    513400:凉山彝族自治州
520000:贵州省
    520100:贵阳市
    520200:六盘水市
    520300:遵义市
    520400:安顺市
    520500:毕节市
    520600:铜仁市
    522300:黔西南布依族苗族自治州
    522600:黔东南苗族侗族自治州
    522700:黔南布依族苗族自治州
530000:云南省
    530100:昆明市
    530300:曲靖市
    530400:玉溪市
    530500:保山市
    530600:昭通市
    530700:丽江市
    530800:普洱市
    530900:临沧市
    532300:楚雄彝族自治州
    532500:红河哈尼族彝族自治州
    532600:文山壮族苗族自治州
    532800:西双版纳傣族自治州
    532900:大理白族自治州
    533100:德宏傣族景颇族自治州
    533300:怒江傈僳族自治州
    533400:迪庆藏族自治州
540000:西藏自治区
    540100:拉萨市
    540200:日喀则市
    542100:昌都地区
    542200:山南地区
    542400:那曲地区
    542500:阿里地区
    542600:林芝地区
610000:陕西省
    610100:西安市
    610200:铜川市
    610300:宝鸡市
    610400:咸阳市
    610500:渭南市
    610600:延安市
    610700:汉中市
    610800:榆林市
    610900:安康市
    611000:商洛市
620000:甘肃省
    620100:兰州市
    620200:嘉峪关市
    620300:金昌市
    620400:白银市
    620500:天水市
    620600:武威市
    620700:张掖市
    620800:平凉市
    620900:酒泉市
    621000:庆阳市
    621100:定西市
    621200:陇南市
    622900:临夏回族自治州
    623000:甘南藏族自治州
630000:青海省
    630100:西宁市
    630200:海东市
    632200:海北藏族自治州
    632300:黄南藏族自治州
    632500:海南藏族自治州
    632600:果洛藏族自治州
    632700:玉树藏族自治州
    632800:海西蒙古族藏族自治州
640000:宁夏回族自治区
    640100:银川市
    640200:石嘴山市
    640300:吴忠市
    640400:固原市
    640500:中卫市
650000:新疆维吾尔自治区
    650100:乌鲁木齐市
    650200:克拉玛依市
    652100:吐鲁番地区
    652200:哈密地区
    652300:昌吉回族自治州
    652700:博尔塔拉蒙古自治州
    652800:巴音郭楞蒙古自治州
    652900:阿克苏地区
    653000:克孜勒苏柯尔克孜自治州
    653100:喀什地区
    653200:和田地区
    654000:伊犁哈萨克自治州
    654200:塔城地区
    654300:阿勒泰地区
    659000:自治区直辖县级行政区划