Message Event

メンバーが送信したメッセージが含まれた Callback イベントのオブジェクト。
Message Callback イベントが有効な場合に送信されます。
各メッセージタイプに該当するオブジェクトが message プロパティに含まれます。

メッセージタイプ	内容	クライアントバージョン
text	テキスト	全バージョンで対応
location	位置情報	全バージョンで対応
sticker	スタンプ	v2.3 以降で対応
image	画像	v2.3 以降で対応
file	ファイル	v2.9 以降で対応
audio	音声	v4.1 以降で対応
video	ビデオ	v4.1 以降で対応

テキスト {#message-event-text}

メンバーが送信したテキストが含まれるオブジェクトです。

注意
content.postback の項目は、message action の postback または 「利用開始」 ボタンに対応するパラメータです。postback action の応答は Postback Event を参照してください。

Request - type "text" {#message-event-text-request}

パラメータ	タイプ	説明
type	string	"message" required
source	object	メッセージ送信者の情報 required
source.userId	string	送信元メンバーアカウント required
source.channelId	string	送信したトークルーム ID 1:1 トークルームではトークルーム ID は送信されません。
source.domainId	number	送信したドメイン ID required
issuedTime	string	メッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ) required
content	object	メッセージの内容 required
content.type	string	"text" required
content.text	string	メッセージ本文 required
content.postback	string	postback メッセージ (ボタンなどのテンプレート利用時)

Request Example - type "text" {#message-event-text-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-BotId: 123

{  "type": "message",  "source": {    "userId": "c72af563-0f21-4736-11e4-045237113344",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime": "2022-01-04T05:16:05.716Z",  "content": {    "type": "text",    "text": "hello"  }}

位置情報 {#message-event-location}

メンバーが送信した位置情報が含まれたオブジェクトです。

Request - type "location" {#message-event-location-request}

パラメータ	タイプ	説明
type	string	"message" required
source	object	メッセージ送信者の情報 required
source.userId	string	送信元メンバーアカウント required
source.channelId	string	送信したトークルーム ID 1:1 トークルームではトークルーム ID は送信されません。
source.domainId	number	送信したドメイン ID required
issuedTime	string	メッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ) required
content	object	メッセージの内容 required
content.type	string	"location" required
content.address	string	メンバーが送信した位置情報(住所) required
content.latitude	number	メンバーが送信した位置情報(緯度) required
content.longitude	number	メンバーが送信した位置情報(経度) required

Request Example - type "location" {#message-event-location-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-botId: 123

{  "type": "message",  "source": {    "userId": "c72af563-0f21-4736-11e4-045237113344",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime": "2022-01-04T05:16:05.716Z",  "content": {    "type": "location",    "address": "〒150-0002 東京都渋谷区渋谷２丁目１５−１",    "latitude": 35.6587750,    "longitude": 139.7052230  }}

スタンプ {#message-event-sticker}

メンバーが送信したスタンプ情報が含まれたオブジェクトです。
LINE WORKS スタンプのパッケージ ID とスタンプ ID はスタンプリストを参照してください。

Request - type "sticker" {#message-event-sticker-request}

パラメータ	タイプ	説明
type	string	"message" required
source	object	メッセージ送信者の情報 required
source.userId	string	送信元メンバーアカウント required
source.channelId	string	送信したトークルーム ID 1:1 トークルームではトークルーム ID は送信されません。
source.domainId	number	送信したドメイン ID required
issuedTime	string	メッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ) required
content	object	メッセージの内容 required
content.type	string	"sticker" required
content.packageId	string	パッケージ ID required
content.stickerId	string	スタンプ ID required

Request Example - type "sticker" {#message-event-sticker-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-botId: 123

{  "type": "message",  "source": {    "userId": "c72af563-0f21-4736-11e4-045237113344",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime": "2022-01-04T05:16:05.716Z",  "content": {    "type": "sticker",    "packageId": "1",    "stickerId": "1"  }}

画像 {#message-event-image}

メンバーが送信した画像データが含まれたオブジェクトです。
リソース ID を使った画像データのダウンロード方法についてはコンテンツダウンロードを参照してください。

Request - type "image" {#message-event-image-request}

パラメータ	タイプ	説明
type	string	"message" required
source	object	メッセージ送信者の情報 required
source.userId	string	送信元メンバーアカウント required
source.channelId	string	送信したトークルーム ID 1:1 トークルームではトークルーム ID は送信されません。
source.domainId	number	送信したドメイン ID required
issuedTime	string	メッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ) required
content	object	メッセージの内容 required
content.type	string	"image" required
content.fileId	string	リソース ID required

Request Example - type "image" {#message-event-image-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-botId: 123

{  "type": "message",  "source": {    "userId": "c72af563-0f21-4736-11e4-045237113344",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime": "2022-01-04T05:16:05.716Z",  "content": {    "type": "image",    "fileId": "WAAAQPwBexX2HnseNvvM9Zyhvp2kIRF3Ul7L7/aMVti8="  }}

ファイル {#message-event-file}

メンバーが送信したファイルが含まれたオブジェクトです。
リソース ID を使ったファイルデータのダウンロード方法についてはコンテンツダウンロードを参照してください。

Request - type "file" {#message-event-file-request}

パラメータ	タイプ	説明
type	string	"message" required
source	object	メッセージ送信者の情報 required
source.userId	string	送信元メンバーアカウント required
source.channelId	string	送信したトークルーム ID 1:1 トークルームではトークルーム ID は送信されません。
source.domainId	number	送信したドメイン ID required
issuedTime	string	メッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ) required
content	object	メッセージの内容 required
content.type	string	"file" required
content.fileId	string	リソース ID required

Request Example - type "file" {#message-event-file-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-botId: 123

{  "type": "message",  "source": {    "userId": "c72af563-0f21-4736-11e4-045237113344",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime": "2022-01-04T05:16:05.716Z",  "content": {    "type": "file",    "fileId": "WAAAQPwBexX2HnseNvvM9Zyhvp2kIRF3Ul7L7/aMVti8="  }}

音声 {#message-event-audio}

メンバーが送信した音声データが含まれたオブジェクトです。
リソース ID を使った音声データのダウンロード方法についてはコンテンツダウンロードを参照してください。

Request - type "audio" {#message-event-audio-request}

パラメータ	タイプ	説明
type	string	"message" required
source	object	メッセージ送信者の情報 required
source.userId	string	送信元メンバーアカウント required
source.channelId	string	送信したトークルーム ID 1:1 トークルームではトークルーム ID は送信されません。
source.domainId	number	送信したドメイン ID required
issuedTime	string	メッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ) required
content	object	メッセージの内容 required
content.type	string	"audio" required
content.fileId	string	リソース ID required

Request Example - type "audio" {#message-event-audio-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-botId: 123

{  "type": "message",  "source": {    "userId": "c72af563-0f21-4736-11e4-045237113344",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime": "2022-01-04T05:16:05.716Z",  "content": {    "type": "audio",    "fileId": "WAAAQPwBexX2HnseNvvM9Zyhvp2kIRF3Ul7L7/aMVti8="  }}

ビデオ {#message-event-video}

メンバーが送信したビデオデータが含まれたオブジェクトです。
リソース ID を使ったビデオデータのダウンロード方法についてはコンテンツダウンロードを参照してください。

Request - type "video" {#message-event-video-request}

パラメータ	タイプ	説明
type	string	"message" required
source	object	メッセージ送信者の情報 required
source.userId	string	送信元メンバーアカウント required
source.channelId	string	送信したトークルーム ID 1:1 トークルームではトークルーム ID は送信されません。
source.domainId	number	送信したドメイン ID required
issuedTime	string	メッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ) required
content	object	メッセージの内容 required
content.type	string	"video" required
content.fileId	string	リソース ID required

Request Example - type "video" {#message-event-video-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-botId: 123

{  "type": "message",  "source": {    "userId": "c72af563-0f21-4736-11e4-045237113344",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime": "2022-01-04T05:16:05.716Z",  "content": {    "type": "video",    "fileId": "WAAAQPwBexX2HnseNvvM9Zyhvp2kIRF3Ul7L7/aMVti8="  }}

Response (トーク Bot のメッセージ受信サーバー -> メッセージサーバー) {#message-event-response}

Callback を受け取ったボットサーバーから LINE WORKS のメッセージングサーバーへのレスポンスは、ステータスコード 200 で返してください。
Callback で送信された HTTP リクエストは、送信に失敗しても再送されません。

Response {#message-event-response-example}

HTTP/1.1 200 OKContent-Type: application/jsonServer: YOUR_SERVER_HOST_NAMEContent-Length: 0