メインコンテンツまでスキップ

リッチメニュー配信

旧式のリッチメニュー（2024/12/23 廃止）

本 API は旧式のリッチメニューのみで利用可能です。
現在こちらの API は後方互換性のために残されているものであり、新規にご利用いただけません。

定義済みのリッチメニューに送信先を登録し、リッチメニューを配信します。

POST /v2/richmenus/:richmenu_id/recipients
定義済みのリッチメニュー

こちらの API を利用する前に メッセージマネージャー で「リッチメニュー」のコンテンツ部分を作成していただく必要があります。

リクエストパラメータ​

Path Parameters​

パラメータ名型必須説明
richmenu_idstring○定義済みのリッチメニューを一意に表す識別子 (リッチメニュー ID)

Body Parameters​

パラメータ名型必須説明
providerstring○プロバイダ名。現在は line のみ対応
recipientobject○Recipient オブジェクトを指定

Recipient オブジェクト​

パラメータ名型必須説明
typestring○values のタイプを指定する。socialplus_uid, primary_key, line_uid のいずれかを指定
valuesarray of string○リッチメニューの配信対象とする ソーシャルPLUS ID（socialplus_uid）, お客様サービス側ユーザID（primary_key）, LINE ユーザID ( line_uid )の文字列配列。重複は除去される。最大 10 万件、各文字列は 255 文字以内である必要がある

エラーコード​

エラー定義 参照。

レスポンス​

成功時にステータスコード 202 Accepted と空の JSON オブジェクトを返します。

{}

実行サンプル​

curl -L -X POST https://msgapi.socialplus.jp/v2/richmenus/{richmenu_id}/recipients \
  -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",
      "values": ["user_123"]
    }
  }'
タグ:
に最終更新