BoltzMessenger Admin が提供する API
BoltzMesssenger Admin (管理画面) が提供する、他システム連携用の API を解説します。
メッセージ送信API [POST /messages/send.json]
BoltzMessenger 管理画面でメッセージを入力して送信する API です。
Request (application/x-www-form-urlencoded)
| key | 型 | 内容 |
|---|---|---|
| title | string | タイトル (通知として表示されるメッセージ |
| description | string | 内容 (アプリ内で表示される全文) |
| channel_id | int | 送信先チャンネル ID (0 を指定すると全端末配信) |
| additions.[x] | string | 追加データ (通知ペイロードに x というキーでデータが追加されます) |
Response (application/json)
| key | 型 | 内容 |
|---|---|---|
| success | bool | データを登録できたかどうか (true:成功 / false:失敗) |
| messages | array[string] | メッセージがある場合は、その内容。 |
| newId | int | 通知 ID |