VmsPush API 接入文檔

歡迎使用 VmsPush 企業級推送服務。本接口支持 APNs .p8 協議，提供高並發、低延遲的推送能力。

基礎 URL: https://push.vmshell.com/push/api/v1

認證方式: 在 HTTP Header 中攜帶 X-API-Key

1. 設備注冊

在 App 端獲取 Device Token 後，調用此接口將 Token 與用戶關聯。

POST /device/register
Content-Type: application/json
X-API-Key: YOUR_API_KEY

{
  "device_token": "64_CHAR_DEVICE_TOKEN",
  "user_id": "user_123",
  "device_model": "iPhone 15 Pro",
  "os_version": "17.4"
}

2. 單個推送

向指定設備發送即時推送。

POST /push/single
X-API-Key: YOUR_API_KEY

{
  "device_token": "64_CHAR_DEVICE_TOKEN",
  "title": "您有一條新消息",
  "body": "這是推送的內容詳情",
  "badge": 1,
  "sound": "default",
  "custom_data": {
    "url": "myapp://news/123"
  }
}

3. 批量推送

向多個設備發送相同內容，最大支持 1000 個 Token。

POST /push/batch
X-API-Key: YOUR_API_KEY

{
  "tokens": ["TOKEN1", "TOKEN2", "..."],
  "title": "全體通知",
  "body": "系統將於今晚維護",
  "priority": "high"
}