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

概要

Messaging API はソーシャルPLUS 内からの LINE メッセージに関するあらゆる処理を行います。LINE 公式 API をラッピングするような形で提供されるものです。

警告

Messaging API のご利用前に、あらかじめ メッセージマネージャー についてご確認ください。

ご利用には 機能導入サーバ側の要件 を満たす必要があります。

Schema​

API は RESTful に設計されます。また、エンドポイントは以下のアドレスの下に定義します。

https://msgapi.socialplus.jp/{Version}/{Resources}

すべての API アクセスには必ず SSL 通信を用いてください。 リクエスト、レスポンスには文字コード UTF-8 の JSON 形式を用います。

Version​

現行バージョンは v2 です。

API キー​

メッセージマネージャー から、サービスごとに「API キー」を取得して HTTP Request Header に指定します。

X-API-Key: {API キー}
リクエスト例
GET /v2/messages/ff67bae17fe8496e75b84da304515b8410854064 HTTP/1.1
Host: example.com
Accept: application/json
X-API-Key: mm-54d7503feb24aca8796c49b7...
API キーの取り扱いにご注意ください

API キーが流出した場合は、メッセージマネージャー から破棄・再発行が可能です。

共通のデータ定義​

ユーザの特定​

メッセージやリッチメッセージの配信先となるユーザは「ソーシャルPLUS ID」、または事前に紐付けた「お客様サービス側ユーザID」での指定が必要です。

パラメータ名ユーザの特定方法
socialplus_uidソーシャルPLUS ID
primary_keyお客様サービス側ユーザID（紐付け済みの場合に利用可能）
認証対象のソーシャルPLUS ID の取得

ログインしたユーザの「ソーシャルPLUS ID」または紐付け済みの「お客様サービス側ユーザID」を取得するには 認証対象のソーシャルPLUS ID の取得 (authenticated_user) API を利用します。

お客様サービス側ユーザID の紐付け

「お客様サービス側ユーザID」の紐付けには お客様サービス側ユーザID の紐付け (map) API を利用します。

ソーシャルPLUS ID の指定（互換性対応）

旧仕様では「ソーシャルPLUS ID」指定のパラメータ名として identifier を用いていました。

このパラメータ名は旧仕様の互換性維持のため今後も利用可能ですが、新規に実装される場合には socialplus_uid の利用を推奨 いたします。

二値型​

JSON 形式（RFC 7159）の真偽値として指定してください。

Timestamp​

タイムスタンプは RFC 3339（ISO 8601）形式で扱います。

YYYY-MM-DDTHH:MM:SSZ

Response​

Response Header​

必ず以下の Content Type を含みます。

Content-Type: application/json; charset=utf-8

Response Body​

処理成功時のレスポンスボディは各リソースの API によって異なります。

処理失敗時には errors オブジェクトを返します。詳しくは Messaging API エラー定義 を参照してください。

// HTTP Status Code: 400
{
  "errors": [
    {
      "path": "__global__",
      "code": "invalid_parameter"
    }
  ]
}
に最終更新