API docs by Redocly

Soshosai Messaging API (1.1.0)

Download OpenAPI specification:Download

蒼翔祭の来場者向けにLINEメッセージを送信するための外部向けAPI仕様です。APIキーによる認証が必要です。

Messages

メッセージ送信関連API

ブロードキャスト送信意図の生成

全ユーザーへのブロードキャスト送信(targetType: 'all')を実行するために必要な、有効期間の短い(60秒)確認トークンを発行します。

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Broadcast intent created. Use this token within 60 seconds.",
  • "broadcastConfirmationToken": "string"
}

メッセージ送信

指定されたターゲットに対してLINEメッセージを送信します。この処理は同期的であり、LINE Messaging APIへのリクエストが完了するまで応答を返しません。

Authorizations:
ApiKeyAuth
header Parameters
Idempotency-Key
required
string <uuid>

リクエストの冪等性を担保するためのユニークなキー。UUID形式が必須です。

Request Body schema: application/json
targetType
required
string
Enum: "all" "enteredOnly" "unenteredOnly" "individual" "group"

メッセージの送信対象を指定します。

guestIds
Array of strings

targetTypeがindividualの場合に必須となる、送信先のGuestIdの配列です。

groupId
string

targetTypeがgroupの場合に必須となる、対象のGroupIdです。グループの代表者1名にのみ送信されます。

message
required
object

LINE Messaging APIに準拠したメッセージオブジェクト。

broadcastConfirmationToken
string

targetTypeがallの場合に必須となる、/messages/broadcast-intentエンドポイントで取得した確認トークン。

Responses

Request samples

Content type
application/json
{
  • "targetType": "all",
  • "guestIds": [
    ],
  • "groupId": "string",
  • "message": {
    },
  • "broadcastConfirmationToken": "string"
}

Response samples

Content type
application/json
{
  • "message": "Message sent successfully.",
  • "historyId": "string",
  • "sentCount": 0
}