查询SIM卡日用量 - 探鸽开放平台API文档

请求参数

Query 参数

iccid

string

物联网卡号

必需

示例值:

8986062355007337313

day

string

可选

查询日期，只能查询今天之前且90天内,单位byte，默认前一天

示例值:

2024-04-06

Header 参数

X-Tg-App-Id

string

必需

开发者帐号的APPID

默认值:

Accept-Language

string

必需

请求端的本地语言（zh-cn, zh-tw, en-us, ja, ko, vi, es, pt, ru, tr, de, it, fr, pl, th, ar）

默认值:

示例值:

zh-cnzh-twen-usjakoviesptrutrdeitfrplthar

Authorization

string

必需

服务端接口（API For Server）时传入签名计算后的字符串。客户端接口（API For Client）传入用户登陆态数据access_token。两者不要混用。

默认值:

X-Tg-Signed-Headers

string

必需

参与计算签名的header字段。POST等body有值时请求传入content-length;content-type;x-tg-app-id;x-tg-date，GET等body无值时请求传入x-tg-app-id;x-tg-date

默认值:

x-tg-app-id;x-tg-date

示例值:

content-length;content-type;x-tg-app-id;x-tg-datex-tg-app-id;x-tg-date

X-Tg-Date

string

必需

当前请求的UTC+0时间（注意时区，不是本地时区）

默认值:

20060102T150405Z

X-Tg-Content-Sha256

string

必需

将BODY数据进行SHA256计算后的值

X-Tg-Algorithm

string

必需

目前服务端接口使用的签名算法的版本号和哈希算法

默认值:

TGV1-HMAC-SHA256

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/v2/sim/server/usage_day?iccid=8986062355007337313&day=2024-04-06' \
--header 'X-Tg-App-Id;' \
--header 'Accept-Language;' \
--header 'Authorization;' \
--header 'X-Tg-Signed-Headers;' \
--header 'X-Tg-Date;' \
--header 'X-Tg-Content-Sha256;' \
--header 'X-Tg-Algorithm;'

返回响应

🟢200成功

application/json

Body

code

integer

错误码，非 200 表示失败

必需

data

object

必需

2025-04-06

integer

日期

必需

msg

string

错误描述

必需

ok

integer

必需

requestid

string

必需

status

string

必需

示例

{
    "code": 200,
    "data": {
        "2025-04-06": 10000
    },
    "msg": "ok",
    "ok": 1,
    "requestid": "",
    "status": "ok"
}

🟠400错误

🟠401请登录

🟠403禁止访问

🟠404资源不存在

🔴500服务器内部错误