跳到正文

消息用量 GET ​

获取你当前套餐的每日上限下今日的消息用量。

端点 ​

GET https://api.pocketalert.app/v1/messages/usage

身份验证 ​

必填

在请求中包含以下任一请求头:

  • Token: <your-api-key> — 从 API 密钥获取
  • Authorization: Bearer <jwt-token> — 来自登录

请求 ​

请求示例 ​

bash
curl -X GET "https://api.pocketalert.app/v1/messages/usage" \
  -H "Token: your-api-key"
javascript
const response = await fetch('https://api.pocketalert.app/v1/messages/usage', {
  headers: { 'Token': 'your-api-key' }
});
const usage = await response.json();
python
import requests

response = requests.get(
    'https://api.pocketalert.app/v1/messages/usage',
    headers={'Token': 'your-api-key'}
)
print(response.json())
php
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/messages/usage');

return $response->json();

响应 ​

成功响应 ​

200 OK

返回今日的用量。日期以 UTC 时间为准。

字段类型说明
usedinteger今日已接收的消息数
limitinteger | null每日允许的消息数,不限量套餐为 null
unlimitedboolean当套餐没有每日上限时为 true
rejectedinteger今日因达到上限而被拒绝的请求数
resets_atstring下次重置时间,UTC 时间 00:00,RFC3339 格式
json
{
  "used": 42,
  "limit": 50,
  "unlimited": false,
  "rejected": 0,
  "resets_at": "2026-09-22T00:00:00Z"
}

不限量套餐的响应:

json
{
  "used": 1280,
  "limit": null,
  "unlimited": true,
  "rejected": 0,
  "resets_at": "2026-09-22T00:00:00Z"
}

错误响应 ​

状态码说明
401未授权 — 令牌无效或缺失

使用场景

在发送大量告警之前,先将 used 与 limit 进行比较;也可以在你自己的控制台中显示剩余配额。每次创建消息的响应中都会以 X-PA-Daily-* 请求头返回相同的数据。

Pocket Alert 文档