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 を指定すると全端末配信)
segments.[key].[operator] string 送信先セグメント ([key] という値に対して設定)
additions.[x] string 追加データ (通知ペイロードに x というキーでデータが追加されます)
bandwidth int 配信速度制御 秒間辺りの配信数

※ 送信先の指定について

  • channel_id と segments はどちらか一方を指定します。両方指定した場合はエラーとなります。
  • segments.[key].[operator] は複数指定可能です。
  • 日付型に指定できる値は秒のみです。

operator に指定できる演算子の一覧

operator 内容
equal 等しい (すべての型)
lowerThan 以前(日付型) / 以下(数値型・カウンタ型)
lower 未満(数値型・カウンタ型)
greaterThan 以降(日付型) / 以上 (数値型・カウンタ型)
greater より大きい(数値型・カウンタ型)

Response (application/json)

key 内容
success bool データを登録できたかどうか (true:成功 / false:失敗)
messages array[string] メッセージがある場合は、その内容。
newId int 通知 ID

ご不明な点はありませんか?

機能の詳細、導入のご検討、お見積もり依頼などは、お気軽にお問い合わせください。
担当者から追ってご連絡いたします。

お問い合わせはこちら

記事へ戻る