API でテキストメッセージを送信する

できること

お客様サーバー側にあるLINEユーザーのLINE UIDを指定して、テキスト形式のメッセージを送信します。

‍

API リファレンス

指定したユーザーにテキストメッセージを送信します。

POST /v2/messages/text

‍

メッセージ送信は非同期で行われるため、この API ではメッセージ送信リクエストが正常に受け付けられたかどうかを返します。正常に受け付けた場合はメッセージ毎に一意のメッセージ ID を採番して返します。

メッセージ送信が完了しているかどうかは、そのメッセージ ID を用いて メッセージ送信結果の取得 API で確認する必要があります。そのための URL をレスポンスに含めて返します。

‍

リクエストパラメータ

Body Parameters

‍

「任意の集計単位のユニット名」について

大文字と小文字は区別されます。たとえば promotion_a と promotion_A は別のユニットとして扱われます。
最大文字数は 30 文字、使用可能な文字の種類は半角英数字およびアンダースコア（ _ ）です。

‍

Recipient オブジェクト

‍

Content オブジェクト

‍

絵文字の扱い

絵文字には以下のような種類があります。本 API で利用可能な絵文字は「Unicode 絵文字」のみ です。

・Unicode 絵文字

広く一般的に利用可能な絵文字です。文字数は絵文字 1 つが 1 文字としてカウントされます。
参考: Unicode Emoji Chart（Unicode Consortium）

‍

・LINE 独自の Unicode 絵文字

旧来 LINE が提供していた LINE 独自の絵文字です。 2022 年 3 月 31 日に廃止されているため現在は利用できません。

‍

・LINE 絵文字

現在 LINE 公式で利用可能な LINE 独自の絵文字ですが、指定形式が異なるため、本 API ではご利用いただくことができません。
参考: LINE 絵文字リスト（LINE Developers ドキュメント）

‍

‍

エラーコード

エラー定義 参照。

‍

レスポンス

成功時はステータスコード 202 Accepted とともに、作成した Message リソースの JSON を返します。

‍

レスポンス例

{
  "identifier": "ff67bae17fe8496e75b84da304515b8410854064",
  "status_url": "https://msgapi.socialplus.jp/v2/messages/ff67bae17fe8496e75b84da304515b8410854064"
}

‍

‍

実行サンプル

curl -L -X POST https://msgapi.socialplus.jp/v2/messages/text \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: {API Key}' \
  --data-raw '{
    "provider": "line",
    "recipient": {
      "type": "primary_key",
      "value": "user_123"
    },
    "content": {
      "type": "text",
      "text": "Hello, world"
    },
    "reservation_time": 1625616732,
    "custom_aggregation_unit": "promotion_a"
  }'

‍