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

通知メッセージの送信

指定したユーザーに通知メッセージ（テンプレート）を送信します。

POST /v2/notifications/v2/templates/:template_identifier/push
認証プロバイダー／通知メッセージ利用申請

通知メッセージを利用するためには、認証プロバイダー になったうえで LINEヤフー社への申請が必要となります。

また、こちらの API をご利用になるには通知メッセージのテンプレートが必要ですので、サポート窓口までご相談ください。

リクエストパラメータ​

Path Parameters​

パラメータ名型必須説明
template_identifierstring○通知メッセージのテンプレートを一意に表す識別子

Body Parameters​

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

Recipient オブジェクト​

パラメータ名型必須説明
typestring○電話番号の値のタイプ。phone_number または hashed_phone_number（詳細は後述）
valuestring○電話番号の値（詳細は後述）

phone_number 指定​

value には E.164 形式に則ったハイフン無しの電話番号を指定します。

例
+818000001234
JSON での記載例
"recipient": {
  "type": "phone_number",
  "value": "+818000001234"
}

hashed_phone_number 指定​

value には、LINE 通知メッセージの仕様 に則ってハッシュ化した電話番号を指定します。

例
d41e0ad70dddfeb68f149ad6fc61574b9c5780ab7bcb2fba5517771ffbb2409c
JSON での記載例
"recipient": {
  "type": "hashed_phone_number",
  "value": "d41e0ad70dddfeb68f149ad6fc61574b9c5780ab7bcb2fba5517771ffbb2409c"
}

Contents オブジェクト​

パラメータ名型必須説明
emphasized_itemobjectメッセージで強調するItem オブジェクトを指定
itemsobject (key-value pair)メッセージに含めるItem オブジェクトをキーと値のペアで指定(複数指定可能)
buttonsobject (key-value pair)メッセージに含めるButton オブジェクトをキーと値のペアで指定(複数指定可能)

Item オブジェクト​

パラメータ名型必須説明
{item key}string○アイテムの値として表示する文字列
{item key} の値はテンプレートの定義によって異なります

テンプレートに登録されている値のみ使用可能です。 テンプレートへ登録可能な値は LINE通知 メッセージ（テンプレート） の アイテム （LINE 公式ドキュメント） を参照ください。

Button オブジェクト​

パラメータ名型必須説明
{button key}string○ボタンを押すと遷移する URL
{button key} の値はテンプレートの定義によって異なります

テンプレートに登録されている値のみ使用可能です。 テンプレートへ登録可能な値は LINE 通知メッセージ（テンプレート） の ボタン （LINE 公式ドキュメント） を参照ください。

エラーコード​

エラー定義 参照。

レスポンス​

成功時はステータスコード 201 Created とともに、配信結果を確認するためのリソースの JSON を返します。

パラメータ名型Nullable説明
resultobject配信結果。Result オブジェクト 参照

Result オブジェクト​

NameTypeNullableDescription
identifierstring配信結果を一意に表す識別子
request_statusstring配信要求結果
requested_atinteger配信要求日時 (UNIX time)
line_api_responsejsonLINE 通知メッセージ API から返されたレスポンス
status_detail_urlstring通知メッセージの配信状況を確認する URL

レスポンス例​

$.result.request_status状態
deliveredLINE へ配信リクエスト済み
failedLINE への配信リクエストに失敗
レスポンス例
{
  "result": {
    "identifier": "c2ac26294ad9cd9c6aa5",
    "request_status": "delivered",
    "requested_at": 1650591346,
    "line_api_response": {},
    "status_detail_url": "https://msgapi.socialplus.jp/v2/notifications/v2/templates/d6f4883cc6b6fa6ffdfa/deliveries/c2ac26294ad9cd9c6aa5"
  }
}

実行サンプル​

curl -L -X POST 'https://msgapi.socialplus.jp/v2/notifications/v2/templates/{template identifier}/push' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: {API Key}' \
  --data-raw '{
      "recipient": {
          "type": "phone_number",
          "value": "{E.164 Phone Number}"
      },
      "contents": {
          "emphasized_item": {
              "number_003_ja": "{申込番号}"
          },
          "items": {
              "name_011_ja": "{企業名}",
              "content_001_ja": "{申込内容}",
              "date_033_ja": "{申込日}"
          },
          "buttons": {
              "check_details_ja": "{詳細を確認する URL}",
              "contact_ja": "{お問い合わせ URL}"
          }
      }
  }'
タグ:
に最終更新