open API 客户访问

客户访问open API 接口

公共信息

⚠️加密方式：

代码加密方式详细请看SDK，谢谢！

地址：https://dmc.tibiot.com/ApplicationCenter

池接口 （version v1）

池详情

基本信息

Path： /api/v1/pool/detail

Method： GET

接口描述：

Pool Details

请求参数

Query

参数名称	是否必须	示例	备注
poolCode	是		池编码 / Pool Code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		返回数据
├─ upoolCode	string	非必须		流量池code
├─ upoolName	string	非必须		流量池名称
├─ enUpoolName	string	非必须		流量池名称（英语）
├─ poolType	number	非必须		流量池类型：1. 用户池，2.使用量计费池，3.统付池
├─ useFlow	integer	非必须		使用量 KB
├─ totalFlow	number	非必须		总流量 单位 KB/ Total traffic Unit: KB 对于 poolType = 2 的 ，此字段不做使用
├─ billingCycle	number	非必须		周期类型: 计费周期（1.月度套餐 3.季度 6.半年 12.一年）
├─ totalCard	integer	非必须		总卡数
├─ rawAddTime	string	非必须		创建时间
├─ bindCardStatusCount	object []	非必须		卡状态统计	item 类型: object
├─ cardStatus	number	非必须		卡状态 {@link CardStatusEnum}
├─ total	integer	非必须		总量
├─ packageInfo	object	非必须		企业资费包信息
├─ flowPackageType	number	非必须		资费包类型：1普通套餐流量包；2按量计费流量包；3统付池
├─ clientFlowPackageName	string	非必须		客户端流量包名称，用于展示给客户
├─ channelName	string	非必须		通道名称
├─ epiConfigs	object []	非必须		当前资费包的配置列表	item 类型: object
├─ epiConfigCode	string	非必须		企业资费包配置业务code
├─ epiCode	string	非必须		企业资费包code
├─ standardCharge	number	非必须		企业资费包(实际服务费，单位元)
├─ realFenStandardCharge	number	非必须		企业资费包(实际资费，单位分)
├─ epiConfigType	number	非必须		企业资费包类型：1.购卡，2.续费，3.叠加
├─ unit	string	非必须		单位 KB MB GB TB（使用量计费池）
├─ startTime	string	非必须		池开始时间（统付池）	mock: @datetime("yyyy-MM-dd")
├─ endTime	string	非必须		池结束时间（统付池）	mock: @datetime("yyyy-MM-dd")
├─ upoolStatus	number	非必须		池状态 1. 有效 2.无效 Pool status 1. Valid 2. Invalid {@link PoolStatusEnum}
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码

获取池历史12月的某一月的使用量

基本信息

Path： /api/v1/pool/getPoolMonthUsage

Method： GET

接口描述：

Gets the pool history usage for a month in December

请求参数

Query

参数名称	是否必须	示例	备注
poolCode	是		池编码/Pool Code
queryMonth	是		查询月份，示例：2025-04 / Query month, example: 2025-04

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		返回数据
├─ month	string	非必须		日期 格式 yyyy-MM
├─ poolCode	string	非必须		池编码
├─ useFlowKb	number	非必须		使用量，单位KB
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码

获取池近30天的某一天的使用量

基本信息

Path： /api/v1/pool/getPoolDayUsage

Method： GET

接口描述：

Gets the pool usage for a day in the last 30 days

请求参数

Query

参数名称	是否必须	示例	备注
poolCode	是		池编码/Pool Code
queryDay	否		查询日期，示例：2025-04-01 / Query date, example: 2025-04-01

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		返回数据
├─ day	string	非必须		日期 格式 yyyy-MM-dd
├─ poolCode	string	非必须		池编码
├─ useFlowKb	number	非必须		使用量，单位KB
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码

操作批次查询（version v1）

检查卡操操作完成状态

基本信息

Path： /api/v1/operation/batch/query/status

Method： GET

接口描述：

Check the status of the card operation

请求参数

Query

参数名称	是否必须	示例	备注
batchCode	是		批次编码/Batch coding

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		返回数据	item 类型: object
├─ operationCardStatus	number	非必须		操作状态， 1. 未执行 2. 执行中 3. 执行完成 4. 执行失败
├─ iccid	string	非必须		iccid
├─ msisdn	string	非必须		msisdn 卡号
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码

卡接口（version v1）

卡详情

基本信息

Path： /api/v1/card/detail

Method： GET

接口描述：

Card Details

请求参数

Query

参数名称	是否必须	示例	备注
iccid	是		iccid

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		返回数据
├─ iccid	string	非必须		ICCID
├─ imei	string	非必须		IMEI
├─ imsi	string	非必须		IMSI
├─ msisdn	string	非必须		卡号/Card number
├─ totalFlow	integer	非必须		总流量 单位 KB/ Total traffic Unit: KB 对于 billingMethod = 2 的 ，此字段不做使用
├─ useMonthFlow	number	非必须		卡当月使用流量 单位 KB/ Monthly usage Unit: KB
├─ useFlow	number	非必须		卡周期使用流量 单位 KB/ Card cycle usage traffic Unit: KB
├─ billingMethod	number	非必须		计费方法: 0未设置，1.套餐计费，2.使用量计费，3.统付池计费
├─ apn	string	非必须		apn
├─ cardStatus	number	非必须		卡状态（1.沉默期 4.停机 8.正常 12.测试期 16.停机保号） Card status (1. Silent period 4. Shutdown 8. Normal 12. Test period 16. Shutdown protection number)	枚举: (byte) 1,(byte) 8,(byte) 4,(byte) 12,(byte) 16,(byte) 18,(byte) 99 枚举备注: (byte) 1 :SILENT_PERIOD (byte) 8 :NORMAL (byte) 4 :SHUT_DOWN (byte) 12 :TEST_PERIOD (byte) 16 :SHUTDOWN_PROTECTION (byte) 18 :LIQUIDATION (byte) 99 :ABNORMAL mock: @pick(["(byte) 1","(byte) 8","(byte) 4","(byte) 12","(byte) 16","(byte) 18","(byte) 99"])
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码

操作卡网络

基本信息

Path： /api/v1/card/operation/network

Method： POST

接口描述：

Operation card network， The maximum number of iccid entries is 10

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
iccids	string []	必须		ICCID数组, 最多传入10个 ICCID Array, A maximum of 10 can be passed in	item 类型: string
├─		非必须
switchOn	boolean	必须		是否开通 true 开通， false 关闭 Enable true Enable false Disable

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		返回数据
├─ successCount	integer	非必须	0	切换检查成功数量
├─ batchCode	string	非必须		批次编码
├─ errorInfo	object []	非必须		切换检查失败详细列表	item 类型: object
├─ infoMessage	string	非必须		详细信息
├─ iccid	string	非必须		ICCID
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码

获取卡历史12月的某一月的使用量

基本信息

Path： /api/v1/card/getCardMonthUsage

Method： GET

接口描述：

Get card history usage for a month in December

请求参数

Query

参数名称	是否必须	示例	备注
iccid	是		ICCID
queryMonth	是		查询月份，示例: 2025-04 Query month, example: 2025-04

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		返回数据
├─ month	string	非必须		日期，格式：yyyy-MM
├─ iccid	string	非必须		ICCID
├─ useFlowKb	number	非必须		使用量，单位KB
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码

获取卡近30天的某一天的使用量

基本信息

Path： /api/v1/card/getCardDayUsage

Method： GET

接口描述：

Get the card usage for a day in the last 30 days

请求参数

Query

参数名称	是否必须	示例	备注
iccid	是		ICCID
queryDay	是		查询日期，示例: 2025-04-01 Query date, example: 2025-04-01

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		返回数据
├─ day	string	非必须		日期 格式 yyyy-MM-dd
├─ iccid	string	非必须		ICCID
├─ useFlowKb	number	非必须		使用量，单位KB
message	string	非必须		消息提示
traceId	string	非必须		链路编码
code	integer	非必须		返回状态码