This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
云码平台 - 商家接入文档
商家身份鉴权
调用API接口， 请在 HTTP 请求头中添加您账号的 JWT Token ：
- Header Key：Authorization
- Header Value：XXXXXXXXXXX （查看商家授权令牌）
查询账户余额
接口地址：https://api.code92.top/api/adm/wallet/paged.query
请求示例(POST)：
{
"page": 1,
"pageSize": 1
}
响应示例：
{
"code": "succeed",
"data": {
"rows": [
{
"amount": 100, // 钱包余额
"amountFreeze": 0 // 冻结金额（还在进行中的订单，会预先冻结，订单结算后会解冻。实际可用余额 = amount - amountFreeze）
}
]
}
}
短信接码流程
获取手机号
接口地址：https://api.code92.top/api/adm/sms.code/get.phone
请求示例(POST)：
{
"project": "telegram", // 接码项目，可选值：见本页底部项目表
"provider": "terminal", // 此项固定不可变
"countryCode": "us" // 获取指定国家的手机号（两位国家编码），传“um”表示不指定国家，随机分配。其它可选值：见本页底部国家代码表
}
成功响应示例：
{
"code": "succeed", // 使用if ( code == "succeed" ) 判定获取成功。
"data": {
"callingCode": 66, // 国际电话区号
"id": 552149995081733, // 业务流水号，存下来，在后续的接口调用中要传入。
"phoneNumber": "858683974" // 不带区号的电话号码
}
}
失败响应示例：
{
"code": "unexpected", // 错误码
"msg": "外部接口异常 0|-1" // 错误原因
}
获取验证码
此步骤需要多次尝试，建议设定请求间隔为5s，持续5min
接口地址：https://api.code92.top/api/adm/sms.code/get
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
取到码响应示例：
{
"code": "succeed",
"data": {
"receiveStatus": "received", // 如果取到短信验证码 此字段值为 “received”
"smsCode": "1234" // 短信验证码
}
}
未取到码示例：
{
"code": "succeed",
"data": {
"receiveStatus": "waiting" // 如果是waiting，或者executing ，说明还在取码中，可等待几秒再调用此接口
}
}
{
"code": "succeed",
"data": {
"receiveStatus": "timeout" // 如果是timeout，说明长时间未收到验证码，系统已经自动释放了该手机号，不会再去收码了。
}
}
报告验证码错误
如您收到验证码输入目标程序后提示验证码不正确，可调用错误上报接口，将该次任务状态重置为waiting， 之后继续执行步骤3，直到状态为received，即收到了新的正确的验证码。
接口地址：https://api.code92.top/api/adm/sms.code/report.sms.code.error
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
响应示例：
{
"code": "succeed",
"data": 1
}
释放手机号
如果调用步骤2多次未获取到验证码，需要放弃此号继续做下一个任务时，请调用释放手机号接口，释放手机号之后即停止计费，避免损耗。
接口地址：https://api.code92.top/api/adm/sms.code/release.phone
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
响应示例：
{
"code": "succeed",
"data": 1
}
拉黑手机号
如果不希望获取到某个手机号，可以调用手机号拉黑接口，拉黑之后可确保24小时内不会再次取到此手机号。
接口地址：https://api.code92.top/api/adm/sms.code/ban.phone
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
响应示例：
{
"code": "succeed",
"data": 1
}
项目表
telegram = 1 (Telegram)
line = 2 (Line)
whatsApp = 3 (WhatsApp)
gmail = 4 (Gmail)
apple = 5 (Apple)
instagram = 6 (Instagram)
tikTok = 7 (TikTok)
microsoft = 8 (Microsoft)
papara = 9 (Papara)
interlace = 10 (Interlace)
国家代码表
af = 4 (阿富汗)
al = 8 (阿尔巴尼亚)
aq = 10 (南极洲)
dz = 12 (阿尔及利亚)
as = 16 (美属萨摩亚)
ad = 20 (安道尔)
ao = 24 (安哥拉)
ag = 28 (安提瓜和巴布达)
az = 31 (阿塞拜疆)
ar = 32 (阿根廷)
au = 36 (澳大利亚)
at = 40 (奥地利)
bs = 44 (巴哈马)
bh = 48 (巴林)
bd = 50 (孟加拉国)
am = 51 (亚美尼亚)
bb = 52 (巴巴多斯)
be = 56 (比利时)
bm = 60 (百慕大)
bt = 64 (不丹)
bo = 68 (玻利维亚)
ba = 70 (波黑)
bw = 72 (博茨瓦纳)
bv = 74 (布韦岛)
br = 76 (巴西)
bz = 84 (伯利兹)
io = 86 (英属印度洋领地)
sb = 90 (所罗门群岛)
vg = 92 (英属维尔京群岛)
bn = 96 (文莱)
bg = 100 (保加利亚)
mm = 104 (缅甸)
bi = 108 (布隆迪)
by = 112 (白俄罗斯)
kh = 116 (柬埔寨)
cm = 120 (喀麦隆)
ca = 124 (加拿大)
cv = 132 (佛得角)
ky = 136 (开曼群岛)
cf = 140 (中非)
lk = 144 (斯里兰卡)
td = 148 (乍得)
cl = 152 (智利)
cn = 156 (中国)
tw = 158 (台湾)
cx = 162 (圣诞岛)
cc = 166 (科科斯基林群岛)
co = 170 (哥伦比亚)
km = 174 (科摩罗)
yt = 175 (马约特)
cg = 178 (刚果共和国)
cd = 180 (刚果民主共和国)
ck = 184 (库克群岛)
cr = 188 (哥斯达黎加)
hr = 191 (克罗地亚)
cu = 192 (古巴)
cy = 196 (塞浦路斯)
cz = 203 (捷克)
bj = 204 (贝宁)
dk = 208 (丹麦)
dm = 212 (多米尼克)
do = 214 (多米尼加)
ec = 218 (厄瓜多尔)
sv = 222 (萨尔瓦多)
gq = 226 (赤道几内亚)
et = 231 (埃塞俄比亚)
er = 232 (厄立特里亚)
ee = 233 (爱沙尼亚)
fo = 234 (法罗群岛)
fk = 238 (福克兰群岛)
gs = 239 (南乔治亚和南桑威奇群岛)
fj = 242 (斐济)
fi = 246 (芬兰)
ax = 248 (奥兰)
fr = 250 (法国)
gf = 254 (法属圭亚那)
pf = 258 (法属波利尼西亚)
tf = 260 (法属南部和南极领地)
dj = 262 (吉布提)
ga = 266 (加蓬)
ge = 268 (格鲁吉亚)
gm = 270 (冈比亚)
ps = 275 (巴勒斯坦)
de = 276 (德国)
gh = 288 (加纳)
gi = 292 (直布罗陀)
ki = 296 (基里巴斯)
gr = 300 (希腊)
gl = 304 (格陵兰)
gd = 308 (格林纳达)
gp = 312 (瓜德罗普)
gu = 316 (关岛)
gt = 320 (危地马拉)
gn = 324 (几内亚)
gy = 328 (圭亚那)
ht = 332 (海地)
hm = 334 (赫德岛和麦克唐纳群岛)
va = 336 (梵蒂冈)
hn = 340 (洪都拉斯)
hk = 344 (香港)
hu = 348 (匈牙利)
is = 352 (冰岛)
in = 356 (印度)
id = 360 (印度尼西亚)
ir = 364 (伊朗)
iq = 368 (伊拉克)
ie = 372 (爱尔兰)
il = 376 (以色列)
it = 380 (意大利)
ci = 384 (科特迪瓦)
jm = 388 (牙买加)
jp = 392 (日本)
kz = 398 (哈萨克斯坦)
jo = 400 (约旦)
ke = 404 (肯尼亚)
kp = 408 (朝鲜)
kr = 410 (韩国)
kw = 414 (科威特)
kg = 417 (吉尔吉斯斯坦)
la = 418 (老挝)
lb = 422 (黎巴嫩)
ls = 426 (莱索托)
lv = 428 (拉脱维亚)
lr = 430 (利比里亚)
ly = 434 (利比亚)
li = 438 (列支敦士登)
lt = 440 (立陶宛)
lu = 442 (卢森堡)
mo = 446 (澳门)
mg = 450 (马达加斯加)
mw = 454 (马拉维)
my = 458 (马来西亚)
mv = 462 (马尔代夫)
ml = 466 (马里)
mt = 470 (马耳他)
mq = 474 (马提尼克)
mr = 478 (毛里塔尼亚)
mu = 480 (毛里求斯)
mx = 484 (墨西哥)
mc = 492 (摩纳哥)
mn = 496 (蒙古)
md = 498 (摩尔多瓦)
me = 499 (黑山)
ms = 500 (蒙特塞拉特)
ma = 504 (摩洛哥)
mz = 508 (莫桑比克)
om = 512 (阿曼)
na = 516 (纳米比亚)
nr = 520 (瑙鲁)
np = 524 (尼泊尔)
nl = 528 (荷兰)
cw = 531 (库拉索)
aw = 533 (阿鲁巴)
sx = 534 (荷属圣马丁)
bq = 535 (荷兰加勒比区)
nc = 540 (新喀里多尼亚)
vu = 548 (瓦努阿图)
nz = 554 (新西兰)
ni = 558 (尼加拉瓜)
ne = 562 (尼日尔)
ng = 566 (尼日利亚)
nu = 570 (纽埃)
nf = 574 (诺福克岛)
no = 578 (挪威)
mp = 580 (北马里亚纳群岛)
um = 581 (美国本土外小岛屿)
fm = 583 (密克罗尼西亚联邦)
mh = 584 (马绍尔群岛)
pw = 585 (帕劳)
pk = 586 (巴基斯坦)
pa = 591 (巴拿马)
pg = 598 (巴布亚新几内亚)
py = 600 (巴拉圭)
pe = 604 (秘鲁)
ph = 608 (菲律宾)
pn = 612 (皮特凯恩群岛)
pl = 616 (波兰)
pt = 620 (葡萄牙)
gw = 624 (几内亚比绍)
tl = 626 (东帝汶)
pr = 630 (波多黎各)
qa = 634 (卡塔尔)
re = 638 (留尼汪)
ro = 642 (罗马尼亚)
ru = 643 (俄罗斯)
rw = 646 (卢旺达)
bl = 652 (圣巴泰勒米)
sh = 654 (圣赫勒拿)
kn = 659 (圣基茨和尼维斯)
ai = 660 (安圭拉)
lc = 662 (圣卢西亚)
mf = 663 (法属圣马丁)
pm = 666 (圣皮埃尔和密克隆)
vc = 670 (圣文森特和格林纳丁斯)
sm = 674 (圣马力诺)
st = 678 (圣多美和普林西比)
sa = 682 (沙特阿拉伯)
sn = 686 (塞内加尔)
rs = 688 (塞尔维亚)
sc = 690 (塞舌尔)
sl = 694 (塞拉利昂)
sg = 702 (新加坡)
sk = 703 (斯洛伐克)
vn = 704 (越南)
si = 705 (斯洛文尼亚)
so = 706 (索马里)
za = 710 (南非)
zw = 716 (津巴布韦)
es = 724 (西班牙)
ss = 728 (南苏丹)
sd = 729 (苏丹)
eh = 732 (西撒哈拉)
sr = 740 (苏里南)
sj = 744 (斯瓦尔巴和扬马延)
sz = 748 (斯威士兰)
se = 752 (瑞典)
ch = 756 (瑞士)
sy = 760 (叙利亚)
tj = 762 (塔吉克斯坦)
th = 764 (泰国)
tg = 768 (多哥)
tk = 772 (托克劳)
to = 776 (汤加)
tt = 780 (特立尼达和多巴哥)
ae = 784 (阿联酋)
tn = 788 (突尼斯)
tr = 792 (土耳其)
tm = 795 (土库曼斯坦)
tc = 796 (特克斯和凯科斯群岛)
tv = 798 (图瓦卢)
ug = 800 (乌干达)
ua = 804 (乌克兰)
mk = 807 (北马其顿)
eg = 818 (埃及)
gb = 826 (英国)
gg = 831 (根西)
je = 832 (泽西)
im = 833 (马恩岛)
tz = 834 (坦桑尼亚)
us = 840 (美国)
vi = 850 (美属维尔京群岛)
bf = 854 (布基纳法索)
uy = 858 (乌拉圭)
uz = 860 (乌兹别克斯坦)
ve = 862 (委内瑞拉)
wf = 876 (瓦利斯和富图纳)
ws = 882 (萨摩亚)
ye = 887 (也门)
zm = 894 (赞比亚)