BoltzMessenger Gateway が提供する API

BoltzMessenger Gateway (通知サーバー) が提供する API について解説します。標準でインストールした場合、以下の URL は TCP/13070 の / 以下に配置されます。Gateway の API は通常、 BoltzMessenger Admin(管理画面)から呼び出されるものです。直接呼び出す必要はほとんどの場合ありません。

概要

レスポンスの内容

BoltzMessenger Gateway は各種 API 実行後、以下のレスポンスを返します。

成功した場合

データがある API の場合は 200 OK、データがない API の場合は 204 No Content の HTTP レスポンスを返します。

失敗した場合

処理に失敗した場合は、HTTPステータスコードを 400 以上とし、以下の JSON を含む HTTP レスポンスを返します。

1{
2  "reason": "<エラー理由>"
3}

key	型	内容
reason	string	エラーメッセージ

リクエスト発行 API [POST /requests]

新しいリクエストが有効になったことを BoltzMessenger Gatewayへ通知し、指定された ID の通知を発行します。

リクエスト受付が完了した時点でレスポンスを返します。(レスポンスが返った時点ではまだ通知は送信されていない場合があります)

Request (application/json)

送信対象となる通知 ID の配列を指定します。

1[1,2,3]

Response

成功時は 204 No Content を返し、失敗時はエラーレスポンスを返します。

目次