Product Details
Request Interface
Request Headers
Field Name Field Value Action
+ Add Field
Request Parameters (Params)
Field Name Field Value Action
+ Add Field

* Token can be used in either Request Headers or Request Parameters (Params)

Response Data
{ "status": true, "code": 0, "msg": "获取成功", "data": { "id": 31, "name": "3HK0", "sellCurrency": "USD", "note": "在台湾或香港使用需要先登记", "hasNumber": 1, "needRealname": 0, "highSpeedFlow": 0, "trafficType": 1, "renew": 1, "lifetime": 365, "brandId": 18, "phoneMinutes": 500, "smsCount": 5000, "periodType": "month", "esimStore": 1, "brandInfo": { "id": 18, "brand": "3国际万能卡" }, "trafficTypeInfo": { "id": 1, "symbol": "unlimited_speed", "name": "用完即停", "description": "全速上网", "speedLimitKbps": 0, "isCutOff": 1 }, "regionCode": "HK", "roamingRegionList": [ "MO" ], "memberCategoryList": [ { "id": 12, "member": 1001, "sellPrice": 6.8, "esimStore": 999, "uploadMemberData": { "id": 5, "companyName": "xxx有限公司", } } ], "minPrice": 6.8, "maxPrice": 6.8 } }
Request Field Descriptions
Field Type Description
token string

Access token/signaling used for API authentication

categoryId number

eSIM Type ID

Response Field Descriptions
Field Type Description
status boolean

【Request Status】

true - Success

false - Request Failed

code number

-

msg string

【Request Description】

data object

【Request Data】

id - eSIM Type ID

name - eSIM Name

note - eSIM Description

hasNumber - Has Number

needRealname - Requires Registration

renew - Renewable

highSpeedFlow - High-Speed Data (Unit: Mb)

trafficType - Traffic type

periodType - Data Calculation Cycle: month for monthly, day for daily, total for total amount

lifetime - Validity Period (Unit: Days)

sellCurrency - Currency Type

phoneMinutes - Call Duration (Unit: Minutes)

smsCount - SMS Count

esimStore - Inventory Quantity (9999 means unlimited)

brandInfo - Brand Information

trafficTypeInfo - Data Plan Information

regionCode - SIM Card Origin Code

roamingRegionList - Available Roaming Location Code List

memberCategoryList - Publisher Pricing List

minPrice - Minimum Selling Price

maxPrice - Maximum Selling Price


Country and region codes are 2-character codes defined in the international standard (ISO 3166-1)


【Data Plan Information】

id - Data Plan ID

symbol - Plan Identifier

name - Data Plan Name

description - Data Plan Description

speedLimitKbps - Speed Limit (Unit: Kbps, 0 means unlimited)

isCutOff - Whether to Stop Service Upon Reaching the Limit


【eSIM Brand Information】

id - eSIM Brand ID

brand - eSIM Brand Name


【Publisher Pricing Information (memberCategoryList)】

id - Publisher Pricing ID (pass memberCategoryId when placing an order)

member - Publisher User ID

sellPrice - Price

esimStore - Inventory Quantity (999 means unlimited)

uploadMemberData - Publisher Authentication Information


【Publisher Authentication Information (uploadMemberData)】

companyName - Company Name

Country and region codes (ISO 3166-1)
Code (Alpha-2) Country/Region Name
AD 安道尔 Andorra
AE 阿联酋 United Arab Emirates
AF 阿富汗 Afghanistan
AG 安提瓜和巴布达 Antigua and Barbuda
AI 安圭拉 Anguilla
AL 阿尔巴尼亚 Albania
AM 亚美尼亚 Armenia
AO 安哥拉 Angola
AQ 南极洲 Antarctica
AR 阿根廷 Argentina
AS 美属萨摩亚 American Samoa
AT 奥地利 Austria
AU 澳大利亚 Australia
AW 阿鲁巴 Aruba
AX 奥兰群岛 Aland Islands
AZ 阿塞拜疆 Azerbaijan
BA 波黑 Bosnia and Herzegovina
BB 巴巴多斯 Barbados
BD 孟加拉国 Bangladesh
BE 比利时 Belgium
BF 布基纳法索 Burkina Faso
BG 保加利亚 Bulgaria
BH 巴林 Bahrain
BI 布隆迪 Burundi
BJ 贝宁 Benin
BL 圣巴泰勒米岛 Saint Barthélemy
BM 百慕大 Bermuda
BN 文莱 Brunei
BO 玻利维亚 Bolivia
BR 巴西 Brazil
BS 巴哈马 Bahamas
BT 不丹 Bhutan
BW 博茨瓦纳 Botswana
BY 白俄罗斯 Belarus
BZ 伯利兹 Belize
CA 加拿大 Canada
CC 科科斯群岛 Cocos Islands
CD 刚果(金) Democratic Republic of the Congo
CF 中非 Central African Republic
CG 刚果(布) Republic of the Congo
CH 瑞士 Switzerland
CI 科特迪瓦 Ivory Coast
CK 库克群岛 Cook Islands
CL 智利 Chile
CM 喀麦隆 Cameroon
CN 中国 China
CO 哥伦比亚 Colombia
CR 哥斯达黎加 Costa Rica
CU 古巴 Cuba
CV 佛得角 Cape Verde
CW 库拉索 Curaçao
CX 圣诞岛 Christmas Island
CY 塞浦路斯 Cyprus
CZ 捷克 Czechia
DE 德国 Germany
DJ 吉布提 Djibouti
DK 丹麦 Denmark
DM 多米尼克 Dominica
DO 多米尼加 Dominican Republic
DZ 阿尔及利亚 Algeria
EC 厄瓜多尔 Ecuador
EE 爱沙尼亚 Estonia
EG 埃及 Egypt
EH 西撒哈拉 Western Sahara
ER 厄立特里亚 Eritrea
ES 西班牙 Spain
ET 埃塞俄比亚 Ethiopia
FI 芬兰 Finland
FJ 斐济 Fiji
FK 福克兰群岛 Falkland Islands (Malvinas)
FM 密克罗尼西亚 Micronesia, Federated States of
FO 法罗群岛 Faroe Islands
FR 法国 France
GA 加蓬 Gabon
GB 英国 United Kingdom
GD 格林纳达 Grenada
GE 格鲁吉亚 Georgia
GF 法属圭亚那 French Guiana
GG 根西岛 Guernsey
GH 加纳 Ghana
GI 直布罗陀 Gibraltar
GL 格陵兰 Greenland
GM 冈比亚 Gambia
GN 几内亚 Guinea
GP 瓜德罗普 Guadeloupe
GQ 赤道几内亚 Equatorial Guinea
GR 希腊 Greece
GS 南乔治亚 South Georgia and the South Sandwich Islands
GT 危地马拉 Guatemala
GU 关岛 Guam
GW 几内亚比绍 Guinea-Bissau
GY 圭亚那 Guyana
HK 中国香港 Hong Kong
HN 洪都拉斯 Honduras
HR 克罗地亚 Croatia
HT 海地 Haiti
HU 匈牙利 Hungary
ID 印度尼西亚 Indonesia
IE 爱尔兰 Ireland
IL 以色列 Israel
IM 马恩岛 Isle of Man
IN 印度 India
IQ 伊拉克 Iraq
IR 伊朗 Iran
IS 冰岛 Iceland
IT 意大利 Italy
JE 泽西岛 Jersey
JM 牙买加 Jamaica
JO 约旦 Jordan
JP 日本 Japan
KE 肯尼亚 Kenya
KG 吉尔吉斯斯坦 Kyrgyzstan
KH 柬埔寨 Cambodia
KI 基里巴斯 Kiribati
KM 科摩罗 Comoros
KN 圣基茨和尼维斯 Saint Kitts and Nevis
KP 朝鲜 North Korea
KR 韩国 South Korea
KW 科威特 Kuwait
KY 开曼群岛 Cayman Islands
KZ 哈萨克斯坦 Kazakhstan
LA 老挝 Lao
LB 黎巴嫩 Lebanon
LC 圣卢西亚 Saint Lucia
LI 列支敦士登 Liechtenstein
LK 斯里兰卡 Sri Lanka
LR 利比里亚 Liberia
LS 莱索托 Lesotho
LT 立陶宛 Lithuania
LU 卢森堡 Luxembourg
LV 拉脱维亚 Latvia
LY 利比亚 Libya
MA 摩洛哥 Morocco
MC 摩纳哥 Monaco
MD 摩尔多瓦 Moldova
ME 黑山 Montenegro
MF 法属圣马丁 Saint Martin (French part)
MG 马达加斯加 Madagascar
MH 马绍尔群岛 Marshall Islands
MK 北马其顿 North Macedonia
ML 马里 Mali
MM 缅甸 Myanmar
MN 蒙古 Mongolia
MO 中国澳门 Macao
MP 北马里亚纳群岛 Northern Mariana Islands
MQ 马提尼克 Martinique
MR 毛里塔尼亚 Mauritania
MS 蒙特塞拉特 Montserrat
MT 马耳他 Malta
MU 毛里求斯 Mauritius
MV 马尔代夫 Maldives
MW 马拉维 Malawi
MX 墨西哥 Mexico
MY 马来西亚 Malaysia
MZ 莫桑比克 Mozambique
NA 纳米比亚 Namibia
NC 新喀里多尼亚 New Caledonia
NE 尼日尔 Niger
NF 诺福克岛 Norfolk Island
NG 尼日利亚 Nigeria
NI 尼加拉瓜 Nicaragua
NL 荷兰 Netherlands
NO 挪威 Norway
NP 尼泊尔 Nepal
NR 瑙鲁 Nauru
NU 纽埃 Niue
NZ 新西兰 New Zealand
OM 阿曼 Oman
PA 巴拿马 Panama
PE 秘鲁 Peru
PF 法属波利尼西亚 French Polynesia
PG 巴布亚新几内亚 Papua New Guinea
PH 菲律宾 Philippines
PK 巴基斯坦 Pakistan
PL 波兰 Poland
PM 圣皮埃尔和密克隆 Saint Pierre and Miquelon
PN 皮特凯恩群岛 Pitcairn
PR 波多黎各 Puerto Rico
PS 巴勒斯坦 Palestine
PT 葡萄牙 Portugal
PW 帕劳 Palau
PY 巴拉圭 Paraguay
QA 卡塔尔 Qatar
RE 留尼汪 Reunion
RO 罗马尼亚 Romania
RS 塞尔维亚 Serbia
RU 俄罗斯 Russia
RW 卢旺达 Rwanda
SA 沙特阿拉伯 Saudi Arabia
SB 所罗门群岛 Solomon Islands
SC 塞舌尔 Seychelles
SD 苏丹 Sudan
SE 瑞典 Sweden
SG 新加坡 Singapore
SH 圣赫勒拿 Saint Helena
SI 斯洛文尼亚 Slovenia
SJ 斯瓦尔巴和扬马延 Svalbard and Jan Mayen
SK 斯洛伐克 Slovakia
SL 塞拉利昂 Sierra Leone
SM 圣马力诺 San Marino
SN 塞内加尔 Senegal
SO 索马里 Somalia
SR 苏里南 Suriname
SS 南苏丹 South Sudan
ST 圣多美和普林西比 Sao Tome and Principe
SV 萨尔瓦多 El Salvador
SX 荷属圣马丁 Sint Maarten (Dutch part)
SY 叙利亚 Syrian
SZ 斯威士兰 Eswatini
TC 特克斯和凯科斯群岛 Turks and Caicos Islands
TD 乍得 Chad
TF 法属南部领地 French Southern Territories
TG 多哥 Togo
TH 泰国 Thailand
TJ 塔吉克斯坦 Tajikistan
TK 托克劳 Tokelau
TL 东帝汶 Timor-Leste
TM 土库曼斯坦 Turkmenistan
TN 突尼斯 Tunisia
TO 汤加 Tonga
TR 土耳其 Turkey
TT 特立尼达和多巴哥 Trinidad and Tobago
TV 图瓦卢 Tuvalu
TW 中国台湾 Taiwan
TZ 坦桑尼亚 Tanzania
UA 乌克兰 Ukraine
UG 乌干达 Uganda
UM 美属本土外小岛屿 United States Minor Outlying Islands
US 美国 United States
UY 乌拉圭 Uruguay
UZ 乌兹别克斯坦 Uzbekistan
VA 梵蒂冈 Vatican
VC 圣文森特和格林纳丁斯 Saint Vincent and the Grenadines
VE 委内瑞拉 Venezuela
VG 英属维尔京群岛 Virgin Islands, British
VI 美属维尔京群岛 Virgin Islands, U.S.
VN 越南 Vietnam
VU 瓦努阿图 Vanuatu
WF 瓦利斯和富图纳 Wallis and Futuna
WS 萨摩亚 Samoa
YE 也门 Yemen
YT 马约特 Mayotte
ZA 南非 South Africa
ZM 赞比亚 Zambia
ZW 津巴布韦 Zimbabwe