EIOTCLUB Apifox Export for Claude
This export is optimized for code generation. It preserves the Apifox-native Markdown pages, including the OpenAPI YAML blocks, request parameters, response schemas, and examples.
- Source index: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/llms.txt
- Focus:
eiotclub sim/ EIOTCLUB flow-card related docs - Passwords and secret values are not written into this export.
Quick Index
Docs Pages
接口描述
接口描述
开放平台的 URL由baseURL和方法路径（/api/v3/xxx/xxx）两部分组成，其中baseURL为 https://oapi.eiotclub.com ； 开放平台的所有服务 URL的请求参数分为系统级参数和业务级参数两部分，系统级参数是所有服务API都拥有的参数，而业务级参数由具体服务 API定义。 系统参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| appkey | String | 是 | appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取 appkey/secret 后，才能进行应用的开发。 |
| timestamp | Long | 是 | 当前时间戳，10位数字 |
接口描述
开放平台的 URL由baseURL和方法路径（/api/v3/xxx/xxx）两部分组成，其中baseURL为 https://oapi.eiotclub.com ； 开放平台的所有服务 URL的请求参数分为系统级参数和业务级参数两部分，系统级参数是所有服务API都拥有的参数，而业务级参数由具体服务 API定义。
系统参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| appkey | String | 是 | appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取 appkey/secret 后，才能进行应用的开发。 |
| timestamp | Long | 是 | 当前时间戳，10位数字 |
| nonce | Integer | 是 | 5位随机正整数 |
| sign | String | 是 | 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。 |
签名(sign)算法
签名(sign)算法
签名(sign)算法描述如下：
- 1、按照请求参数名ASCII码升序排列非空请求参数（字典序）,使用URL键值对的格式,（即key1=value1&key2=value2…）拼接成字符串
StringParm； - 2、在
StringParm最后拼接上secret得到字符串StringParmSign； - 3、再对
StringPaemSign进行sha1运算，并将得到的字符串所有的字符转换为大写，得到最终sign； - 4、该签名值使用sign系统级参数一起和其它请求参数一起发送给服务开放平台。 注意：接收回调通知的签名计算不需要加入appkey，仅API调用需要 假如这些业务级参数和系统级参数的值如下表所示：
签名(sign)算法
签名(sign)算法描述如下：
- 1、按照请求参数名ASCII码升序排列非空请求参数（字典序）,使用URL键值对的格式,（即key1=value1&key2=value2…）拼接成字符串
StringParm； - 2、在
StringParm最后拼接上secret得到字符串StringParmSign； - 3、再对
StringPaemSign进行sha1运算，并将得到的字符串所有的字符转换为大写，得到最终sign； - 4、该签名值使用sign系统级参数一起和其它请求参数一起发送给服务开放平台。
注意：接收回调通知的签名计算不需要加入appkey，仅API调用需要
假如这些业务级参数和系统级参数的值如下表所示：
| 系统级参数名称 | 参数值 | 业务级参数名称 | 参数值 |
|---|---|---|---|
| appkey | 000001 | userName | wx |
| timestamp | 1556595508 | age | 24 |
| nonce | 24523 | sex | 1 |
根据签名算法，首先按参数名称ASCII码升序将所有参数名和参数值拼装成一个字符串：
age=24&appkey=000001&nonce=24523&sex=1×tamp=1556595508&username=wx
假设，appkey为 000001的secret（应用密钥）是 "a1b1c1d1"，则将"a1b1c1d1" 将参数添加到以上请求参数的最后，得到：
age=24&appkey=000001&nonce=24523&sex=1×tamp=1556595508&userName=wx&secret=a1b1c1d1
注意secret不参与排序，不需要在接口调用中传入，只参与签名使用
对以上字符口串进行sha1签名运算，并且将字符串字符转换为大写，得到：
963A56BAEBED746F2746E4D9B3B77BE0F2E171E7
最后，客户端的可对每个业务的URL地址（格式如：baseURL/api/v1/xxx/xxx），以POST请求方式使用如下的报文（JSON格式）对服务方法发起请求：
POST baseURL/api/具体接口地址(不要拼接参数) HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"appkey": "000001",
"timestamp": 1556595508,
"nonce": 24523,
"sign": "963A56BAEBED746F2746E4D9B3B77BE0F2E171E7",
"userName": "wx",
"age": "24",
"sex": "1"
}
Java生成签名代码示例：
// JAVA生成签名代码示例
private static String generateSign(Map<String, Object> paramMap, String secret) {
List<String> list = new ArrayList<>(20);
for (Map.Entry<String, Object> entry : paramMap.entrySet()) {
list.add(entry.getKey() + "=" + entry.getValue() + "&");
}
Collections.sort(list);
String signParam = String.join("", list);
String param = signParam + "secret=" + secret;
return DigestUtils.sha1Hex(param).toUpperCase();
}
错误代码
错误代码
错误码
| Error Code | 中文含义 | 英文含义 |
|---|---|---|
| 200 | 成功 | Success |
| 403 | 您没有权限访问 | You don't have permission to access. |
| 500 | 操作失败,请稍后再试 | Operation failed, try again later. |
| 501 | 请求太频繁 | Too many requests. |
错误代码
错误码
| Error Code | 中文含义 | 英文含义 |
|---|---|---|
| 200 | 成功 | Success |
| 403 | 您没有权限访问 | You don't have permission to access. |
| 500 | 操作失败,请稍后再试 | Operation failed, try again later. |
| 501 | 请求太频繁 | Too many requests. |
| 502 | IP白名单错误 | IP whitelist error. |
| 41001 | iccids参数错误 | Invalid iccids parameter. |
| 41002 | iccid格式不正确 | Invalid iccid format. |
| 41003 | iccid为空,或者iccid格式错误 | Iccid is empty or format is wrong. |
| 41013 | imsi为空,或者imsi格式错误 | Imsi is empty or format is wrong. |
| 41014 | network为空,或者network错误 | Network param is empty or wrong. |
| 41015 | imei为空,或者imei格式错误 | Imei is empty or format is wrong. |
| 41040 | email为空,或者email格式错误 | Email is empty or format is wrong. |
| 41041 | url为空,或者url格式错误 | Url is empty or format is wrong. |
| 41004 | startDate参数错误 | Invalid startDate parameter. |
| 41005 | endDate参数错误 | Invalid endDate parameter. |
| 41006 | 日期参数错误 | Invalid date parameter. |
| 41007 | 批量卡号超过限制 | Batch card numbers exceed limit. |
| 41008 | 卡号与运营商不匹配 | Card number doesn't match operator. |
| 41050 | 订购的套餐产品属性与卡不一致 | Package product attributes don't match card. |
| 41009 | startYearMonth参数错误 | Invalid startYearMonth parameter. |
| 41010 | endYearMonth参数错误 | Invalid endYearMonth parameter. |
| 41011 | phone为空 | Phone number is empty. |
| 41012 | code为空 | Code is empty. |
| 41018 | 订购套餐编码错误 | Invalid package code for order. |
| 41028 | 该卡无此套餐 | Card has no such package. |
| 41029 | 套餐生效类型参数错误 | Invalid package activation type param. |
| 41030 | 验证sign时,用户名不存在,请联系接入方技术人员 | Username not found when verifying sign, contact tech support. |
| 41031 | 您不存在该套餐 | You don't have this package. |
| 41032 | 该运营商暂不支持 | This operator is not supported currently. |
| 41033 | 请实名后再试 | Please complete real - name verification first. |
| 41034 | 通讯录已存在该号码 | Phone number already exists in address book. |
| 41035 | 已通过API配置达到10个，请前往公众号配置 | Reached API config limit of 10, configure in official account. |
| 41036 | 下单异常 | Ordering is abnormal. |
| 41037 | 该卡未订购月套餐 | Card has no monthly package. |
| 41103 | 激活失败 | Activation failed. |
| 41102 | 操作类型错误，1为激活，2为停用 | Invalid operation type (1: activate, 2: deactivate). |
| 41104 | 停用失败 | Deactivation failed. |
| 41019 | 套餐生效类型为空或异常 | Package activation type is empty or abnormal. |
| 41020 | 运营商类型operator为空或者operator异常 | Operator type param is empty or abnormal. |
| 42022 | 套餐id不能为空 | Package ID cannot be empty. |
| 42401 | 签名串为空 | Signature string is empty. |
| 42402 | 签名串无效，请确保加密方式正确 | Invalid signature, check encryption method. |
| 42403 | pageNum为空或者格式错误 | PageNum is empty or format is wrong. |
| 42407 | pageSize值异常 | Invalid pageSize value. |
| 42404 | 卡池编号错误 | Invalid card pool number. |
| 42405 | 当前帐户无此 iccid 卡号 | Account has no such iccid card. |
| 42408 | 当前帐户无此IMEI池 | Account has no such IMEI pool. |
| 42406 | 用户无可用套餐 iccid 卡号 | User has no available packages for iccid. |
| 42409 | 时间格式异常 | Invalid time format. |
| 41998 | API信息归属客户异常,请联系接入方技术人员 | API customer info is abnormal, contact tech support. |
| 42000 | 短信内容为空或者超出最大内容限制 | SMS content is empty or exceeds limit. |
| 42001 | outTradeNo为空或者格式不正确,最大支持32位 | outTradeNo is empty or format is wrong (max 32 digits). |
| 42002 | outTradeNo已存在 | outTradeNo already exists. |
| 42003 | orderId为空或者格式不正确 | OrderId is empty or format is wrong. |
| 42004 | 订单不存在 | Order does not exist. |
| 42005 | 该支付方式不支持操作 | This payment method is not supported. |
| 42006 | 订单状态异常 | Order status is abnormal. |
| 42007 | 套餐不存在 | Package does not exist. |
| 42008 | 套餐状态不可退款 | Package status does not allow refund. |
| 42009 | 最大支持查询50张 | Max 50 items can be queried. |
| 42101 | appkey为空 | Appkey is empty. |
| 42102 | appkey不存在 | Appkey does not exist. |
| 42104 | ip:未授权,请配置正确的ip白名单 | ip: is not authorized, configure ip whitelist. |
| 42201 | 时间戳为空 | Timestamp is empty. |
| 42203 | 时间戳时间不准确 | Timestamp is inaccurate. |
| 42204 | 时间格式异常 | Invalid time format. |
| 42301 | nonce为空 | Nonce is empty. |
| 43331 | 服务器异常 | Server exception. |
| 43332 | 参数错误 | Parameter error. |
| 43333 | 缺少错误提示 | Missing error hint. |
| 44001 | 操作频繁,五分钟只能刷新一次 | Operation too frequent, refresh once every 5 mins. |
| 44002 | 刷新失败 | Refresh failed. |
| 503016 | 重复订单号 | Duplicate order number. |
| 50001 | package配置异常 | Package configuration is abnormal. |
| 900910 | 无操作权限 | No operation permission. |
| 900911 | 卡片不存在 | Card not found. |
| 45101 | 短信参数有误 | Invalid SMS parameters. |
| 45102 | 卡片解锁频繁 | Too frequent card unlocking. |
| 45103 | 卡片解锁超过限制次数 | Exceeded card unlocking limit. |
| 45104 | 卡片无需解锁 | Card doesn't need unlocking. |
| 45105 | 卡片状态无法切换网络 | Card status doesn't allow network switching. |
| 45106 | remark不允许为空 | Remark cannot be empty. |
| 45107 | 不支持切换到当前网络 | Switching to this network is not supported. |
| 45108 | card product not found | Card product not found. |
| 45109 | eSIM product not found | eSIM product not found. |
| 45110 | eSIM out of stock | eSIM out of stock. |
| 45111 | eSIM order not found | eSIM order not found. |
| 45112 | balance insufficient | Insufficient balance. |
| 45113 | not allow to refund at current status | Refund not allowed at current status. |
API Pages
CDR话单FTP对接
CDR话单FTP对接
1.如何接入
- 接入CDR话单前请先联系您的售前确认。
- 需准备ftp服务器，配置清单如下： IP：例如52.167.144.21 端口：例如20021 用户名：例如EIOTCLUB（要有读写权限） 密码：例如ef42gj67 接受话单的根文件目录：例如/upload 您方技术对接负责人邮箱：例如xxx.email.com
2.如何推送
接入成功之后，我们将于每30分钟定时推送前一小时的CDR文件到指定服务器的目录下，效果如下图：
3.如何解析CDR文件
CDR文件是csv格式，文件名组成：cdr+账户ID+CDR开始时间+CDR结束时间+生成文件时间
`例如：cdr_10001_20260115000000_20260115010000_20260115013000.csv文件
10001：账户ID, 20260115000000_20260115010000：CDR起止时间（一般只需要用到这两个时间） 20260115013000：文件生成时间
这个文件表示是于2026-01-15 01:30：00推送2026-01-15 00:00：00至2026-01-15 01:00：00区间结束的CDR数据`
csv文件共有8列,字段含义及顺序如下：
| id |int64| 唯一key | start_time |string | 话单开始时间，UTC时间格式yyyy-MM-dd HH:mm:ss | stop_time |string| 话单结束时间，UTC时间格式yyyy-MM-dd HH:mm:ss | iccid |string| 卡的iccid | imsi |string| 卡的imsi | data_usage |int64| 这段时间内的用量,单位是Byte | imei |string| 卡的imei | mccmnc |string| 卡的mccmnc，前2位mcc,后3位mcc
查询账户下所有卡片接口
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600562e0.md
- Summary: 查询账户下所有卡片、获取账号内全部卡片，每页500条数据
查询账户下所有卡片接口
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/getAllCardInfo:
post:
summary: 查询账户下所有卡片接口
deprecated: false
description: 查询账户下所有卡片、获取账号内全部卡片，每页500条数据
tags:
- API接口/卡业务接口
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
pageNum:
type: string
default: ''
enum:
- '1'
description: 分页页数，从1开始
x-apifox-enum:
- name: ''
value: '1'
description: ''
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
pageSize:
type: integer
default: 500
description: 默认为500
cardStatus:
type: string
description: >-
卡片状态
ACTIVATION_READY_NAME 可激活 NON_ACTIVATED_NAME 待激活
ACTIVATED_NAME 已激活 DEACTIVATED_NAME 已停用 RETIRED_NAME 已失效
x-apifox-mock: NON_ACTIVATED_NAME
iccids:
type: string
description: iccid卡号，用，隔开
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- pageNum
- pageSize
- cardStatus
- iccids
required:
- pageNum
- appkey
- timestamp
- nonce
- sign
example: |-
{
"pageNum": "1",
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 49890,
"sign": "{{SIGN}}",
"pageSize": 78
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
cardInfoList:
type: array
items:
type: object
properties:
iccid:
type: string
title: iccid卡号
productCode:
type: string
title: 卡片归属产品编码
imsi:
type: string
title: 业务号
cardStatus:
type: string
description: >-
ACTIVATION_READY_NAME 可激活 NON_ACTIVATED_NAME 待激活
ACTIVATED_NAME 已激活 DEACTIVATED_NAME 已停用
ACTIVATED_BASE 套餐停用卡仍可使用
orderId:
type: integer
title: 当前套餐对应的订单ID
isIMEIPool:
type: integer
title: 是否归属池 0 卡未归属池 1 卡归属池 2 卡临时归属池
description: 是否归属池 0 卡未归属池 1 卡归属池 2 卡临时归属池
flowTotal:
type: number
title: 当前套餐流量
format: float64
flowRemain:
type: number
title: 当前套餐剩余流量
format: float64
packageType:
type: integer
title: 套餐类型
description: 套餐类型：2 限量流量包 3 限时流量包 4 限时限速包
packageName:
type: string
title: 套餐名称
packageCode:
type: string
title: 套餐code码
gzhPackageName:
type: string
title: 商品套餐名称
activateDate:
type: string
title: 第一次激活时间
imei:
type: string
description: IMEI
title: IMEI
network:
type: string
title: 当前网络，同“切换卡片的运营商”接口network字段
description: 当前网络，同“切换卡片的运营商”接口network字段
isRealName:
type: integer
description: 是否实名 0:未实名 1:已实名
monthRemainFlow:
type: number
format: float64
description: 当前套餐剩余可用流量，单位MB
monthUseFlow:
type: number
format: float64
description: 当前套餐已用流量，单位MB
remainFlowType:
type: number
format: float64
description: 剩余流量类型 0 套餐套餐类型：2 限量流量包 3 限时流量包 4 限时限速包流量 1池剩余流量
packageEndDate:
type: string
description: 当前套餐到期时间
dataFlow:
type: number
description: 卡片总流量（包括未使用套餐），单位MB
format: float64
remainFlow:
type: number
format: float64
description: 卡片总剩余可用流量（包括未使用套餐），单位MB
expectedEndDate:
type: string
description: 卡片预计到期时间（包括未使用套餐的有效期）
imeiPoolStatus:
type: integer
description: 'IMEI池锁状态 0 没有锁住 1 锁住暂停卡 '
imeiPoolUnlockCount:
type: integer
description: IMEI池已解锁次数
totalUseFlow:
type: number
description: 卡片已使用总流量（包括已达量的套餐及当前套餐的用量） - 暂时不精准
format: float64
packageKind:
type: integer
description: 套餐类型 0-限量套餐 1-限时套餐 2-限时限速套餐
required:
- iccid
- imsi
- productCode
- packageType
- flowTotal
- isIMEIPool
- orderId
- cardStatus
- flowRemain
- packageName
- packageCode
- gzhPackageName
- activateDate
- imei
- network
- isRealName
- monthRemainFlow
- monthUseFlow
- remainFlowType
- dataFlow
- remainFlow
- expectedEndDate
- imeiPoolStatus
- imeiPoolUnlockCount
- totalUseFlow
- packageKind
x-apifox-orders:
- iccid
- imsi
- activateDate
- cardStatus
- isRealName
- monthRemainFlow
- monthUseFlow
- remainFlowType
- productCode
- packageEndDate
- dataFlow
- remainFlow
- expectedEndDate
- imeiPoolStatus
- imeiPoolUnlockCount
- isIMEIPool
- network
- totalUseFlow
- packageCode
- packageKind
- orderId
- flowTotal
- flowRemain
- packageType
- packageName
- gzhPackageName
- imei
description: 卡信息详情列表集合
totalPage:
type: integer
description: 总页数
required:
- cardInfoList
- totalPage
x-apifox-orders:
- cardInfoList
- totalPage
description: |
返回数据
title: ''
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '9'
message: dolore
data:
cardInfoList:
- iccid: '6'
imsi: esse aute Ut cillum
activateDate: '2025-02-25'
cardStatus: 旅行车
isRealName: 54
monthRemainFlow: 73
monthUseFlow: 98
remainFlowType: 97
productCode: '77'
packageEndDate: '2025-06-04'
dataFlow: 22
remainFlow: 58
expectedEndDate: '2026-01-20'
imeiPoolStatus: 30
imeiPoolUnlockCount: 40
isIMEIPool: 85
network: consectetur et in amet
totalUseFlow: 1
packageCode: '84'
packageKind: 47
orderId: 70
flowTotal: 34
flowRemain: 41
packageType: sunt aliquip non adipisicing
packageName: 崔文昊
gzhPackageName: 戚智杰
imei: 43-430820-600842-0
- iccid: '41'
imsi: culpa
activateDate: '2025-04-09'
cardStatus: 轿车
isRealName: 47
monthRemainFlow: 52
monthUseFlow: 5
remainFlowType: 62
productCode: '18'
packageEndDate: '2026-03-22'
dataFlow: 10
remainFlow: 98
expectedEndDate: '2024-08-30'
imeiPoolStatus: 21
imeiPoolUnlockCount: 78
isIMEIPool: 80
network: in
totalUseFlow: 54
packageCode: '43'
packageKind: 14
orderId: 87
flowTotal: 19
flowRemain: 32
packageType: eu adipisicing non aliquip
packageName: 源鹏
gzhPackageName: 纵沐宸
imei: 16-679210-604958-0
- iccid: '9'
imsi: magna laborum
activateDate: '2025-01-07'
cardStatus: 旅行车
isRealName: 39
monthRemainFlow: 41
monthUseFlow: 94
remainFlowType: 41
productCode: '41'
packageEndDate: '2025-07-08'
dataFlow: 24
remainFlow: 99
expectedEndDate: '2025-06-05'
imeiPoolStatus: 80
imeiPoolUnlockCount: 89
isIMEIPool: 45
network: ad ea culpa laboris
totalUseFlow: 51
packageCode: '38'
packageKind: 74
orderId: 59
flowTotal: 18
flowRemain: 49
packageType: consectetur nostrud tempor pariatur
packageName: 以浩宇
gzhPackageName: 阮国平
imei: 43-787443-773714-2
totalPage: 54
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600562-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
单卡信息查询
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600559e0.md
- Summary: 根据卡号，获取单卡信息及流量使用信息
单卡信息查询
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/getCardsInfo:
post:
summary: 单卡信息查询
deprecated: false
description: 根据卡号，获取单卡信息及流量使用信息
tags:
- API接口/卡业务接口
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- iccid
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 67958
sign: '{{SIGN}}'
iccid: '89000123456789013802'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
iccid:
type: string
description: iccid卡号
imsi:
type: string
description: IMSI号
activateDate:
type: string
description: 卡片激活时间
cardStatus:
type: string
description: >-
ACTIVATION_READY_NAME 可激活 NON_ACTIVATED_NAME 待激活
ACTIVATED_NAME 已激活 DEACTIVATED_NAME 已停用
isRealName:
type: integer
description: 是否实名 0:未实名 1:已实名
monthRemainFlow:
type: number
description: 当前套餐剩余可用流量，单位MB
format: float64
monthUseFlow:
type: number
description: 当前套餐已用流量，单位MB
format: float64
remainFlowType:
type: number
description: 剩余流量类型 0 套餐流量 1池剩余流量
format: float64
productCode:
type: string
description: 产品编码
packageEndDate:
type: string
description: 当前套餐到期时间
dataFlow:
type: number
description: 卡片总流量（包括未使用套餐），单位MB
format: float64
remainFlow:
type: number
description: 卡片总剩余可用流量（包括未使用套餐），单位MB
format: float64
expectedEndDate:
type: string
description: 卡片预计到期时间（包括未使用套餐的有效期）
imeiPoolStatus:
type: integer
description: 'IMEI池锁状态 0 没有锁住 1 锁住暂停卡 '
imeiPoolUnlockCount:
type: integer
description: IMEI池已解锁次数
isIMEIPool:
type: integer
description: 是否归属池 0 卡未归属池 1 卡归属池 2 卡临时归属池
network:
type: string
description: 当前网络，同“切换卡片的运营商”接口network字段
totalUseFlow:
type: number
description: 卡片已使用总流量（包括已达量的套餐及当前套餐的用量） - 暂时不精准
format: float64
packageCode:
type: string
description: 卡片当前使用的系统套餐简码
packageKind:
type: integer
description: 套餐类型 0-限量套餐 1-限时套餐 2-限时限速套餐
eid:
type: string
description: eSIM 卡号
remark:
type: string
description: 当前客户的备注
description: 返回数据
x-apifox-orders:
- iccid
- eid
- imsi
- activateDate
- cardStatus
- isRealName
- monthRemainFlow
- monthUseFlow
- remainFlowType
- productCode
- packageEndDate
- dataFlow
- remainFlow
- expectedEndDate
- imeiPoolStatus
- imeiPoolUnlockCount
- isIMEIPool
- network
- totalUseFlow
- packageCode
- packageKind
- remark
required:
- iccid
- imsi
- activateDate
- cardStatus
- isRealName
- monthRemainFlow
- monthUseFlow
- remainFlowType
- productCode
- dataFlow
- remainFlow
- expectedEndDate
- imeiPoolStatus
- imeiPoolUnlockCount
- isIMEIPool
- network
- totalUseFlow
- packageCode
- packageKind
- eid
- remark
nullable: true
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600559-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询卡片套餐订购记录
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600563e0.md
- Summary: 根据卡号，获取该卡片的套餐订购记录
查询卡片套餐订购记录
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/packageOrderRecord:
post:
summary: 查询卡片套餐订购记录
deprecated: false
description: |+
根据卡号，获取该卡片的套餐订购记录
tags:
- API接口/卡业务接口
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
state:
type: integer
description: |-
套餐使用状态 0:待使用 1:使用中 2:已完成
0 待使用：后续会生效的套餐；
1 使用中：目前在用的套餐；
2 已完成：已完成的套餐包括退款、用完等情况；
createDateStart:
type: string
description: 订购开始时间
createDateEnd:
type: string
description: 订购结束时间
orderIdArrStr:
type: string
description: 订单 id组字符串。例如 10004996,10004200
page:
type: integer
description: 页码。从1开始
pageSize:
type: integer
description: 页大小
updateDateStart:
type: string
description: 数据更新开始时间
updateDateEnd:
type: string
description: 数据更新结束时间
orderBy:
type: string
description: '为空的情况默认是按创建时间升序，支持的枚举有: createDateDesc按创建时间倒序'
stateArrStr:
type: string
description: 套餐使用状态字符串。例如 0,1
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
- state
- createDateStart
- createDateEnd
- updateDateStart
- updateDateEnd
- orderIdArrStr
- page
- pageSize
- orderBy
- stateArrStr
required:
- appkey
- timestamp
- nonce
- sign
- iccid
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
iccid: '8988308650104486856'
state: 2
createDateStart: '2024-07-15 16:28:06'
createDateEnd: '2025-03-03 18:42:59'
updateDateStart: '2025-02-10 20:23:30'
updateDateEnd: '2025-02-10 20:23:38'
orderIdArrStr: 10004996,10004997
page: 1
pageSize: 2
stateArrStr: 0,1
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: array
items:
type: object
properties:
packageName:
type: string
description: 套餐名称
iccid:
type: string
description: 卡号
state:
type: integer
description: |-
套餐使用状态 0:待使用 1:使用中 2:已完成
0 待使用：后续会生效的套餐；
1 使用中：目前在用的套餐；
2 已完成：已完成的套餐包括退款、用完等情况；
price:
type: number
description: 订购价格
format: float64
createDate:
type: string
description: 订购时间
startDate:
type: string
description: 套餐开始时间
endDate:
type: string
description: |
套餐结束时间
flowTotal:
type: number
description: 套餐总流量
format: float64
gzhPackageName:
type: string
description: 商品套餐名称
totalActive:
type: integer
description: 有效时长, 以periodType的值为单位
currency:
type: string
description: 币种
orderId:
type: integer
description: 套餐订单号
packageCode:
type: string
description: 套餐编码
renew:
type: integer
description: 0 正常订单 1续订订单
packageType:
type: integer
description: 套餐类型：2 限量流量包 3 限时流量包 4 限时限速包
isRefund:
type: integer
description: 是否退订 0 未退订 1 已退订
periodType:
type: integer
description: 有效期类型 1:月 2:天
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
updateDate:
type: string
description: 数据更新时间
flowRemain:
type: number
format: float64
description: 套餐剩余量
flowUsageBytes:
type: integer
description: 套餐用量, 单位Bytes
required:
- packageName
- iccid
- state
- price
- createDate
- startDate
- endDate
- flowTotal
- gzhPackageName
- totalActive
- currency
- orderId
- packageCode
- renew
- packageType
- isRefund
- periodType
- updateDate
- flowRemain
- flowUsageBytes
x-apifox-orders:
- orderId
- packageName
- packageCode
- iccid
- state
- price
- currency
- createDate
- updateDate
- startDate
- endDate
- flowTotal
- flowRemain
- flowUsageBytes
- gzhPackageName
- totalActive
- renew
- packageType
- isRefund
- periodType
- outTradeNo
total:
type: integer
description: 总数
required:
- code
- message
- data
- total
x-apifox-orders:
- code
- message
- total
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600563-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询卡片可订购套餐信息
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600561e0.md
- Summary: 查询卡片可订购的套餐信息
查询卡片可订购套餐信息
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/listOrderPackageByIccid:
post:
summary: 查询卡片可订购套餐信息
deprecated: false
description: |+
查询卡片可订购的套餐信息
tags:
- API接口/卡业务接口
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- iccid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {
{TIMESTAMP
}
},
"nonce": 99613,
"sign": "{{SIGN}}",
"iccid": "5111111111119"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: array
items:
type: object
properties:
operator:
type: integer
description: 运营商 5：国际
packageCode:
type: string
description: 系统套餐编码
packageName:
type: string
description: 系统套餐名称
productCode:
type: string
description: 套餐归属产品编码
price:
type: number
description: 客户套餐底价
format: float64
packageType:
type: integer
description: 套餐类型：2 限量流量包 3 限时流量包 4 限时限速包
gzhPrice:
type: number
description: 商品套餐价格
format: float64
gzhPackageName:
type: string
description: 商品套餐名称
gzhStatus:
type: integer
description: 商品套餐状态：0未上架 1已上架
flowSize:
type: number
description: 流量大小 单位M
format: float64
periodSize:
type: integer
description: 有效期大小
periodType:
type: integer
description: 有效期类型 1:月 2:天
required:
- operator
- packageCode
- packageName
- productCode
- price
- packageType
- gzhPrice
- gzhPackageName
- gzhStatus
- flowSize
- periodSize
- periodType
x-apifox-orders:
- operator
- packageCode
- packageName
- productCode
- price
- packageType
- gzhPrice
- gzhPackageName
- gzhStatus
- flowSize
- periodSize
- periodType
required:
- code
- message
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 操作成功
data:
- operator: 5
packageCode: GJ-LLB-2G-30-1US-11111111407170352
packageName: 国际-流量包-2G-30天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 97.5
gzhPackageName: 2GB 30day
gzhStatus: 1
flowSize: 2048
periodSize: 30
periodType: 2
- operator: 5
packageCode: GJ-LLB-100M-30-1US-11111111407170352
packageName: 国际-流量包-100M-30天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 13
gzhPackageName: 100MB 30day
gzhStatus: 0
flowSize: 100
periodSize: 30
periodType: 2
- operator: 5
packageCode: GJ-LLB-12G-180-1US-11111111407170352
packageName: 国际-流量包-12G-180天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 519.35
gzhPackageName: 12GB 180day
gzhStatus: 1
flowSize: 12288
periodSize: 180
periodType: 2
- operator: 5
packageCode: GJ-LLB-24G-360-1US-11111111407170352
packageName: 国际-流量包-24G-360天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 844.35
gzhPackageName: 24GB 360day
gzhStatus: 1
flowSize: 24576
periodSize: 360
periodType: 2
- operator: 5
packageCode: GJ-LLB-3.5G-360-1US-11111111407170352
packageName: 国际-流量包-3.5G-360天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 468
gzhPackageName: Trail camera 360day
gzhStatus: 1
flowSize: 3584
periodSize: 360
periodType: 2
- operator: 5
packageCode: GJ-LLB-1.8G-360-1US-11111111407170352
packageName: 国际-流量包-1.8G-360天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 234
gzhPackageName: Trail camera 180day
gzhStatus: 0
flowSize: 1843
periodSize: 360
periodType: 2
- operator: 5
packageCode: GJ-LLB-360M-360-1US-11111111407170352
packageName: 国际-流量包-360M-360天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 162.5
gzhPackageName: 360MB 360day
gzhStatus: 1
flowSize: 360
periodSize: 360
periodType: 2
- operator: 5
packageCode: GJ-LLB-7G-360-1US-11111111407170352
packageName: 国际-流量包-7G-360天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 624
gzhPackageName: Trail camera 360day Unlimited
gzhStatus: 1
flowSize: 7168
periodSize: 360
periodType: 2
- operator: 5
packageCode: GJ-LLB-12G-360-1US-11111111407170352
packageName: 国际-流量包-12G-360天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 650
gzhPackageName: 12GB 360day
gzhStatus: 0
flowSize: 12288
periodSize: 360
periodType: 2
- operator: 5
packageCode: GJ-LLB-1.8G-180-1US-11111111407170352
packageName: 国际-流量包-1.8G-180天
productCode: 1US-11111111407170352
price: 0
packageType: 2
gzhPrice: 234
gzhPackageName: Trail camera 180day
gzhStatus: 1
flowSize: 1843
periodSize: 180
periodType: 2
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600561-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
单卡刷新（已弃用）
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600564e0.md
- Summary: 根据卡号，刷新卡片信息
单卡刷新（已弃用）
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/refreshCard:
post:
summary: 单卡刷新（已弃用）
deprecated: false
description: >-
根据卡号，刷新卡片信息
2025/10/22 后弃用该接口。如果需要刷新卡片套餐用量，请使用 刷新套餐用量 接口。如果要取消当前会话，让卡片重新连接，请使用
取消当前会话 接口。
tags:
- API接口/卡业务接口
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- iccid
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"iccid": "8988308650100524999",
"packageCode": "CN-5M-7D-C-US-20230103AC4BF927",
"startType": "0",
"outTradeNo": "810000200804035522"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
required:
- code
- message
x-apifox-orders:
- code
- message
example:
code: '200'
message: 操作成功
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600564-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询账户下国际卡片预警信息
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600566e0.md
- Summary: 查询账户下国际卡片预警信息，可查询到流量余量不足的卡片iccid；
查询账户下国际卡片预警信息
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/outputApi/queryAccountWarningCard:
post:
summary: 查询账户下国际卡片预警信息
deprecated: false
description: 查询账户下国际卡片预警信息，可查询到流量余量不足的卡片iccid；
tags:
- API接口/卡业务接口
- 国际
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
pageNum:
description: 查询第几页的数据(起始为1，每页500条数据)
type: integer
type:
type: integer
description: 预警类型 1:流量用量预警 不足100M 2:流量使用百分比预警 不足10% 3:周期预警 不足7天
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- pageNum
- type
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- pageNum
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 28318,
"sign": "{{SIGN}}",
"pageNum": 100,
"type": 1
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
totalPage:
type: integer
description: 总页数
cardInfoList:
type: array
items:
type: object
properties:
iccid:
type: string
description: iccid卡号
type:
type: string
description: 1:流量用量预警 2:流量使用百分比预警 3:周期预警
earlyWarningValue:
type: integer
description: 预警值
x-apifox-orders:
- iccid
- type
- earlyWarningValue
required:
- totalPage
- cardInfoList
x-apifox-orders:
- totalPage
- cardInfoList
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 操作成功
data:
totalPage: 1
cardInfoList:
- iccid: '89860125641236548745'
type: '1'
earlyWarningValue: 100
- iccid: '89860125641236548745'
type: '2'
earlyWarningValue: 10
- iccid: '89860125641236548745'
type: '3'
earlyWarningValue: 7
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600566-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
卡总数统计
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600568e0.md
- Summary: 卡总数统计
卡总数统计
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/outputApi/queryCardNumber:
post:
summary: 卡总数统计
deprecated: false
description: 卡总数统计
tags:
- API接口/卡业务接口
- 国际
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 31773,
"sign": "{{SIGN}}"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
totalCard:
type: integer
description: 卡片总数
activatedCard:
type: integer
description: 激活过的卡片
usingCard:
type: integer
description: 正使用的卡片
orderedCard:
type: integer
description: |
订购过套餐的卡片
deactivatedCard:
type: integer
description: 已停用的卡片
required:
- totalCard
- activatedCard
- usingCard
- orderedCard
- deactivatedCard
x-apifox-orders:
- totalCard
- activatedCard
- usingCard
- orderedCard
- deactivatedCard
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 操作成功
data:
totalCard: 1457
activatedCard: 205
usingCard: 173
orderedCard: 1457
deactivatedCard: 32
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600568-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
本级分润查询
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600567e0.md
- Summary: 本级分润查询
本级分润查询
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/outputApi/listProfitInfo:
post:
summary: 本级分润查询
deprecated: false
description: 本级分润查询
tags:
- API接口/卡业务接口
- 国际
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
default: '{{TIMESTAMP}}'
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pageNum:
description: 查询第几页的数据(起始为1)
type: integer
pageSize:
description: 页面容量
type: integer
param:
description: |
ICCID/手机号
type: string
productCode:
description: 产品编码
type: string
startDate:
description: 开始时间 (YYYY-MM-DD HH:mm:ss)
type: string
endDate:
type: string
description: 开始时间 (YYYY-MM-DD HH:mm:ss)
ifWithdrawDeposit:
description: 分润提现状态 0:待提现 1:审核中 2:已完成 3:已失败
type: integer
withdrawDepositType:
description: 分润提现类型 1:手动提现 2:系统日结
type: integer
orderNumber:
type: string
description: 订单号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- pageNum
- pageSize
- param
- productCode
- startDate
- endDate
- ifWithdrawDeposit
- withdrawDepositType
- orderNumber
required:
- appkey
- timestamp
- nonce
- sign
- pageNum
- pageSize
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 15451,
"sign": "{{SIGN}}",
"pageNum": 1,
"pageSize": 100
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
total:
type: integer
description: |
总页数
data:
type: array
items:
type: object
properties:
id:
type: integer
description: 记录ID
iccid:
type: string
description: ICCID
platformId:
type: integer
description: 运营商ID 5:国际卡
orderId:
type: integer
description: 订单ID
incomeMoney:
type: number
description: 收入总额（结算币种）
actualProfit:
type: number
description: 实际分润（结算币种）
childProfit:
type: integer
description: 下级分润（结算币种）
company:
type: string
description: 分润客户
type:
type: integer
description: 收入类型 1 收入 2 扣减
createDate:
type: string
description: 交易时间
mem:
type: string
description: 备注
actualPrice:
type: number
description: 用户支付价额（支付币种）
packageUserName:
type: string
description: 套餐名称
settleCurrency:
type: string
description: 结算币种（收款币种：如：USD、HKD）
payCurrency:
type: string
description: 支付币种（实际支付币种：如：USD、JPY、THB等）
packageCode:
type: string
description: 套餐编码
payRate:
type: string
description: 汇率
renew:
type: integer
description: 0 正常订单 1续订订单
required:
- id
- iccid
- platformId
- orderId
- incomeMoney
- actualProfit
- childProfit
- company
- type
- createDate
- mem
- actualPrice
- packageUserName
- settleCurrency
- payCurrency
- packageCode
- payRate
- renew
x-apifox-orders:
- id
- iccid
- platformId
- orderId
- payCurrency
- actualPrice
- settleCurrency
- incomeMoney
- actualProfit
- childProfit
- company
- type
- createDate
- mem
- packageUserName
- packageCode
- payRate
- renew
01H4JHZGVDVNF8E8YS1Y3G2R9H:
type: string
required:
- total
- data
- 01H4JHZGVDVNF8E8YS1Y3G2R9H
x-apifox-orders:
- total
- data
- 01H4JHZGVDVNF8E8YS1Y3G2R9H
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 操作成功
data:
total: 157
data:
- id: 1022103
iccid: '89852000000000408392'
platformId: 5
orderId: 1440052
payCurrency: USD
actualPrice: 139
settleCurrency: USD
incomeMoney: 133.97
actualProfit: 133.97
childProfit: 0
company: '*****'
type: 1
createDate: '2023-05-21 09:53:34'
mem: >-
【Pkg
Sell】,US-VAT-24G-360day,CardNo:89852000000000408392,IncomeBenefit:133.97
USD
packageUserName: US-VAT-24G-360day
packageCode: GJ-LLB-24G-360-1US-QWT20220407170352
renew: 0
- id: 1021989
iccid: '89883000000000553740'
platformId: 5
orderId: 1439954
payCurrency: EUR
actualPrice: 10
settleCurrency: HKD
incomeMoney: 77.69
actualProfit: 77.69
childProfit: 0
company: '*****'
type: 1
createDate: '2023-05-21 05:01:20'
mem: >-
【Pkg
Sell】,PD-3G-30day,CardNo:89883000000000553740,IncomeBenefit:77.69
HKD
packageUserName: PD-3G-30day
packageCode: GJ-LLB-3G-30-2ROPDOZLLB20210607140809
renew: 1
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600567-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询卡片可切换的运营商列表
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/115661142e0.md
- Summary: 查询卡片可切换的运营商列表
查询卡片可切换的运营商列表
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/switchOptions:
post:
summary: 查询卡片可切换的运营商列表
deprecated: false
description: 查询卡片可切换的运营商列表
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- iccid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 99715,
"sign": "{{SIGN}}",
"iccid": "89852000261098750306"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
operators:
type: array
items:
type: string
description: 运营商名称
network:
type: string
description: 当前网络，同“切换卡片的运营商”接口network字段
x-apifox-orders:
- operators
- network
required:
- operators
- network
required:
- code
- message
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 操作成功
data:
operators:
- ATT
- TMobile
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-115661142-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
切换卡片的运营商
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/69975231e0.md
- Summary: 切换卡片使用特定地网络。
切换卡片的运营商
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/switchOperator:
post:
summary: 切换卡片的运营商
deprecated: false
description: 切换卡片使用特定地网络。
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
imsi:
type: string
description: 卡片的IMSI， IMSI 跟 ICCID 唯一识别卡片，可选择其中一个
network:
type: string
description: |-
目前仅支持美国地区卡，双网卡网络可选值
ATT：切换到USA AT&T；
TMobile：切换到USA TMobile；
ChinaMobile：切换到China Mobile；
ChinaUnicom：切换到China Unicom；
ALL：支持所有网络；
三网卡网络可选值：
ATT：切换到USA AT&T
TMobile：切换到USA TMobile
Verizon：切换到USA Verizon
VAT：支持Verizon+AT&T+T-Mobile
TN-V3-W 卡片可选值
USA-AT&T: 切换到 AT&T 网络
USA-TMobile: 切换到 T-Mobile 网络
USA-Verizon: 切换到 Verizon 网络
China-Mobile: 切换到 China Mobile 网络
China-Unicom: 切换到 China Unicom 网络
China-Telecom: 切换到 China Telecom 网络
all: 所有网络都可用
iccid:
type: string
description: 卡片ICCID，IMSI 跟 ICCID 唯一识别卡片，可选择其中一个
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- imsi
- iccid
- network
required:
- appkey
- timestamp
- nonce
- sign
- network
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"imsi": "8988308650109",
"network": "ATT"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
required:
- code
- message
x-apifox-orders:
- code
- message
example:
code: '200'
message: 操作成功
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-69975231-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
卡片IMEI池解锁
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/101613502e0.md
- Summary: 给指定卡号解除IMEI池锁
卡片IMEI池解锁
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/imeiUnlock:
post:
summary: 卡片IMEI池解锁
deprecated: false
description: 给指定卡号解除IMEI池锁
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- iccid
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"iccid": "8988308650100524999"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
imeiPoolUnlockCount:
type: integer
description: 池锁解锁次数
x-apifox-orders:
- imeiPoolUnlockCount
required:
- imeiPoolUnlockCount
required:
- code
- message
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 解锁成功
data:
imeiPoolUnlockCount: 2
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-101613502-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
IMEI卡池添加IMEI
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/107367410e0.md
- Summary: IMEI卡池添加IMEI
IMEI卡池添加IMEI
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/plockAddImei:
post:
summary: IMEI卡池添加IMEI
deprecated: false
description: IMEI卡池添加IMEI
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
imei:
type: string
description: IMEI
plockGroupId:
type: integer
description: 池锁ID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- imei
- plockGroupId
required:
- appkey
- timestamp
- nonce
- sign
- imei
- plockGroupId
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"imei": "898830865010052",
"plockGroupId":1
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
required:
- code
- message
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 加入成功
data: {}
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-107367410-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
发送短信
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/116059424e0.md
- Summary: 短信发送接口
发送短信
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/sms/sendSms:
post:
summary: 发送短信
deprecated: false
description: 短信发送接口
tags:
- API接口/卡业务接口
- 国际
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
message:
type: string
description: 短信内容，最大300个字符。
iccid:
type: string
description: 卡片ICCID号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- message
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- message
- iccid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"message":"DEAR ALL",
"iccid":""
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
trans_id:
type: string
description: TransId
x-apifox-orders:
- trans_id
required:
- trans_id
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 操作成功
data:
trans_id: dsafwef54s6af456sd4f6sd5fs
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-116059424-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询可退款金额
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/125065703e0.md
- Summary: 查询EIOTCLUB平台收款的订单，预计当前可退款的金额
查询可退款金额
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/queryRefundAmount:
post:
summary: 查询可退款金额
deprecated: false
description: |
查询EIOTCLUB平台收款的订单，预计当前可退款的金额
规则：
1.购买后24小时内，全额退款；
2.限量套餐：退款金额 = min(未使用天数/总可使用天数,未使用流量/总流量)*总用户支付金额 ；
3.限时套餐：退款金额 = (未使用天数/总可使用天数)*总用户支付金额 ；
4.金额在日元外币种，最小单位为分，向下取整，日元最小单位为元，同向下取整；
tags:
- API接口/卡业务接口
- 国际
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
iccid:
type: string
description: ICCID
orderId:
type: string
description: 套餐订单号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
- orderId
required:
- appkey
- timestamp
- nonce
- sign
- iccid
- orderId
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"iccid": "8988308650100524999",
"orderId": "810000200804035522"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
amount:
type: string
description: 可退款金额，字符串表示。单位是元。
currency:
type: string
description: 币种
amount_int:
type: integer
description: 可退款金额，单位分。对于日元，单位是元。
x-apifox-orders:
- amount
- amount_int
- currency
required:
- amount
- currency
- amount_int
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-125065703-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询客户账户余额
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/125457507e0.md
- Summary: 查询客户可供API订购时使用的账户余额
查询客户账户余额
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/agent/balance:
post:
summary: 查询客户账户余额
deprecated: false
description: 查询客户可供API订购时使用的账户余额
tags:
- API接口/卡业务接口
- 国际
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
currency:
type: string
description: 币种
balance:
type: string
description: 金额（单位：元，保留两位小数）
x-apifox-orders:
- balance
- currency
required:
- balance
- currency
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
data:
balance: '0.00'
currency: USD
message: 操作成功
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-125457507-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询套餐订购订单状态
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/205632872e0.md
- Summary: 查询EIOTCLUB平台的订单, orderId是我们平台生成
查询套餐订购订单状态
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/queryPackage:
post:
summary: 查询套餐订购订单状态
deprecated: false
description: 查询EIOTCLUB平台的订单, orderId是我们平台生成
tags:
- API接口/卡业务接口
- 国际
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
orderId:
type: string
description: 套餐订单号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
- orderId
required:
- appkey
- timestamp
- nonce
- sign
- iccid
- orderId
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"iccid": "8988308650101982576",
"orderId": "10002981"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
status:
type: integer
description: 订单状态：0 未成功 1 成功 -1 退款
x-apifox-orders:
- status
required:
- status
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-205632872-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询卡片归属的产品
查询卡片归属的产品
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/product:
post:
summary: 查询卡片归属的产品
deprecated: false
description: ''
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
iccid:
type: string
required:
- appkey
- timestamp
- nonce
- sign
- iccid
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
example:
appkey: '{{APPKEY}}'
timestamp: 0
operator: string
nonce: 10000
sign: string
iccid: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
data:
type: object
properties:
productCode:
type: string
required:
- productCode
x-apifox-orders:
- productCode
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: string
message: string
data:
productCode: string
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-261201381-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询指定产品下可订购的套餐
查询指定产品下可订购的套餐
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/listOrderPackageByProduct:
post:
summary: 查询指定产品下可订购的套餐
deprecated: false
description: ''
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
productCode:
type: string
description: 产品编码
required:
- appkey
- timestamp
- nonce
- sign
- productCode
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- productCode
example:
appkey: '{{APPKEY}}'
timestamp: 0
nonce: 10000
sign: string
productCode: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
packageCode:
type: string
description: 系统套餐编码
packageName:
type: string
description: 系统套餐名称
price:
type: integer
description: 套餐结算价，单位分，币种为美元
packageType:
type: integer
description: 套餐类型：2 限量流量包 3 限时流量包 4 限时限速包
flowSize:
type: integer
description: 流量大小， 单位M
periodSize:
type: integer
description: 有效期大小
periodType:
type: integer
description: 有效期类型 1:月 2:天
zone:
type: object
properties:
name:
type: string
description: 区域名称
img:
type: string
description: 区域图标
countries:
type: array
items:
type: object
properties:
name:
type: string
description: 国家名称
img:
type: string
description: 国家图标
operators:
type: array
items:
type: object
properties:
name:
type: string
description: 运营商名称
networkType:
type: string
description: 网络制式
x-apifox-orders:
- name
- networkType
required:
- name
- networkType
description: 支持的运营商
x-apifox-orders:
- name
- img
- operators
required:
- name
- img
- operators
description: 区域中包含的国家列表
x-apifox-orders:
- name
- img
- countries
required:
- name
- img
- countries
description: 套餐可使用的区域
x-apifox-orders:
- packageCode
- packageName
- price
- packageType
- flowSize
- periodSize
- periodType
- zone
required:
- zone
required:
- list
x-apifox-orders:
- list
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: string
message: string
data:
- operator: 0
packageCode: string
packageName: string
productCode: string
price: 0
packageType: 0
gzhPrice: 0
gzhPackageName: string
gzhStatus: 0
flowSize: 0
periodSize: 0
periodType: 0
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-261214352-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
根据套餐编码查询套餐信息
根据套餐编码查询套餐信息
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/queryOrderPackageByPackageCode:
post:
summary: 根据套餐编码查询套餐信息
deprecated: false
description: ''
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
packageCode:
type: string
description: 套餐编码
required:
- appkey
- timestamp
- nonce
- sign
- packageCode
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- packageCode
example:
appkey: '{{APPKEY}}'
timestamp: 0
nonce: 10000
sign: string
packageCode: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
data:
type: object
properties:
packageCode:
type: string
description: 系统套餐编码
packageName:
type: string
description: 系统套餐名称
packageType:
type: integer
description: 套餐类型：2 限量流量包 3 限时流量包 4 限时限速包
flowSize:
type: integer
description: 流量大小， 单位M
periodSize:
type: integer
description: 有效期大小
periodType:
type: integer
description: 有效期类型 1:月 2:天
zone:
type: object
properties:
name:
type: string
description: 区域名称
countries:
type: array
items:
type: object
properties:
name:
type: string
description: 国家名称
operators:
type: array
items:
type: object
properties:
name:
type: string
description: 运营商名称
networkType:
type: string
description: 网络制式
required:
- name
- networkType
x-apifox-orders:
- name
- networkType
description: 支持的运营商
x-apifox-orders:
- name
- operators
required:
- name
- countries
x-apifox-orders:
- name
- countries
required:
- packageCode
- packageName
- packageType
- flowSize
- periodSize
- periodType
- zone
x-apifox-orders:
- packageCode
- packageName
- packageType
- flowSize
- periodSize
- periodType
- zone
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '79'
message: exercitation adipisicing aliquip
data:
packageCode: '8'
packageName: 海梓睿
packageType: 16
flowSize: 1
periodSize: 26
periodType: 16
zone:
name: 典敏
countries:
- name: 诸葛艺涵
operators:
- name: 晏国香
networkType: sunt
- name: 徭梓晨
operators:
- name: 樊艳
networkType: enim tempor reprehenderit
- name: 独文昊
operators:
- name: 武建国
networkType: quis magna dolor
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-306595386-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询可订购的eSIM商品
查询可订购的eSIM商品
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/esim/goods:
post:
summary: 查询可订购的eSIM商品
deprecated: false
description: ''
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
example:
appkey: string
timestamp: 0
nonce: 0
sign: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: integer
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
price:
type: integer
description: 套餐结算价，单位分。结算币种是美元。
package:
type: object
properties:
packageCode:
type: string
description: 系统套餐编码
packageName:
type: string
description: 系统套餐名称
productCode:
type: string
description: 套餐归属产品编码
packageType:
type: integer
description: 套餐类型：2 限量流量包 3 限时流量包 4 限时限速包
flowSize:
type: integer
description: 流量大小， 单位M
periodSize:
type: integer
description: 有效期大小
zone:
type: object
properties:
name:
type: string
description: 区域名称
img:
type: string
description: 区域图标
countries:
type: array
items:
type: object
properties:
name:
type: string
description: 国家名称
img:
type: string
description: 国家图标
operators:
type: array
items:
type: object
properties:
name:
type: string
description: 运营商名称
networkType:
type: string
description: 网络制式
x-apifox-orders:
- name
- networkType
required:
- name
- networkType
description: 支持的运营商
x-apifox-orders:
- name
- img
- operators
required:
- name
- img
- operators
description: 区域中包含的国家列表
x-apifox-orders:
- name
- img
- countries
required:
- name
- img
- countries
description: 套餐可使用的区域
periodType:
type: integer
description: 有效期类型 1:月 2:天
x-apifox-orders:
- packageCode
- packageName
- productCode
- packageType
- flowSize
- periodSize
- periodType
- zone
required:
- packageCode
- packageName
- productCode
- packageType
- flowSize
- periodSize
- zone
description: 初始套餐
code:
type: string
description: 商品编码
name:
type: string
description: 商品名称
x-apifox-orders:
- code
- name
- price
- package
required:
- name
- package
description: eSIM 商品列表
required:
- list
x-apifox-orders:
- list
message:
type: string
required:
- code
- data
- message
x-apifox-orders:
- code
- data
- message
example:
code: 0
data:
list:
- code: string
zone:
name: string
img: string
message: string
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-261293423-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
购买eSIM
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/261353809e0.md
- Summary: 错误码：
购买eSIM
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/esim/purchase:
post:
summary: 购买eSIM
deprecated: false
description: |
错误码：
503016 - 重复订单号。返回这个错误的时候可以通过查询eSIM订单详情接口获取结果。
45109 - 找不到eSIM商品
45110 - eSIM 商品库存不足
45112 - 账户余额不足
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
eSIMGoodsCode:
type: string
description: eSIM商品编码
minLength: 1
maxLength: 255
outTradeNo:
type: string
description: 客户订单号
required:
- appkey
- timestamp
- nonce
- sign
- eSIMGoodsCode
- outTradeNo
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- eSIMGoodsCode
- outTradeNo
example:
appkey: string
timestamp: 0
nonce: 0
sign: string
eSIMGoodsCode: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: integer
data:
type: object
properties:
iccid:
type: string
description: 卡号
activationCode:
type: string
description: 激活码
orderId:
type: string
description: 平台订单号
required:
- iccid
- activationCode
- orderId
x-apifox-orders:
- orderId
- iccid
- activationCode
message:
type: string
required:
- code
- data
- message
x-apifox-orders:
- code
- data
- message
example:
code: 0
data:
orderId: ''
iccid: ''
activationCode: ''
message: string
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-261353809-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
eSIM订单退款
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/261832528e0.md
- Summary: 错误码：
eSIM订单退款
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/esim/refund:
post:
summary: eSIM订单退款
deprecated: false
description: |-
错误码：
45113 - 当前状态下不允许退款。订单在成功状态下才可以退款
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
orderId:
type: string
description: 平台订单号
remark:
type: string
description: 退款备注，必填
required:
- appkey
- timestamp
- nonce
- sign
- orderId
- remark
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- orderId
- remark
example:
appkey: string
timestamp: 0
nonce: 0
sign: string
orderId: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: integer
data:
type: object
properties: {}
x-apifox-orders: []
message:
type: string
required:
- code
- data
- message
x-apifox-orders:
- code
- data
- message
example:
code: 0
data: {}
message: string
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-261832528-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询eSIM订单详情
查询eSIM订单详情
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/esim/orderStatus:
post:
summary: 查询eSIM订单详情
deprecated: false
description: ''
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
orderId:
type: string
description: 平台订单号
required:
- appkey
- timestamp
- nonce
- sign
- orderId
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- orderId
example: "{\r\n \"operator\": 5,\r\n \"appkey\": \"{{APPKEY}}\",\r\n \"timestamp\": {{TIMESTAMP}},\r\n \"nonce\": 90174,\r\n \"sign\": \"{{SIGN}}\",\r\n \"orderId\": \"10002981\"\r\n}"
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
data:
type: object
properties:
status:
type: integer
description: 订单状态：1表示处理中，2表示成功，3表示已退款， -1表示失败
iccid:
type: string
description: 卡号，订单成功时返回
activationCode:
type: string
description: 激活码，订单成功时返回
required:
- status
- iccid
- activationCode
x-apifox-orders:
- status
- iccid
- activationCode
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: 操作成功
data:
status: 1
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-261839405-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询eSIM订单可退金额
查询eSIM订单可退金额
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/esim/queryRefundAmount:
post:
summary: 查询eSIM订单可退金额
deprecated: false
description: ''
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
orderId:
type: string
description: 订单号
required:
- appkey
- timestamp
- nonce
- sign
- orderId
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- orderId
example:
appkey: string
timestamp: 0
nonce: 0
sign: string
orderId: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
data:
type: object
properties:
amount:
type: integer
description: 金额，单位分。对于日元，单位是元。
currency:
type: string
description: 币种
required:
- amount
- currency
x-apifox-orders:
- amount
- currency
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
data:
amount: 140
currency: USD
message: 操作成功
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-268458591-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
批量查询订单对应套餐详情
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/326460738e0.md
- Summary: 根据orderNumber或outTradeNo获取对应套餐详情。最大50个
批量查询订单对应套餐详情
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/getOrderPackageDetails:
post:
summary: 批量查询订单对应套餐详情
deprecated: false
description: |+
根据orderNumber或outTradeNo获取对应套餐详情。最大50个
tags:
- API接口/卡业务接口
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
orderNumberArrStr:
type: string
description: 订单号字符串。用,串联，如 a,b,c
outTradeNoArrStr:
type: string
description: 客户订单号字符串。用,串联，如 a,b,c
state:
type: integer
description: |-
套餐使用状态 0:待使用 1:使用中 2:已完成
0 待使用：后续会生效的套餐；
1 使用中：目前在用的套餐；
2 已完成：已完成的套餐包括退款、用完等情况；
page:
type: integer
description: 页码。从1开始
pageSize:
type: integer
description: 页大小。最大50
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- orderNumberArrStr
- outTradeNoArrStr
- state
- page
- pageSize
required:
- appkey
- timestamp
- nonce
- sign
- state
- page
- pageSize
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
orderNumberArrStr: >-
f2e84914-c749-437e-a087-888f4b4597e8,2e33bef9-2387-47e6-8a70-2ce194d3ebaa,97ab965e-994f-4371-9e44-2b5f020bc9d9
outTradeNoArrStr: 63000019831114267611,630000198311142676,630000198311142677
state: 2
page: 1
pageSize: 2
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: array
items:
type: object
properties:
packageName:
type: string
description: 套餐名称
iccid:
type: string
description: 卡号
state:
type: integer
description: |-
套餐使用状态 0:待使用 1:使用中 2:已完成
0 待使用：后续会生效的套餐；
1 使用中：目前在用的套餐；
2 已完成：已完成的套餐包括退款、用完等情况；
price:
type: number
description: 订购价格
format: float64
createDate:
type: string
description: 订购时间
startDate:
type: string
description: 套餐开始时间
endDate:
type: string
description: |
套餐结束时间
flowTotal:
type: number
description: 套餐总流量
format: float64
flowRemain:
type: number
description: 剩余流量
format: float64
gzhPackageName:
type: string
description: 商品套餐名称
totalActive:
type: integer
description: 有效时长, 以periodType的值为单位
currency:
type: string
description: 币种
packageCode:
type: string
description: 套餐编码
renew:
type: integer
description: 0 正常订单 1续订订单
packageType:
type: integer
description: 套餐类型：2 限量流量包 3 限时流量包 4 限时限速包
isRefund:
type: integer
description: 是否退订 0 未退订 1 已退订
periodType:
type: integer
description: 有效期类型 1:月 2:天
orderNumber:
type: string
description: 订单号
outTradeNo:
type: string
description: 客户订单号
required:
- packageName
- iccid
- state
- price
- createDate
- startDate
- endDate
- flowTotal
- flowRemain
- gzhPackageName
- totalActive
- currency
- orderNumber
- packageCode
- renew
- packageType
- isRefund
- periodType
- outTradeNo
x-apifox-orders:
- orderNumber
- outTradeNo
- packageName
- packageCode
- iccid
- state
- price
- currency
- createDate
- startDate
- endDate
- flowTotal
- flowRemain
- gzhPackageName
- totalActive
- renew
- packageType
- isRefund
- periodType
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
data:
- orderNumber: f2e84914-c749-437e-a087-888f4b4597e8
outTradeNo: '430000199808051427'
iccid: '89852243101000600107'
packageCode: GJ-LLB-50M-180-1LTCSCP20210308161656
orderId: 2224
price: 30
currency: EUR
state: -9
totalActive: 180
flowTotal: 50
packageName: 国际-流量包-50M-180天
packageType: 2
createDate: '2023-02-20 20:55:05'
renew: 0
periodType: 2
isRefund: 0
startDate: '2023-03-22 13:12:31'
endDate: '2023-03-22 13:47:35'
flowRemain: 0
gzhPackageName: pkg 50M/180daysadf
- orderNumber: 2e33bef9-2387-47e6-8a70-2ce194d3ebaa
outTradeNo: '81000020080403552211'
iccid: '8988308650100524999'
packageCode: GJ-LLB-100M-30D-RPOZLLB-20221115DAAB11A1
orderId: 10002241
price: 0
currency: USD
state: 2
totalActive: 30
flowTotal: 100
packageName: 国际-流量包-100M-30天
packageType: 2
createDate: '2023-02-22 16:20:05'
renew: 0
periodType: 2
isRefund: 0
startDate: '2023-02-25 13:40:38'
endDate: '2023-03-27 13:45:02'
flowRemain: 0
gzhPackageName: 100M 7day
- orderNumber: 97ab965e-994f-4371-9e44-2b5f020bc9d9
outTradeNo: 89852243101000600107-1
iccid: '89852243101000600107'
packageCode: GJ-LLB-20M-360D-LTCSCP-2022102899F1E1EF
orderId: 10002359
price: 0
currency: USD
state: -9
totalActive: 360
flowTotal: 20
packageName: 国际-流量包-20M-360day
packageType: 2
createDate: '2023-05-08 20:07:07'
renew: 0
periodType: 2
isRefund: 0
startDate: ''
endDate: ''
flowRemain: 0
gzhPackageName: pkg 20M/360day
- orderNumber: 9492a3e3-3790-4504-9b8f-e76af32c09a5
outTradeNo: '63000019831114267611'
iccid: '8988308650100524999'
packageCode: GJ-LLB-100M-7D-RPOZLLB-2022111574FF19BC
orderId: 10002877
price: 0
currency: USD
state: 2
totalActive: 7
flowTotal: 100
packageName: 国际-流量包-100M-7天
packageType: 2
createDate: '2023-10-24 21:06:40'
renew: 0
periodType: 2
isRefund: 0
startDate: '2024-01-14 17:08:37'
endDate: '2024-01-21 16:57:58'
flowRemain: 0
gzhPackageName: ''
- orderNumber: 99fb1036-5f61-43b5-8ee2-5b7ac1bac218
outTradeNo: '630000198311142676'
iccid: '8932042000000440887'
packageCode: BC-QT-50M-1D-BICS-CN-CSCP-20231206A1BBB573
orderId: 10003188
price: 3
currency: USD
state: -9
totalActive: 1
flowTotal: 50
packageName: BC-QT-50M-1天
packageType: 2
createDate: '2023-12-07 13:50:55'
renew: 0
periodType: 2
isRefund: 0
startDate: '2023-12-08 18:35:23'
endDate: '2023-12-08 18:36:03'
flowRemain: 0
gzhPackageName: 50M 1days
- orderNumber: 759d9a1f-1355-4b0b-a515-6e041bcb8ba5
outTradeNo: '630000198311142677'
iccid: '8932042000000440887'
packageCode: BC-QT-50M-1D-BICS-CN-CSCP-20231206A1BBB573
orderId: 10003189
price: 3
currency: USD
state: -9
totalActive: 1
flowTotal: 50
packageName: BC-QT-50M-1天
packageType: 2
createDate: '2023-12-07 13:52:23'
renew: 0
periodType: 2
isRefund: 0
startDate: ''
endDate: '2023-12-08 18:34:48'
flowRemain: 0
gzhPackageName: 50M 1days
message: success
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-326460738-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
机卡绑定
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/337198418e0.md
- Summary: 机卡绑定
机卡绑定
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/bindDevice:
post:
summary: 机卡绑定
deprecated: false
description: 机卡绑定
tags:
- API接口/卡业务接口
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
imei:
type: string
description: 设备 id
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
- imei
required:
- appkey
- timestamp
- nonce
- sign
- iccid
- imei
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
iccid: '8932042000002473055'
imei: asdf
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
required:
- code
- message
x-apifox-orders:
- code
- message
example:
code: '200'
message: success
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-337198418-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
机卡解绑
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/337222973e0.md
- Summary: 机卡解绑
机卡解绑
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/unbindDevice:
post:
summary: 机卡解绑
deprecated: false
description: |
机卡解绑
tags:
- API接口/卡业务接口
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
required:
- appkey
- timestamp
- nonce
- sign
- iccid
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
iccid: '8932042000002473055'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
required:
- code
- message
x-apifox-orders:
- code
- message
example:
code: '200'
message: success
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-337222973-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
卡片转移套餐
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/337444569e0.md
- Summary: 卡片转移套餐
卡片转移套餐
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/transferPkg:
post:
summary: 卡片转移套餐
deprecated: false
description: 卡片转移套餐
tags:
- API接口/卡业务接口
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
oldIccid:
type: string
description: 旧 iccid
newIccid:
type: string
description: 新 iccid
memo:
type: string
description: 备注
orderId:
type: integer
description: 订单号。如10006889。如果 orderId 和 orderNumber 同时存在则优先取 orderId
orderNumber:
type: string
description: 订单编码。如df2b29c3-e20a-448c-9358-e945f3d60c3d
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- oldIccid
- orderId
- orderNumber
- newIccid
- memo
required:
- appkey
- timestamp
- nonce
- sign
- orderId
- oldIccid
- newIccid
- orderNumber
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
oldIccid: '8910300000029554754'
orderId: 10007043
orderNumber: df2b29c3-e20a-448c-9358-e945f3d60c3d
newIccid: '8910300000029437304'
memo: memo
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功，其他失败。具体原因 message 中会说明，如参数错误等
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
newPkgCode:
type: string
description: 新套餐编码
newOrderId:
type: integer
description: 新订单号。如10006889
x-apifox-orders:
- newPkgCode
- newOrderId
required:
- newPkgCode
- newOrderId
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-337444569-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
刷新套餐用量
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/364764868e0.md
- Summary: 此接口用于刷新套餐的用量。调用成功后，系统会触发一次向运营商同步用量的操作。
刷新套餐用量
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/refreshUsage:
post:
summary: 刷新套餐用量
deprecated: false
description: |
此接口用于刷新套餐的用量。调用成功后，系统会触发一次向运营商同步用量的操作。
不要在定时任务中调用此接口，仅在用户手动刷新用量时才使用。
5分钟内仅可调用一次。
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
iccid:
type: string
required:
- appkey
- timestamp
- nonce
- sign
- iccid
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
example: "{\r\n \"operator\": 5,\r\n \"appkey\": \"{{APPKEY}}\",\r\n \"timestamp\": {{TIMESTAMP}},\r\n \"nonce\": 90174,\r\n \"sign\": \"{{SIGN}}\",\r\n \"iccid\": \"8988308650100524999\"\r\n}"
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
required:
- code
- message
x-apifox-orders:
- code
- message
example:
code: '200'
message: 操作成功
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-364764868-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
取消当前会话
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/364767281e0.md
- Summary: 此接口会断开当前连接，迫使设备端重新发起连接。
取消当前会话
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/cancelLocation:
post:
summary: 取消当前会话
deprecated: false
description: |
此接口会断开当前连接，迫使设备端重新发起连接。
5分钟内仅可调用一次。
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
timestamp:
type: integer
nonce:
type: integer
sign:
type: string
iccid:
type: string
required:
- appkey
- timestamp
- nonce
- sign
- iccid
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
example:
operator: 5
appkey: '{{APPKEY}}'
timestamp: 1761104681
nonce: 90174
sign: '{{SIGN}}'
iccid: '8988308650100524999'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
required:
- code
- message
x-apifox-orders:
- code
- message
example:
code: '200'
message: 操作成功
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-364767281-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
批量重置卡
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/414346978e0.md
- Summary: 这个接口实际是批量任务走的消息队列处理，返回结果表示本次调用API是否成功，具体执行结果需要到【CMP平台--任务管理--批量任务】查看
批量重置卡
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/card/reset:
post:
summary: 批量重置卡
deprecated: false
description: 这个接口实际是批量任务走的消息队列处理，返回结果表示本次调用API是否成功，具体执行结果需要到【CMP平台--任务管理--批量任务】查看
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
x-apifox-mock: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
x-apifox-mock: '{{TIMESTAMP}}'
description: 当前时间戳，10位数字
nonce:
type: string
sign:
type: string
x-apifox-mock: '{{SIGN}}'
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
iccids:
type: string
description: iccid卡号，用英文逗号隔开,单次最多传100个
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccids
required:
- appkey
- timestamp
- nonce
- sign
- iccids
example: "{\r\n \"appkey\": \"{{APPKEY}}\",\r\n \"timestamp\": {{TIMESTAMP}},\r\n \"nonce\": 49890,\r\n \"sign\": \"{{SIGN}}\",\r\n \"iccids\": \"89920919871264224367\"\r\n}"
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
required:
- code
- message
x-apifox-orders:
- code
- message
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-414346978-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询批处理任务状态
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/435737012e0.md
- Summary: 支持ids批量查询任务执行状态
查询批处理任务状态
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/task/query:
post:
summary: 查询批处理任务状态
deprecated: false
description: 支持ids批量查询任务执行状态
tags:
- API接口/卡业务接口
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
x-apifox-mock: '{{TIMESTAMP}}'
description: 当前时间戳，10位数字
nonce:
type: string
sign:
type: string
x-apifox-mock: '{{SIGN}}'
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
ids:
type: string
description: 任务ids，用英文逗号隔开,单次最多传100个
x-apifox-orders:
- appkey
- sign
- timestamp
- nonce
- ids
required:
- appkey
- timestamp
- nonce
- sign
- ids
examples: {}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
data:
type: array
items:
type: object
properties:
id:
type: string
description: 任务id
status:
type: string
description: 任务状态枚举：0 等待，1 执行中，2 执行成功，-1 终止，-2 失败
result:
type: string
description: 执行结果
x-apifox-orders:
- id
- status
- result
required:
- id
- status
- result
x-apifox-orders:
- code
- data
required:
- code
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡业务接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-435737012-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
套餐订购接口
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/63600569e0.md
- Summary: 卡片套餐订购,主套餐是立即生效，只有流量包可以次月生效
套餐订购接口
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/orderPackage:
post:
summary: 套餐订购接口
deprecated: false
description: |+
卡片套餐订购,主套餐是立即生效，只有流量包可以次月生效
tags:
- API接口/卡套餐订购相关接口
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡号
packageCode:
type: string
description: 套餐编码
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
x-apifox-mock: '{{$person.idCard}}'
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
- packageCode
- outTradeNo
required:
- appkey
- timestamp
- nonce
- sign
- iccid
- packageCode
- outTradeNo
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 81537,
"sign": "{{SIGN}}",
"iccid": "8988308650100524999",
"packageCode": "CN-5M-7D-C-US-20230103AC4BF927",
"outTradeNo": "630000198311142676"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
orderNumber:
type: string
description: API订购唯一对应编号
orderId:
type: number
description: 套餐订单号
required:
- orderNumber
- orderId
x-apifox-orders:
- orderNumber
- orderId
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: success
data:
orderNumber: 1611558040873b105b2678de34504a35
orderId: 101106255
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡套餐订购相关接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600569-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
套餐退款接口
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/205572440e0.md
- Summary: 卡片套餐退款；
套餐退款接口
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/package/refundPackage:
post:
summary: 套餐退款接口
deprecated: false
description: |+
卡片套餐退款；
关于订单可退金额计算规则：
1.购买后24小时内，全额退款；
2.退款金额 = min(未使用天数/总可使用天数, 未使用流量/总流量)*总用户支付金额 ；
3.金额在日元外币种，最小单位为分，向下取整，日元最小单位为元，同向下取整；
tags:
- API接口/卡套餐订购相关接口
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
iccid:
type: string
description: 卡号
orderId:
type: string
description: 套餐订单号
x-apifox-mock: '0'
remark:
type: string
description: 退款说明,最大长度200
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- iccid
- orderId
- remark
required:
- appkey
- timestamp
- nonce
- sign
- iccid
- remark
- orderId
example: |-
{
"operator": 5,
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 90174,
"sign": "{{SIGN}}",
"iccid": "8988308650101982576",
"orderId": "10002981",
"remark":"用户要求"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: success
data: {}
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/卡套餐订购相关接口
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-205572440-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
流量预警
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/102168712e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
流量预警
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 流量预警
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
流量余量不足的卡片预警通知
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，此通知为 FlowAlert
iccid:
type: string
description: ICCID
alert_type:
type: integer
description: 预警类型 1:流量用量预警 不足100M 2:流量使用百分比预警 不足10% 3:周期预警 不足7天
alert_value:
type: string
description: 触发值
x-apifox-orders:
- id
- timestamp
- nonce
- event
- sign
- iccid
- alert_type
- alert_value
required:
- timestamp
- nonce
- sign
- event
- id
- iccid
- alert_type
- alert_value
example:
alert_type: 1
alert_value: '100'
event: FlowAlert
iccid: '89852012345678901234'
id: CNTUlkm0pzRujPBr2tN8NNa7
nonce: 40974
sign: 88426183D4F6A984E9EA2F8BB2F7221D732F2EDF
timestamp: 1703142059
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-102168712-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
订购通知-详细版
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/124594751e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
订购通知-详细版
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 订购通知-详细版
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
卡新增套餐通知，通知内的多个iccid新订购套餐
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，如“SubPkgList”
data:
type: array
items:
type: object
properties:
iccid:
type: string
description: ICCID
orderId:
type: number
description: 套餐订单号
packageName:
type: string
description: 套餐名称
packageCode:
type: string
description: 套餐编码
state:
type: integer
description: 套餐使用状态 0:待使用 1:使用中 2:已完成
gzhPackageName:
type: string
description: 商品套餐名称
packageType:
type: integer
description: 套餐类型，2 限量流量包 3 限时流量包 4 限时限速包
createDate:
type: string
description: 订购时间
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
fromIccid:
type: string
description: 转移的套餐会记录从哪个iccid转移而来
fromOrderId:
type: integer
description: 转移的套餐会记录从哪个orderId转移而来
salesChannel:
type: string
description: >-
销售渠道：USER 用户自己购买，SYSTEM 保底套餐，TRANSFER 转移的套餐, PLATFORM
后台平台购买, API购买
customData:
type: string
description: 客户白名单登录的用户唯一标识，最大125位
x-apifox-orders:
- iccid
- orderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
- outTradeNo
- fromIccid
- fromOrderId
- salesChannel
- customData
required:
- iccid
- orderId
- packageName
- packageCode
- state
- salesChannel
- createDate
- packageType
- gzhPackageName
description: 订购套餐数据
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- data
- event
example:
data: >-
[{"iccid":"89423053323291099364","orderId":10004728,"packageName":"A-TM-50M-1天","packageCode":"A-TM-50M-1D-A-CN-TEST-2024052489FC722C","state":0,"gzhPackageName":"","createDate":"2024-05-28
09:34:47","packageType":3,"outTradeNo":"6300001983111426769635"}]
event: SubPkgList
id: ue5Y0qNC8QQIRtUR3UgV4xzg
nonce: 40604
sign: F0D19FA6945B21C0D61BDEFD4DCC41B64B29272B
timestamp: 1716860340
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-124594751-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
套餐生效
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/408551021e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
套餐生效
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 套餐生效
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
套餐生效通知
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，如“PkgEffective”
data:
type: object
properties:
iccid:
type: string
description: ICCID
orderId:
type: number
description: 套餐订单号
packageName:
type: string
description: 套餐名称
packageCode:
type: string
description: 套餐编码
state:
type: integer
description: 套餐使用状态 0:待使用 1:使用中 2:已完成
gzhPackageName:
type: string
description: 商品套餐名称
packageType:
type: integer
description: 套餐类型，2 限量流量包 3 限时流量包 4 限时限速包
createDate:
type: string
description: 订购时间
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
fromIccid:
type: string
description: 转移的套餐会记录从哪个iccid转移而来
fromOrderId:
type: integer
description: 转移的套餐会记录从哪个orderId转移而来
salesChannel:
type: string
description: >-
销售渠道：USER 用户自己购买，SYSTEM 保底套餐，TRANSFER 转移的套餐， PLATFORM
后台平台购买
startDate:
type: string
description: '套餐开始时间，格式: 2026-01-02 15:04:05'
endDate:
type: string
description: '套餐预期结束时间, 格式: 2026-01-02 15:04:05'
x-apifox-orders:
- iccid
- orderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
- startDate
- endDate
- outTradeNo
- fromIccid
- fromOrderId
- salesChannel
description: 订购套餐数据
x-apifox-refs: {}
required:
- iccid
- orderId
- packageName
- packageCode
- state
- salesChannel
- createDate
- packageType
- gzhPackageName
- endDate
- startDate
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- data
- event
example:
data: >-
{"iccid":"89423053323291099364","orderId":10004728,"packageName":"A-TM-50M-1天","packageCode":"A-TM-50M-1D-A-CN-TEST-2024052489FC722C","state":0,"gzhPackageName":"","createDate":"2024-05-28
09:34:47","packageType":3,"outTradeNo":"6300001983111426769635"}
event: PkgEffective
id: ue5Y0qNC8QQIRtUR3UgV4xzg
nonce: 40604
sign: F0D19FA6945B21C0D61BDEFD4DCC41B64B29272B
timestamp: 1716860340
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-408551021-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
退款通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/142538990e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
退款通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 退款通知
deprecated: false
description: |
客户提供接收异步通知的地址（HTTP/HTTPS）
卡退订套餐通知，通知内的iccid退订套餐
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，如“Refund”
iccid:
type: string
description: iccid
orderId:
type: integer
description: 套餐订单号，见“查询卡片套餐订购记录”接口的响应字段
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
orderAmount:
type: string
description: 交易金额，保留两位小数
refundAmount:
type: string
description: 退款金额，保留两位小数
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- iccid
- orderId
- outTradeNo
- orderAmount
- refundAmount
required:
- timestamp
- nonce
- sign
- id
- iccid
- event
- orderId
- outTradeNo
- orderAmount
- refundAmount
example:
event: Refund
iccid: '89423053323291099364'
id: s2Vx3BfRtN1h253WeCLNRkAz
nonce: 15487
orderId: 10004728
outTradeNo: '6300001983111426769635'
sign: 86AB51FECD873FDCF4B67F7CC4B2119D8BEFEE30
timestamp: 1716860580
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-142538990-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
达量到期通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/180586043e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
达量到期通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 达量到期通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
当前套餐被停用（使用完毕、到期、退订等情况下）的通知，卡片可能存在其他待使用套餐
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，如“PkgQuantityList”
data:
type: array
items:
type: object
properties:
iccid:
type: string
description: ICCID
orderId:
type: number
description: 套餐订单号
packageName:
type: string
description: 套餐名称
packageCode:
type: string
description: 套餐编码
state:
type: integer
description: 套餐使用状态 0:待使用 1:使用中 2:已完成
gzhPackageName:
type: string
description: 商品套餐名称
packageType:
type: integer
description: 套餐类型
createDate:
type: string
description: 订购时间
outTradeNo:
type: string
description: 【仅在API订购时存在】API调用方传入的唯一订单号标识 最大32位
x-apifox-orders:
- iccid
- orderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
- outTradeNo
required:
- iccid
- orderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
description: 订购套餐数据
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- event
- data
example:
data: >-
[{"iccid":"89852000263311290649","orderId":10005717,"packageName":"CNu-QT-100M-7天","packageCode":"CNU-QT-100M-7D-C-CNU-202403131FF1E56A","state":2,"gzhPackageName":"100-7","createDate":"2024-11-01
10:50:00","packageType":2}]
event: PkgQuantityList
id: 5IdTuJONGK5FYQ5BQT2IkUwu
nonce: 55595
sign: 39DE1981FBB166835626C2201FF974452A203D50
timestamp: 1731033900
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-180586043-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
卡片断网通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/180590250e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
卡片断网通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 卡片断网通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
卡无法联网,没有其他套餐可用
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，此通知为 CardStopped
iccid:
type: string
description: iccid
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- iccid
required:
- timestamp
- nonce
- sign
- id
- iccid
- event
example:
event: CardStopped
iccid: '89852000263320817044'
id: 7bpDUV2P4oAGv37MBBHaAeJk
nonce: 90082
sign: 66468E1A1E5E06DFF73E8508F95C89B19EDAC3E4
timestamp: 1746050702
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-180590250-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
产品切换
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/142414405e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
产品切换
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 产品切换
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
卡切换产品的通知，通知内的多个iccid的新产品编码
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，如“SwitchProduct”
data:
type: array
items:
type: object
properties:
iccid:
type: string
description: ICCID
productCode:
type: string
description: 产品编码
x-apifox-orders:
- iccid
- productCode
required:
- iccid
- productCode
description: 数据
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- data
- event
example:
data: >-
[{"iccid":"8988308650100524999","productCode":"2ROPDOZLLB20210607140809"}]
event: SwitchProduct
id: U0uauFzYcBgP50i09jxKaC29
nonce: 76706
sign: B3101B16CF9DCFF3F05BF5445E4F5B4036891B47
timestamp: 1710497899
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-142414405-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
锁卡通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/102037065e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
锁卡通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 锁卡通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
关于IMEI池锁的功能的卡片被锁通知
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，如“CardIMEILocked”
iccid:
type: string
description: ICCID
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- iccid
required:
- timestamp
- nonce
- sign
- event
- id
- iccid
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: testing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-102037065-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
解锁通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/102242209e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
解锁通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 解锁通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
关于IMEI池锁的功能的卡片解锁通知
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，如“IMEIUnLock”
iccid:
type: string
description: ICCID
x-apifox-orders:
- id
- timestamp
- nonce
- event
- sign
- iccid
required:
- timestamp
- nonce
- sign
- event
- id
- iccid
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: testing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-102242209-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
通知卡片被移出IMEI池
通知卡片被移出IMEI池
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 通知卡片被移出IMEI池
deprecated: false
description: ''
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: 请求的唯一标识
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: string
description: 5位随机正整数
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
event:
type: string
description: 通知的类型，此通知为 CardMovedOutIMEIPool
iccid:
type: string
description: iccid
plockGroupId:
type: integer
description: 卡被移出之前所在的池 ID
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- iccid
- plockGroupId
required:
- id
- timestamp
- nonce
- sign
- event
- iccid
- plockGroupId
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties: {}
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-248790646-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
通知卡片移入IMEI池
通知卡片移入IMEI池
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 通知卡片移入IMEI池
deprecated: false
description: ''
tags:
- API接口/异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: 请求的唯一标识
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: string
description: 5位随机正整数
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
event:
type: string
description: 通知的类型，此通知为 CardMovedInIMEIPool
iccid:
type: string
description: iccid
plockGroupId:
type: integer
description: IMEI池 ID
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- iccid
- plockGroupId
required:
- id
- timestamp
- nonce
- sign
- event
- iccid
- plockGroupId
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties: {}
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/异步通知
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-248815912-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询账户下所有云esim卡片
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359018946e0.md
- Summary: 查询账户下所有卡片、获取账号内全部卡片，每页500条数据
查询账户下所有云esim卡片
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/list:
post:
summary: 查询账户下所有云esim卡片
deprecated: false
description: 查询账户下所有卡片、获取账号内全部卡片，每页500条数据
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
pageNum:
type: string
default: ''
enum:
- '1'
description: 分页页数，从1开始
x-apifox-enum:
- name: ''
value: '1'
description: ''
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
pageSize:
type: integer
default: 500
description: 默认为500
cardStatus:
type: string
description: >-
卡片状态
ACTIVATION_READY_NAME 可激活 NON_ACTIVATED_NAME 待激活
ACTIVATED_NAME 已激活 DEACTIVATED_NAME 已停用 RETIRED_NAME 已失效
x-apifox-mock: NON_ACTIVATED_NAME
eids:
type: string
description: eid卡号，用，隔开
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- pageNum
- pageSize
- cardStatus
- eids
required:
- pageNum
- appkey
- timestamp
- nonce
- sign
example: |-
{
"pageNum": "1",
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 49890,
"sign": "{{SIGN}}",
"pageSize": 78
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
cardInfoList:
type: array
items:
type: object
properties:
cardStatus:
type: string
description: >-
ACTIVATION_READY_NAME 可激活 NON_ACTIVATED_NAME 待激活
ACTIVATED_NAME 已激活 DEACTIVATED_NAME 已停用
ACTIVATED_BASE 套餐停用卡仍可使用
title: 卡状态
activateDate:
type: string
title: ' 激活日期字符串'
description: ' 激活日期字符串'
packageEndDate:
type: string
description: 当前套餐到期日期
title: 当前套餐到期日期
eid:
type: string
title: eid卡号
description: eid卡号
currentPkgRemainBytes:
type: integer
description: 当前套餐剩余流量(Bytes)
title: 当前套餐剩余流量(Bytes)
currentPkgUsedBytes:
type: integer
title: 当前套餐已用流量(Bytes)
description: 当前套餐已用流量(Bytes)
currentPkgTotalBytes:
type: integer
description: 当前套餐流量总量单位(Bytes)
title: 当前套餐流量总量单位(Bytes)
totalFlowBytes:
type: integer
description: 卡片总流量单位Bytes
title: 卡片总流量单位Bytes
remainFlowBytes:
type: integer
title: 卡片总剩余可用流量单位Bytes
description: 卡片总剩余可用流量单位Bytes
productCode:
type: string
description: 产品编码
title: 产品编码
expectedEndDate:
type: string
title: 预期服务截止日期
description: 预期服务截止日期
packageCode:
type: string
title: 套餐编码
description: 套餐编码
packageType:
type: integer
title: 套餐类型
description: 2 限量流量包 3 限时流量包 4 限时限速包
packageName:
type: string
description: 套餐名称
title: 套餐名称
required:
- eid
- remainFlowBytes
- cardStatus
- currentPkgRemainBytes
- currentPkgUsedBytes
- totalFlowBytes
- productCode
- packageType
- packageName
- currentPkgTotalBytes
- packageCode
x-apifox-orders:
- eid
- activateDate
- cardStatus
- currentPkgRemainBytes
- currentPkgUsedBytes
- currentPkgTotalBytes
- totalFlowBytes
- remainFlowBytes
- expectedEndDate
- productCode
- packageEndDate
- packageCode
- packageType
- packageName
description: 卡信息详情列表集合
totalPage:
type: integer
description: 总页数
required:
- cardInfoList
- totalPage
x-apifox-orders:
- cardInfoList
- totalPage
description: |
返回数据
title: ''
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: consectetur Excepteur irure tempor officia
data:
cardInfoList:
- eid: '68'
activateDate: '2025-02-23'
cardStatus: ACTIVATION_READY_NAME
currentPkgRemainBytes: 34
currentPkgUsedBytes: 69
currentPkgTotalBytes: 96
totalFlowBytes: 66
remainFlowBytes: 87
expectedEndDate: '2024-11-28'
productCode: '85'
packageEndDate: '2026-02-01'
packageCode: '23'
packageType: 2
packageName: www
- eid: '24'
activateDate: '2024-11-20'
cardStatus: ACTIVATION_READY_NAME
currentPkgRemainBytes: 8
currentPkgUsedBytes: 40
currentPkgTotalBytes: 81
totalFlowBytes: 45
remainFlowBytes: 73
expectedEndDate: '2026-08-01'
productCode: '30'
packageEndDate: '2024-11-15'
packageCode: '14'
packageType: 2
packageName: www
totalPage: 1
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359018946-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
单云esim卡片详情
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350455e0.md
- Summary: 单云esim卡片详情
单云esim卡片详情
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/get:
post:
summary: 单云esim卡片详情
deprecated: false
description: 单云esim卡片详情
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
eid:
type: string
description: eid卡号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- eid
required:
- appkey
- timestamp
- nonce
- sign
- eid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 49890,
"sign": "{{SIGN}}",
"eid": "11111111111111111111111111111111"
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
eid:
type: string
description: eid卡号
title: eid卡号
activateDate:
type: string
title: ' 激活日期字符串'
description: ' 激活日期字符串'
cardStatus:
type: string
description: >-
ACTIVATION_READY_NAME 可激活 NON_ACTIVATED_NAME 待激活
ACTIVATED_NAME 已激活 DEACTIVATED_NAME 已停用
ACTIVATED_BASE 套餐停用卡仍可使用
title: 卡状态
currentPkgRemainBytes:
type: integer
description: 当前套餐剩余流量(Bytes)
title: 当前套餐剩余流量(Bytes)
currentPkgUsedBytes:
type: integer
description: 当前套餐已用流量(Bytes)
title: 当前套餐已用流量(Bytes)
currentPkgTotalBytes:
type: integer
description: 当前套餐流量总量单位(Bytes)
title: 当前套餐流量总量单位(Bytes)
totalFlowBytes:
type: integer
description: 卡片总流量单位Bytes
title: 卡片总流量单位Bytes
remainFlowBytes:
type: integer
description: 卡片总剩余可用流量单位Bytes
title: 卡片总剩余可用流量单位Bytes
expectedEndDate:
type: string
description: 预期服务截止日期
title: 预期服务截止日期
productCode:
type: string
description: 产品编码
title: 产品编码
packageEndDate:
type: string
description: 当前套餐到期日期
title: 当前套餐到期日期
packageCode:
type: string
description: 套餐编码
title: 套餐编码
packageType:
type: integer
description: 2 限量流量包 3 限时流量包 4 限时限速包
title: 套餐名称
packageName:
type: string
description: 套餐名称
title: 套餐名称
required:
- eid
- cardStatus
- currentPkgRemainBytes
- currentPkgUsedBytes
- currentPkgTotalBytes
- totalFlowBytes
- remainFlowBytes
- productCode
- packageCode
- packageType
- packageName
x-apifox-orders:
- eid
- activateDate
- cardStatus
- currentPkgRemainBytes
- currentPkgUsedBytes
- currentPkgTotalBytes
- totalFlowBytes
- remainFlowBytes
- expectedEndDate
- productCode
- packageEndDate
- packageCode
- packageType
- packageName
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '6'
message: consectetur Excepteur irure tempor officia
data:
eid: '68'
activateDate: '2025-02-23'
cardStatus: NON_ACTIVATED_NAME
currentPkgRemainBytes: 34
currentPkgUsedBytes: 69
currentPkgTotalBytes: 96
totalFlowBytes: 66
remainFlowBytes: 87
expectedEndDate: '2024-11-28'
productCode: '85'
packageEndDate: '2026-02-01'
packageCode: '23'
packageType: 5
packageName: ww
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350455-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询云esim卡片可购买套餐
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350544e0.md
- Summary: 查询云esim卡片可购买套餐
查询云esim卡片可购买套餐
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/pkg/list:
post:
summary: 查询云esim卡片可购买套餐
deprecated: false
description: 查询云esim卡片可购买套餐
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
eid:
type: string
description: eid卡号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- eid
required:
- appkey
- timestamp
- nonce
- sign
- eid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 49890,
"sign": "{{SIGN}}",
"eid": '111111111111111111111111111'
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
price:
type: integer
title: 套餐价格
description: 套餐结算价，单位分。结算币种是美元。
flowSizeBytes:
type: integer
title: 流量大小
description: 单位Bytes
packageCode:
type: string
title: 套餐编码
description: 套餐编码
productCode:
type: string
title: 产品编码
description: 产品编码
packageName:
type: string
title: 套餐名称
description: 套餐名称
packageType:
type: integer
title: ' 套餐类型'
description: 2 限量流量包
periodSize:
type: integer
title: 有效期大小
periodType:
type: integer
title: 有效期类型
description: 2天
zone:
type: object
properties:
img:
type: string
title: 区域图标
description: 区域图标
name:
type: string
title: 区域名称
description: 区域名称
countries:
type: array
items:
type: object
properties:
img:
type: string
title: 国家图标
description: 国家图标
name:
type: string
title: 国家名称
description: 国家名称
operators:
type: array
items:
type: object
properties:
name:
type: string
title: 运营商名称
description: 运营商名称
networkType:
type: string
title: 网络制式
description: 网络制式
x-apifox-orders:
- name
- networkType
required:
- name
- networkType
title: 支持的运营商
description: 支持的运营商
x-apifox-orders:
- img
- name
- operators
required:
- name
- operators
title: 区域中包含的国家列表
description: 区域中包含的国家列表
x-apifox-orders:
- img
- name
- countries
required:
- name
- countries
x-apifox-orders:
- price
- flowSizeBytes
- packageCode
- productCode
- packageName
- packageType
- periodSize
- periodType
- zone
required:
- price
- flowSizeBytes
- packageCode
- productCode
- packageName
- packageType
- periodSize
- periodType
- zone
x-apifox-orders:
- list
description: |
返回数据
title: ''
required:
- list
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350544-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询云esim卡片订购记录
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350624e0.md
- Summary: 查询云esim卡片订购记录
查询云esim卡片订购记录
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/pkg/record/list:
post:
summary: 查询云esim卡片订购记录
deprecated: false
description: 查询云esim卡片订购记录
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
eid:
type: string
description: eid卡号
createDateStart:
type: string
description: 订购开始时间，时间格式2024-07-15 16:28:06
createDateEnd:
type: string
description: 订购结束时间，时间格式2024-07-15 16:28:06
updateDateStart:
type: string
description: 数据更新开始时间，时间格式2024-07-15 16:28:06
updateDateEnd:
type: string
description: 数据更新结束时间，时间格式2024-07-15 16:28:06
orderIdArrStr:
type: string
description: 订单 id组字符串。例如 10004996,10004200
page:
type: integer
description: 页码。从1开始
pageSize:
type: integer
description: 页大小，默认500，最大1000
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- eid
- createDateStart
- createDateEnd
- updateDateStart
- updateDateEnd
- orderIdArrStr
- page
- pageSize
required:
- appkey
- timestamp
- nonce
- sign
- eid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 49890,
"sign": "{{SIGN}}",
"eid": "35060000000000000024000032688148",
"createDateStart": "2025-12-02 15:05:35",
"updateDateStart": "2025-12-02 15:05:35",
"page": 1,
"pageSize": 10
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
eid:
type: string
title: iccid卡号
packageCode:
type: string
title: 套餐编码
description: 套餐编码
packageType:
type: integer
title: 套餐类型
description: 2 限量流量包 3 限时流量包 4 限时限速包
packageName:
type: string
description: 套餐名称
title: 套餐名称
orderId:
type: integer
title: 将弃用
description: 内部订单号
deprecated: true
gzhPackageName:
type: string
title: 商品套餐自定义名称
description: 商品套餐自定义名称
state:
type: integer
title: 套餐使用状态
description: 0:待使用 1:使用中 2:已完成
price:
type: number
title: 订购价格
description: 订购价格,浮点数
format: float64
currency:
type: string
title: 支付币种
description: 支付币种
createDate:
type: string
title: 订购时间
description: 订购时间
startDate:
type: string
title: 套餐开始时间
description: 套餐开始时间
endDate:
type: string
title: 套餐结束时间
description: 套餐结束时间
totalActive:
type: integer
title: 激活有效时长数量
description: 激活有效时长数量
periodType:
type: integer
title: 激活有效期类型
description: 2:天
flowTotalBytes:
type: integer
title: 流量总量
description: 单位Bytes
flowRemainBytes:
type: integer
title: ' 流量剩余'
description: 单位Bytes
renew:
type: integer
title: 续订类型
description: 0 正常订单 1续订订单
isRefund:
type: integer
title: 是否退订
description: 0 未退订 1 已退订
eshopOrderId:
type: integer
description: 内部订单号
title: 内部订单号
required:
- eid
- packageType
- packageName
- packageCode
- orderId
- gzhPackageName
- state
- price
- currency
- createDate
- startDate
- endDate
- totalActive
- periodType
- flowTotalBytes
- flowRemainBytes
- renew
- isRefund
- eshopOrderId
x-apifox-orders:
- eid
- orderId
- eshopOrderId
- packageName
- packageCode
- packageType
- gzhPackageName
- state
- price
- currency
- createDate
- startDate
- endDate
- totalActive
- periodType
- flowTotalBytes
- flowRemainBytes
- renew
- isRefund
description: 卡信息详情列表集合
total:
type: integer
description: 总数
required:
- list
- total
x-apifox-orders:
- list
- total
description: |
返回数据
title: ''
required:
- code
- message
x-apifox-orders:
- code
- message
- data
example:
code: '91'
message: Excepteur aliqua cupidatat consequat mollit
data:
list:
- eid: '35'
orderId: 24
packageName: 牢欣怡
packageCode: '78'
packageType: 68
gzhPackageName: 周奕泽
state: 77
price: 45.79
currency: do nulla pariatur et
createDate: '2025-10-20'
startDate: '2026-04-01'
endDate: '2026-09-24'
totalActive: 38
periodType: 56
flowTotalBytes: 85
flowRemainBytes: 4
renew: 1
isRefund: 1
total: 30
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350624-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
账户下云esim卡片刷新套餐用量
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350639e0.md
- Summary: 云esim卡片刷新
账户下云esim卡片刷新套餐用量
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/refreshUsage:
post:
summary: 账户下云esim卡片刷新套餐用量
deprecated: false
description: 云esim卡片刷新
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
eid:
type: string
description: eid卡号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- eid
required:
- appkey
- timestamp
- nonce
- sign
- eid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 49890,
"sign": "{{SIGN}}",
"eid": '11111111111111111111111111'
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties: {}
x-apifox-orders: []
required:
- code
- message
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: success
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350639-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
账户下云esim卡片取消当前会话
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/366244994e0.md
- Summary: 云esim卡片刷新
账户下云esim卡片取消当前会话
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/cancelSession:
post:
summary: 账户下云esim卡片取消当前会话
deprecated: false
description: 云esim卡片刷新
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
eid:
type: string
description: eid卡号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- eid
required:
- appkey
- timestamp
- nonce
- sign
- eid
example: |-
{
"appkey": "{{APPKEY}}",
"timestamp": {{TIMESTAMP}},
"nonce": 49890,
"sign": "{{SIGN}}",
"eid": '11111111111111111111111111'
}
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties: {}
x-apifox-orders: []
required:
- code
- message
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: success
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-366244994-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
账户下云esim卡套餐购买
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350773e0.md
- Summary: 账户下云esim卡套餐购买
账户下云esim卡套餐购买
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/purchase:
post:
summary: 账户下云esim卡套餐购买
deprecated: false
description: 账户下云esim卡套餐购买
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
eid:
type: string
description: eid卡号
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
title: 外部交易单号
packageCode:
type: string
description: 套餐编码
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- eid
- outTradeNo
- packageCode
required:
- appkey
- timestamp
- nonce
- sign
- outTradeNo
- eid
- packageCode
example:
appkey: '{{APPKEY}}'
timestamp: null
nonce: 14299
sign: '{{SIGN}}'
eid: '8999999999999999999999999'
outTradeNo: '202511111111111111111111'
packageCode: 47wsdwd
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
outTradeNo:
type: string
title: 外部交易单号
description: API调用方传入的唯一订单号标识 最大32位
orderId:
type: string
title: 弃用
description: API下单后生成的平台订单单号
deprecated: true
eshopOrderId:
type: integer
title: 平台内部订单号
description: 平台内部订单号
x-apifox-orders:
- outTradeNo
- orderId
- eshopOrderId
description: |
返回数据
title: ''
required:
- outTradeNo
- orderId
- eshopOrderId
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: success
data:
outTradeNo: '2025000000055050505050'
eshopOrderId: 1111111
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350773-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
账户下云esim卡片订单状态
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350785e0.md
- Summary: 账户下云esim卡片订单状态
账户下云esim卡片订单状态
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/orderStatus:
post:
summary: 账户下云esim卡片订单状态
deprecated: false
description: 账户下云esim卡片订单状态
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
orderId:
type: string
description: API购买套餐后的平台订单号
deprecated: true
title: 弃用
eshopOrderId:
type: integer
description: 购买后的平台内部订单号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- orderId
- eshopOrderId
required:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: null
nonce: 26137
sign: '{{SIGN}}'
eshopOrderId: 11111111
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
status:
type: integer
description: 1表示处理中，2表示成功，3表示已退款， -1表示失败
title: 状态
eid:
type: string
title: eid
description: eid卡号
required:
- status
- eid
x-apifox-orders:
- status
- eid
description: |
返回数据
title: ''
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: success
data:
status: 2
eid: '78886666666666666786766666'
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350785-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
账户下云esim卡订单退款
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350802e0.md
- Summary: 账户下云esim卡订单退款
账户下云esim卡订单退款
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/refund:
post:
summary: 账户下云esim卡订单退款
deprecated: false
description: |-
账户下云esim卡订单退款
错误码：
45113 - 当前状态下不允许退款。订单在成功状态下才可以退款
关于订单可退金额计算规则：
1.购买后24小时内，全额退款；
2.退款金额 = min(未使用天数/总可使用天数,未使用流量/总流量)*总用户支付金额 ；
3.金额在日元外币种，最小单位为分，向下取整，日元最小单位为元，同向下取整；
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
orderId:
type: string
description: API购买套餐后的平台订单号
deprecated: true
title: 弃用
remark:
type: string
title: 退款说明
description: 退款说明
eshopOrderId:
type: integer
description: 购买后的平台内部订单号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- orderId
- eshopOrderId
- remark
required:
- appkey
- timestamp
- nonce
- sign
- remark
example:
appkey: '{{APPKEY}}'
timestamp: null
nonce: 85139
sign: '{{SIGN}}'
eshopOrderId: 11111111
remark: laborum
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
返回数据
title: ''
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: success
data: {}
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350802-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
查询账户下云esim卡片订单可退款金额
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/359350816e0.md
- Summary: 查询账户下云esim卡片订单可退款金额
查询账户下云esim卡片订单可退款金额
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/queryRefundAmount:
post:
summary: 查询账户下云esim卡片订单可退款金额
deprecated: false
description: 查询账户下云esim卡片订单可退款金额
tags:
- API接口/CloudESIM
- 国内
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
orderId:
type: string
description: API购买套餐后的平台订单号
deprecated: true
title: 弃用
eshopOrderId:
type: integer
description: 购买后的平台内部订单号
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- orderId
- eshopOrderId
required:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: null
nonce: 14267
sign: '{{SIGN}}'
eshopOrderId: 11111111
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
title: 状态码
message:
type: string
description: 成功或失败原因
title: 原因
data:
type: object
properties:
currency:
type: string
title: 币种
amount:
type: integer
description: 单位分。对于日元，单位是元
title: 金额
required:
- amount
- currency
x-apifox-orders:
- amount
- currency
description: |
返回数据
title: ''
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
message: in
data:
amount: 809
currency: USD
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-359350816-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
云 esim 转移套餐
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/439599592e0.md
- Summary: 卡片转移套餐
云 esim 转移套餐
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cloudesim/transferPkg:
post:
summary: 云 esim 转移套餐
deprecated: false
description: 卡片转移套餐
tags:
- API接口/CloudESIM
- 通用
parameters: []
requestBody:
content:
application/json:
schema:
title: ''
type: object
properties:
appkey:
type: string
default: '{{APPKEY}}'
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
minimum: 10000
maximum: 99999
description: 5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
memo:
type: string
description: 备注
oldEid:
type: string
description: 旧 EID
newEid:
type: string
description: 新 EID
oldEshopOrderId:
type: integer
description: 旧订单号。如10006889
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- oldEid
- oldEshopOrderId
- newEid
- memo
required:
- appkey
- timestamp
- nonce
- sign
- oldEshopOrderId
- oldEid
- newEid
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
oldEid: '89044045116727494800000011604016'
oldEshopOrderId: 10007065
newEid: '35060000000000000024000032693386'
memo: memo
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功，其他失败。具体原因 message 中会说明，如参数错误等
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
newPkgCode:
type: string
description: 新套餐编码
newEshopOrderId:
type: integer
description: 新订单号。如10006889
x-apifox-orders:
- newPkgCode
- newEshopOrderId
required:
- newPkgCode
- newEshopOrderId
required:
- code
- message
- data
x-apifox-orders:
- code
- message
- data
example:
code: '200'
data:
newPkgCode: BC-MBB-TM-300M-1M-BC-EBB-EN-USD-US-20250821015314F0
newEshopOrderId: 10006882
message: success
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-439599592-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
锁卡通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/442815175e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
锁卡通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 锁卡通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
在锁卡模式的IMEI池中的卡被锁时发送的通知
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: 请求的唯一标识
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: 5位随机正整数
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
event:
type: string
description: 事件名称：CloudESimLocked
eid:
type: string
description: EID
required:
- id
- timestamp
- nonce
- sign
- event
- eid
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- eid
example:
id: '13'
timestamp: 1776133394
nonce: 37722
sign: '{{SIGN}}'
event: CloudESimLocked
eid: '89044045116727494800000011603725'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties: {}
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-442815175-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
解锁通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/442848780e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
解锁通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 解锁通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
在锁卡模式的IMEI池中的卡解锁时发送的通知
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: 请求的唯一标识
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: 5位随机正整数
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
event:
type: string
description: 事件名称：CloudESimUnLock
eid:
type: string
description: EID
required:
- id
- timestamp
- nonce
- sign
- event
- eid
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- eid
example:
id: '13'
timestamp: 1776133394
nonce: 37722
sign: '{{SIGN}}'
event: CloudESimLocked
eid: '89044045116727494800000011603725'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties: {}
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-442848780-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
流量预警
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/441022831e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
流量预警
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 流量预警
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
流量余量不足的卡片预警通知
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，此通知为 CloudESimFlowAlert
alert_type:
type: integer
description: 预警类型 1:流量用量预警 不足100M 2:流量使用百分比预警 不足10% 3:周期预警 不足7天
alert_value:
type: string
description: 触发值
eid:
type: string
description: eid
x-apifox-orders:
- id
- timestamp
- nonce
- event
- sign
- eid
- alert_type
- alert_value
required:
- timestamp
- nonce
- sign
- event
- id
- eid
- alert_type
- alert_value
example:
alert_type: 1
alert_value: '100'
event: CloudESimFlowAlert
eid: '898520123456789012341111111111111'
id: CNTUlkm0pzRujPBr2tN8NNa7
nonce: 40974
sign: 88426183D4F6A984E9EA2F8BB2F7221D732F2EDF
timestamp: 1703142059
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-441022831-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
订购通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/441022833e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
订购通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 订购通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
卡新增套餐通知，通知内的多个eid新订购套餐
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型是CloudESimSubPkgList
data:
type: array
items:
type: object
properties:
packageName:
type: string
description: 套餐名称
packageCode:
type: string
description: 套餐编码
state:
type: integer
description: 套餐使用状态 0:待使用 1:使用中 2:已完成
gzhPackageName:
type: string
description: 商品套餐名称
packageType:
type: integer
description: 套餐类型，2 限量流量包 3 限时流量包 4 限时限速包
createDate:
type: string
description: 订购时间
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
fromOrderId:
type: integer
description: 转移的套餐会记录从哪个orderId转移而来
salesChannel:
type: string
description: >-
销售渠道：USER 用户自己购买，SYSTEM 保底套餐，TRANSFER 转移的套餐, PLATFORM
后台平台购买, API购买
customData:
type: string
description: 客户白名单登录的用户唯一标识，最大125位
eid:
type: string
description: eid
eshopOrderId:
type: number
description: 内部订单号
fromEid:
type: string
description: 转移的套餐会记录从哪个eid转移而来
x-apifox-orders:
- eid
- eshopOrderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
- outTradeNo
- fromEid
- fromOrderId
- salesChannel
- customData
required:
- eid
- eshopOrderId
- packageName
- packageCode
- state
- salesChannel
- createDate
- packageType
- gzhPackageName
description: 订购套餐数据
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- data
- event
example:
data: >-
[{"eid":"89423053323291099364111111","eshopOrderId":10004728,"packageName":"A-TM-50M-1天","packageCode":"A-TM-50M-1D-A-CN-TEST-2024052489FC722C","state":0,"gzhPackageName":"","createDate":"2024-05-28
09:34:47","packageType":3,"outTradeNo":"6300001983111426769635"}]
event: CloudESimSubPkgList
id: ue5Y0qNC8QQIRtUR3UgV4xzg
nonce: 40604
sign: F0D19FA6945B21C0D61BDEFD4DCC41B64B29272B
timestamp: 1716860340
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-441022833-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
套餐生效
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/441022834e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
套餐生效
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 套餐生效
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
套餐生效通知
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型是CloudESimPkgActivate
data:
type: object
properties:
packageName:
type: string
description: 套餐名称
packageCode:
type: string
description: 套餐编码
state:
type: integer
description: 套餐使用状态 0:待使用 1:使用中 2:已完成
gzhPackageName:
type: string
description: 商品套餐名称
packageType:
type: integer
description: 套餐类型，2 限量流量包 3 限时流量包 4 限时限速包
createDate:
type: string
description: 订购时间
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
fromOrderId:
type: integer
description: 转移的套餐会记录从哪个orderId转移而来
salesChannel:
type: string
description: >-
销售渠道：USER 用户自己购买，SYSTEM 保底套餐，TRANSFER 转移的套餐， PLATFORM
后台平台购买
startDate:
type: string
description: '套餐开始时间，格式: 2026-01-02 15:04:05'
endDate:
type: string
description: '套餐预期结束时间, 格式: 2026-01-02 15:04:05'
eid:
type: string
description: eid
eshopOrderId:
type: number
description: 内部订单号
fromEid:
type: string
description: 转移的套餐会记录从哪个eid转移而来
x-apifox-orders:
- eid
- eshopOrderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
- startDate
- endDate
- outTradeNo
- fromEid
- fromOrderId
- salesChannel
description: 订购套餐数据
x-apifox-refs: {}
required:
- eid
- eshopOrderId
- packageName
- packageCode
- state
- salesChannel
- createDate
- packageType
- gzhPackageName
- endDate
- startDate
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- data
- event
example:
data: >-
{"eid":"894230533232910993641111111","eshopOrderId":10004728,"packageName":"A-TM-50M-1天","packageCode":"A-TM-50M-1D-A-CN-TEST-2024052489FC722C","state":0,"gzhPackageName":"","createDate":"2024-05-28
09:34:47","packageType":3,"outTradeNo":"6300001983111426769635"}
event: CloudESimPkgActivate
id: ue5Y0qNC8QQIRtUR3UgV4xzg
nonce: 40604
sign: F0D19FA6945B21C0D61BDEFD4DCC41B64B29272B
timestamp: 1716860340
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-441022834-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
退款通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/441022836e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
退款通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 退款通知
deprecated: false
description: |
客户提供接收异步通知的地址（HTTP/HTTPS）
卡退订套餐通知，通知内的eid退订套餐
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型是CloudESimRefund
outTradeNo:
type: string
description: API调用方传入的唯一订单号标识 最大32位
orderAmount:
type: string
description: 交易金额，保留两位小数
refundAmount:
type: string
description: 退款金额，保留两位小数
eid:
type: string
description: eid
eshopOrderId:
type: integer
description: 内部订单号，见“CloudESIM查询卡片套餐订购记录”接口的响应字段
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- eid
- eshopOrderId
- outTradeNo
- orderAmount
- refundAmount
required:
- timestamp
- nonce
- sign
- id
- eid
- event
- eshopOrderId
- outTradeNo
- orderAmount
- refundAmount
example:
event: CloudESimRefund
eid: '894230533232910993111111111111111'
id: s2Vx3BfRtN1h253WeCLNRkAz
nonce: 15487
eshopOrderId: 10004728
outTradeNo: '6300001983111426769635'
sign: 86AB51FECD873FDCF4B67F7CC4B2119D8BEFEE30
timestamp: 1716860580
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-441022836-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
达量到期通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/441022837e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
达量到期通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 达量到期通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
当前套餐被停用（使用完毕、到期、退订等情况下）的通知，卡片可能存在其他待使用套餐
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型是CloudESimPkgDeactivate
data:
type: array
items:
type: object
properties:
packageName:
type: string
description: 套餐名称
packageCode:
type: string
description: 套餐编码
state:
type: integer
description: 套餐使用状态 0:待使用 1:使用中 2:已完成
gzhPackageName:
type: string
description: 商品套餐名称
packageType:
type: integer
description: 套餐类型
createDate:
type: string
description: 订购时间
outTradeNo:
type: string
description: 【仅在API订购时存在】API调用方传入的唯一订单号标识 最大32位
eid:
type: string
description: eid
eshopOrderId:
type: number
description: 内部订单号
x-apifox-orders:
- eid
- eshopOrderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
- outTradeNo
required:
- eid
- eshopOrderId
- packageName
- packageCode
- state
- gzhPackageName
- packageType
- createDate
description: 订购套餐数据
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- event
- data
example:
data: >-
[{"eid":"898520002633112901111111111","eshopOrderId":10005717,"packageName":"CNu-QT-100M-7天","packageCode":"CNU-QT-100M-7D-C-CNU-202403131FF1E56A","state":2,"gzhPackageName":"100-7","createDate":"2024-11-01
10:50:00","packageType":2}]
event: CloudESimPkgDeactivate
id: 5IdTuJONGK5FYQ5BQT2IkUwu
nonce: 55595
sign: 39DE1981FBB166835626C2201FF974452A203D50
timestamp: 1731033900
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-441022837-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
卡片断网通知
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/441022838e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
卡片断网通知
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 卡片断网通知
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
卡无法联网,没有其他套餐可用
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型，此通知为 CloudESimCardStopped
eid:
type: string
description: eid
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- eid
required:
- timestamp
- nonce
- sign
- id
- eid
- event
example:
event: CloudESimCardStopped
eid: '89852000263320811111111111'
id: 7bpDUV2P4oAGv37MBBHaAeJk
nonce: 90082
sign: 66468E1A1E5E06DFF73E8508F95C89B19EDAC3E4
timestamp: 1746050702
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-441022838-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
产品切换
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/441022843e0.md
- Summary: 客户提供接收异步通知的地址（HTTP/HTTPS）
产品切换
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/customerNotifyUrl:
post:
summary: 产品切换
deprecated: false
description: |-
客户提供接收异步通知的地址（HTTP/HTTPS）
卡切换产品的通知，通知内的多个eid的新产品编码
tags:
- API接口/CloudESIM异步通知
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: integer
description: 5位随机正整数
minimum: 10000
maximum: 99999
sign:
type: string
description: 签名串，通知参数的签名，通过它验证请求数据的合法性。
x-apifox-mock: '{{SIGN}}'
id:
type: string
description: 请求的唯一标识
event:
type: string
description: 通知的类型是CloudESimSwitchProduct
data:
type: array
items:
type: object
properties:
productCode:
type: string
description: 产品编码
eid:
type: string
description: eid
x-apifox-orders:
- eid
- productCode
required:
- eid
- productCode
description: 数据
x-apifox-orders:
- id
- timestamp
- nonce
- sign
- event
- data
required:
- timestamp
- nonce
- sign
- id
- data
- event
example:
data: >-
[{"eid":"8988308650100524999","productCode":"2ROPDOZLLB20210607140809"}]
event: CloudESimSwitchProduct
id: U0uauFzYcBgP50i09jxKaC29
nonce: 76706
sign: B3101B16CF9DCFF3F05BF5445E4F5B4036891B47
timestamp: 1710497899
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 成功接收响应SUCCESS
x-apifox-orders:
- status
required:
- status
example:
status: SUCCESS
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CloudESIM异步通知
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-441022843-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
获取池套餐列表
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122596e0.md
- Summary: 获取池套餐列表
获取池套餐列表
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/pkg/list:
post:
summary: 获取池套餐列表
deprecated: false
description: 获取池套餐列表
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
iccid:
type: string
description: 卡片的ICCID
pool_object_id:
type: integer
description: 池对象 id
x-apifox-orders:
- 01KDS0VX5168A86XQCJXK1MWDQ
- iccid
- pool_object_id
x-apifox-refs:
01KDS0VX5168A86XQCJXK1MWDQ:
$ref: '#/components/schemas/oapi_base_req%20CN'
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
iccid: '89852000261098750306'
pool_object_id: 385
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
pool_type_code:
type: string
description: 池类型代码
pool_lines:
type: integer
description: 池大小
total_active:
type: integer
description: 包的可用天数
total_data:
type: integer
description: 包的总数据，以字节为单位
x-apifox-orders:
- pool_type_code
- pool_lines
- total_active
- total_data
required:
- pool_type_code
- pool_lines
- total_active
- total_data
x-apifox-ignore-properties: []
description: 数据列表
x-apifox-orders:
- list
description: |
响应数据
required:
- list
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
x-apifox-refs: {}
required:
- code
- message
- data
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122596-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
创建池
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122597e0.md
- Summary: 创建池
创建池
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/create:
post:
summary: 创建池
deprecated: false
description: 创建池
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_type_code:
type: string
description: 池类型代码
memo:
type: string
description: 备注
x-apifox-orders:
- 01KDS1NTAW3NEYMQV92RNH4AGP
- pool_type_code
- memo
x-apifox-refs:
01KDS1NTAW3NEYMQV92RNH4AGP:
$ref: '#/components/schemas/oapi_base_req%20CN'
required:
- appkey
- timestamp
- nonce
- sign
- pool_type_code
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_type_code: INTERNATIONAL-DATAPOOL-50M-7D-C-CNU-202403126BBBFA0A
memo: memo info
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
pool_object_id:
type: integer
description: 池对象id
x-apifox-orders:
- pool_object_id
description: |
响应数据
required:
- pool_object_id
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
x-apifox-refs: {}
required:
- code
- message
- data
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122597-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
获取池列表
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122599e0.md
- Summary: 获取池列表
获取池列表
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/list:
post:
summary: 获取池列表
deprecated: false
description: 获取池列表
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id_arr:
type: string
description: pool_object_id数组。用逗号分隔
memo:
type: string
description: 备注
x-apifox-orders:
- 01KDS1SJJ28FQJ7746955TAYFX
- pool_object_id_arr
- memo
x-apifox-refs:
01KDS1SJJ28FQJ7746955TAYFX:
$ref: '#/components/schemas/oapi_base_req%20CN'
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id_arr: 380,387
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
pool_object_id:
type: integer
description: 池对象id
pool_lines:
type: integer
description: 卡槽总数
used_pool_lines:
type: integer
description: 已使用的卡槽的数量
total:
type: integer
description: 总流量，单位：bytes
remain:
type: integer
description: 剩余流量，以字节为单位
total_active:
type: integer
description: 池的总可用天数
available_days:
type: integer
description: 池的剩余可用天数
expire_timestamp:
type: integer
description: 过期时间戳。单位：秒
status:
type: integer
description: 池状态。1：待激活，2：已激活，-1：停止
create_at:
type: integer
description: 创建时间戳。单位：秒
memo:
type: string
description: 备注
x-apifox-orders:
- pool_object_id
- pool_lines
- used_pool_lines
- total
- remain
- total_active
- available_days
- expire_timestamp
- status
- create_at
- memo
required:
- pool_object_id
- pool_lines
- used_pool_lines
- total
- remain
- total_active
- available_days
- expire_timestamp
- status
- create_at
- memo
x-apifox-ignore-properties: []
x-apifox-orders:
- list
description: |
响应数据
required:
- list
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-refs: {}
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122599-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
删除空池
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122600e0.md
- Summary: 删除空池
删除空池
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/delete:
post:
summary: 删除空池
deprecated: false
description: 删除空池
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: integer
description: 池对象id
x-apifox-orders:
- 01KDS2E1RAMZSYF3JZP5MJKBBV
- pool_object_id
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
x-apifox-refs:
01KDS2E1RAMZSYF3JZP5MJKBBV:
$ref: '#/components/schemas/oapi_base_req%20CN'
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 381
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- 01KDS2F1WVP61GS7SMAH94Q5FA
x-apifox-refs:
01KDS2F1WVP61GS7SMAH94Q5FA:
$ref: '#/components/schemas/oapi_base_resp%20CN'
required:
- code
- message
- data
x-apifox-ignore-properties:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122600-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
oapi_base_resp CN:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
订购池套餐
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122601e0.md
- Summary: 订购池套餐
订购池套餐
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/sub:
post:
summary: 订购池套餐
deprecated: false
description: 订购池套餐
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: integer
description: 池对象id
pool_type_code:
type: string
description: 池类型代码
out_trade_no:
type: string
description: |+
API调用方传入的唯一订单号标识 最大32位
x-apifox-orders:
- 01KDS2HK0MA664WXEHA5V2DCZ9
- pool_object_id
- pool_type_code
- out_trade_no
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
- pool_type_code
- out_trade_no
x-apifox-refs:
01KDS2HK0MA664WXEHA5V2DCZ9:
$ref: '#/components/schemas/oapi_base_req%20CN'
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 380
pool_type_code: INTERNATIONAL-DATAPOOL-50M-7D-C-CNU-202403126BBBFA0A
out_trade_no: out_trade_no_1
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: |+
200：表示成功其他失败
42002: 唯一订单号已经存在.
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
order_no:
type: string
description: 订单号
x-apifox-orders:
- order_no
description: 响应数据
required:
- order_no
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
x-apifox-refs: {}
required:
- code
- message
- data
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122601-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
获取池套餐记录
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122602e0.md
- Summary: 获取池套餐记录
获取池套餐记录
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/record/list:
post:
summary: 获取池套餐记录
deprecated: false
description: 获取池套餐记录
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: integer
description: 池对象id
order_no_arr:
type: string
description: order_no 数组。用逗号分隔
out_trade_no_arr:
type: string
description: out_trade_no 数组。用逗号分隔
pool_type_code_arr:
type: string
description: pool_type_code 数组。用逗号分隔
status_code_arr:
type: string
description: status_code 数组。用逗号分隔
create_at_start:
type: integer
description: 创建开始时间
create_at_end:
type: integer
description: 创建结束时间
active_timestamp_start:
type: integer
description: 激活开始时间
active_timestamp_end:
type: integer
description: 激活结束时间
expire_timestamp_start:
type: integer
description: 过期开始时间
expire_timestamp_end:
type: integer
description: 过期结束时间
page:
type: integer
description: 页面。从1开始
page_size:
type: integer
description: 页面大小。最大1000
x-apifox-orders:
- 01KDS33G78WBNBMN3G59GGNM3H
- pool_object_id
- order_no_arr
- out_trade_no_arr
- pool_type_code_arr
- status_code_arr
- create_at_start
- create_at_end
- active_timestamp_start
- active_timestamp_end
- expire_timestamp_start
- expire_timestamp_end
- page
- page_size
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
- page
- page_size
x-apifox-refs:
01KDS33G78WBNBMN3G59GGNM3H:
$ref: '#/components/schemas/oapi_base_req%20CN'
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 387
page: 1
page_size: 10
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: |
200：表示成功其他失败
message:
type: string
description: |
成功或失败原因
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
pool_record_id:
type: integer
description: 池纪录 id
order_no:
type: string
description: 订单号
out_trade_no:
type: string
description: |+
API调用方传入的唯一订单号标识 最大32位
pool_type_code:
type: string
description: 池类型代码
status_code:
type: integer
description: '状态码。0: init， 1：已分配，2：待激活，3：已激活，<0：无效'
expire_timestamp:
type: integer
description: 到期时间戳。单位：秒
active_timestamp:
type: integer
description: 激活时间戳。单位：秒
total:
type: integer
description: 总流量，单位：bytes
used:
type: integer
description: 剩余流量，以字节为单位
create_at:
type: integer
description: 创建时间戳
x-apifox-orders:
- pool_record_id
- order_no
- out_trade_no
- pool_type_code
- status_code
- expire_timestamp
- active_timestamp
- total
- used
- create_at
required:
- pool_record_id
- order_no
- out_trade_no
- pool_type_code
- status_code
- expire_timestamp
- active_timestamp
- total
- used
- create_at
x-apifox-ignore-properties: []
x-apifox-orders:
- list
description: |
响应数据
required:
- list
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-refs: {}
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122602-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
取消订购池套餐
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122604e0.md
- Summary: 取消订购池套餐
取消订购池套餐
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/unsub:
post:
summary: 取消订购池套餐
deprecated: false
description: 取消订购池套餐
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: string
description: 池对象 id
order_no:
type: string
description: 订单号
out_trade_no:
type: string
description: |+
API调用方传入的唯一订单号标识 最大32位
x-apifox-orders:
- 01KDS3GX1WA2B35JBTHKCEBAR7
- pool_object_id
- order_no
- out_trade_no
x-apifox-refs:
01KDS3GX1WA2B35JBTHKCEBAR7:
$ref: '#/components/schemas/oapi_base_req%20CN'
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 380
order_no: 5db573d3-673f-4312-a197-80492c6899b4
out_trade_no: out_trade_no_3
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- 01KDS3JEQ9RGZKQJTKKB2XPPFK
x-apifox-refs:
01KDS3JEQ9RGZKQJTKKB2XPPFK:
$ref: '#/components/schemas/oapi_base_resp%20CN'
required:
- code
- message
- data
x-apifox-ignore-properties:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122604-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
oapi_base_resp CN:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
获取池可添加卡列表
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122605e0.md
- Summary: 获取池可添加卡列表
获取池可添加卡列表
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/card/can_add_list:
post:
summary: 获取池可添加卡列表
deprecated: false
description: 获取池可添加卡列表
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: integer
description: 池对象 id
iccid_arr:
type: string
description: iccid 数组。用逗号分隔
x-apifox-orders:
- 01KDS3THNG424SW7M98X4MZHF0
- pool_object_id
- iccid_arr
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
- iccid_arr
x-apifox-refs:
01KDS3THNG424SW7M98X4MZHF0:
$ref: '#/components/schemas/oapi_base_req%20CN'
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 380
iccid_arr: 89852000261098750306,89852000261098028000,89852000261098028026
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- iccid
required:
- iccid
x-apifox-ignore-properties: []
description: 列表
x-apifox-orders:
- list
description: 响应数据
required:
- list
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-refs: {}
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122605-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
池添加卡
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122606e0.md
- Summary: 池添加卡
池添加卡
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/card/add:
post:
summary: 池添加卡
deprecated: false
description: 池添加卡
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: integer
description: 池对象 id
iccid_arr:
type: string
description: |+
iccid 数组。用逗号分隔
x-apifox-orders:
- 01KDS43VKP8HNY1YZR3CDTQHM8
- pool_object_id
- iccid_arr
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
- iccid_arr
x-apifox-refs:
01KDS43VKP8HNY1YZR3CDTQHM8:
$ref: '#/components/schemas/oapi_base_req%20CN'
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 380
iccid_arr: 89852000261098750306,89852000261098028000,89852000261098028026
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- 01KDS44W59D4AGAR8J9N6J47G7
x-apifox-refs:
01KDS44W59D4AGAR8J9N6J47G7:
$ref: '#/components/schemas/oapi_base_resp%20CN'
required:
- code
- message
- data
x-apifox-ignore-properties:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122606-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
oapi_base_resp CN:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
获取池卡列表
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122607e0.md
- Summary: 获取池卡列表
获取池卡列表
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/card/list:
post:
summary: 获取池卡列表
deprecated: false
description: 获取池卡列表
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: integer
description: 池对象 id
x-apifox-orders:
- 01KDS47Y0CPA3XB23YP0VVXKTE
- pool_object_id
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
x-apifox-refs:
01KDS47Y0CPA3XB23YP0VVXKTE:
$ref: '#/components/schemas/oapi_base_req%20CN'
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 380
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
iccid:
type: string
description: 卡片的ICCID
create_at:
type: integer
description: 创建时间戳
x-apifox-orders:
- iccid
- create_at
required:
- iccid
- create_at
x-apifox-ignore-properties: []
x-apifox-orders:
- list
description: |
响应数据
required:
- list
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-refs: {}
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122607-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
池移除卡
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122608e0.md
- Summary: 池移除卡
池移除卡
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/card/remove:
post:
summary: 池移除卡
deprecated: false
description: 池移除卡
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
pool_object_id:
type: integer
description: 池对象 id
iccid_arr:
type: string
description: |+
iccid 数组。用逗号分隔
x-apifox-orders:
- 01KDS4B417K2RHFRSG6FC3YV8D
- pool_object_id
- iccid_arr
required:
- appkey
- timestamp
- nonce
- sign
- pool_object_id
- iccid_arr
x-apifox-refs:
01KDS4B417K2RHFRSG6FC3YV8D:
$ref: '#/components/schemas/oapi_base_req%20CN'
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
pool_object_id: 380
iccid_arr: 89852000261098028000,89852000261098028026
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- 01KDS4BVDRT7B8MAMHBHSTSBJZ
x-apifox-refs:
01KDS4BVDRT7B8MAMHBHSTSBJZ:
$ref: '#/components/schemas/oapi_base_resp%20CN'
required:
- code
- message
- data
x-apifox-ignore-properties:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122608-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
oapi_base_resp CN:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: 成功或失败原因
data:
type: object
properties: {}
x-apifox-orders: []
description: |
响应数据
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
通过 iccid 获取池
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/399122609e0.md
- Summary: 通过 iccid 获取池
通过 iccid 获取池
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/pool/by_iccid:
post:
summary: 通过 iccid 获取池
deprecated: false
description: 通过 iccid 获取池
tags:
- API接口/池
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
iccid:
type: string
description: 卡片的ICCID
x-apifox-orders:
- 01KDS4CMR5J1R45VJSR949ENRV
- iccid
x-apifox-refs:
01KDS4CMR5J1R45VJSR949ENRV:
$ref: '#/components/schemas/oapi_base_req%20CN'
required:
- appkey
- timestamp
- nonce
- sign
- iccid
x-apifox-ignore-properties:
- appkey
- timestamp
- nonce
- sign
example:
appkey: '{{APPKEY}}'
timestamp: '{{TIMESTAMP}}'
nonce: 95977
sign: '{{SIGN}}'
iccid: '89852000263338791785'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 200：表示成功其他失败
message:
type: string
description: |
成功或失败原因
data:
type: object
properties:
pool_object_id:
type: integer
description: 池对象 id。如果iccid不属于任何池，则返回0，否则pool_object_id>0
x-apifox-orders:
- pool_object_id
description: 响应数据
required:
- pool_object_id
x-apifox-ignore-properties: []
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
x-apifox-refs: {}
x-apifox-ignore-properties: []
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/池
x-apifox-status: developing
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-399122609-run
components:
schemas:
oapi_base_req CN:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
timestamp:
type: integer
description: 当前时间戳，10位数字
nonce:
type: integer
description: |
5位随机正整数
sign:
type: string
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
required:
- appkey
- timestamp
- nonce
- sign
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []
ICCID流量查询接口
- URL: https://s.apifox.cn/166a9792-0aaf-4d87-a524-2279ef4788bd/409777084e0.md
- Summary: 该接口实际是查询运营商推送的cdr文件，非实时流量
ICCID流量查询接口
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v3/cdr/traffic/query:
post:
summary: ICCID流量查询接口
deprecated: false
description: 该接口实际是查询运营商推送的cdr文件，非实时流量
tags:
- API接口/CDR
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appkey:
type: string
description: >-
appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
appkey/secret 后，才能进行应用的开发。
title: appkey
x-apifox-mock: '{{APPKEY}}'
timestamp:
type: integer
description: 当前时间戳，10位数字
x-apifox-mock: '{{TIMESTAMP}}'
nonce:
type: string
sign:
type: string
x-apifox-mock: '{{SIGN}}'
description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
dateType:
type: string
description: 时间类型，按天：daily，按月：monthly
title: 时间类型
iccids:
type: string
description: iccid卡号，用英文逗号隔开
startDate:
type: string
description: 按天查询时必填，开始时间，格式yyyy-MM-dd
endDate:
type: string
description: 按天查询时必填，结束时间，格式yyyy-MM-dd
month:
type: string
description: 按月查询时必填，月份，格式yyyy-MM，如2026-01
x-apifox-orders:
- appkey
- timestamp
- nonce
- sign
- dateType
- iccids
- startDate
- endDate
- month
required:
- appkey
- timestamp
- nonce
- sign
- dateType
- iccids
- startDate
- endDate
- month
example: "{\r\n \"appkey\": \"{{APPKEY}}\",\r\n \"timestamp\": {{TIMESTAMP}},\r\n \"nonce\": 49890,\r\n \"sign\": \"{{SIGN}}\",\r\n\r\n \"dateType\":\"daily\",\r\n \"iccids\":\"8932042000009789134,8932042000001778197\",\r\n \"startDate\":\"2026-01-01\",\r\n \"endDate\":\"2026-01-02\"\r\n}"
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
data:
type: array
items:
type: object
properties:
iccid:
type: string
description: 有流量的iccid
traffic:
type: string
description: 流量，单位Byte
x-apifox-orders:
- iccid
- traffic
required:
- iccid
- traffic
x-apifox-orders:
- code
- message
- data
required:
- code
- message
- data
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: API接口/CDR
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-409777084-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://oapi.eiotclub.com
description: 生产环境
security: []