グラフAPIバージョン

メッセージ

MessengerまたはInstagramメッセージのスレッドに含まれる個々のメッセージ。

メッセージIDを取得するには、スレッドエンドポイントまたはWebhooksを使うことにより、個別のメッセージIDを取得します。

読み取り

GET /v24.0/{message-id} HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
try {
 // Returns a `Facebook\FacebookResponse` object
 $response = $fb->get(
 '/{message-id}',
 '{access-token}'
 );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
 echo 'Graph returned an error: ' . $e->getMessage();
 exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
 echo 'Facebook SDK returned an error: ' . $e->getMessage();
 exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
 "/{message-id}",
 function (response) {
 if (response && !response.error) {
 /* handle the result */
 }
 }
);

/* make the API call */
new GraphRequest(
 AccessToken.getCurrentAccessToken(),
 "/{message-id}",
 null,
 HttpMethod.GET,
 new GraphRequest.Callback() {
 public void onCompleted(GraphResponse response) {
 /* handle the result */
 }
 }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
 initWithGraphPath:@"/{message-id}"
 parameters:params
 HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
 id result,
 NSError *error) {
 // Handle the result
}];

要件

型	説明
アプリレビュー	該当アプリ上で開発者、テスト担当者、管理者などの役割を付与されていない人に関するデータにアクセスする必要があります
機能	該当なし
トークン	クエリ対象のページまたはInstagramプロアカウントにリンクされているページ上で`MODERATE`または`MESSAGING`のタスクを実行できるユーザーの、ページアクセストークン。
アクセス許可	`pages_messaging`アクセス許可と`pages_manage_metadata`アクセス許可 Instagramメッセージでは、`instagram_basic`と`instagram_manage_messaging`のアクセス許可も必要です

制限

Instagramメッセージの場合

このエンドポイントにアクセスできるのは、Facebookページにリンク済みのInstagramプロアカウントだけです。
このエンドポイントに対するクエリでは、このスレッドのすべてのメッセージが返されます。ただし、クエリできる対象は、スレッド内の最新20件のメッセージデータだけです。メッセージが最新20件の中に含まれていない場合、当該メッセージが削除されたことを示すエラーが返されます。

フィールド

フィールドにデータがない場合、JSON応答で返されません。

名前	説明
`attachments.data` 配列 `file_url` `generic_template` `id` `image_data` `name` `video_data`	メッセージに添付されている画像、動画、ファイルなどのメディアCDN URL。メッセージに添付されているファイルのURL メッセージに添付されている画像のURL。次のkey:valueペアを含めることができます。 `cta`: `title`、`type`、`url`を指定したオブジェクト `medial_url`: 文字列、画像のURL `subtitle`: 文字列、ピクセル数 `title`: 文字列添付のID メッセージに添付されている画像のURL。次のkey:valueペアを含めることができます。 `animated_gif_preview_url`: 文字列、GIFのプレビュー用URL `animated_gif_url`: 文字列、GIFのURL `height`: 整数、ピクセル数 `max_height`: 整数、ピクセル数 `max_width`: 整数、ピクセル数 `preview_url`: 文字列、URLのプレビュー `render_as_sticker`: bool、trueまたはfalse `url`: 文字列、画像のURL `width`: 整数、ピクセル数添付の名前メッセージに添付されている動画のURL
`created_time` datetime	メッセージが作成された日時
`from` オブジェクト `id` `email` `name` `username`	メッセージ送信者についての情報。ユーザー、ページ、またはInstagramプロアカウント IDは、ユーザーのInstagramスコープIDまたはページスコープID、ページID、ビジネスのInstagramプロアカウントIDのいずれかです。ユーザーまたはFacebookページのメールアドレス。ページのメッセージのみユーザーまたはFacebookページの名前。ページのメッセージのみ Instagram上でのユーザーのユーザー名、またはビジネスのInstagramプロアカウントのユーザー名。Instagramのメッセージのみ "from": { "username": "INSTAGRAM-USERNAME", "id": "ID" }
`id` 文字列	メッセージのID
`is_unsupported` boolean	`true`の場合、つまりメッセージにサポート対象外コンテンツが含まれている場合にのみ返されます。
`message` 文字列	メッセージのテキストコンテンツ。メッセージにテキストがない場合、これは空になります。
`reactions` 配列 `data` 配列 `reaction` 絵文字 `users` オブジェクトの配列 `id` `username`	メッセージが受け取ったリアクションのタイプと、そのリアクションタイプでリアクションした全ユーザーのリスト。リアクションオブジェクトの配列リアクション絵文字タイプメッセージに対してリアクションしたユーザーのリスト IDは、ユーザーのInstagramスコープID、またはビジネスのInstagramプロアカウントIDのいずれかです。 Instagram利用者のユーザー名、またはビジネスのInstagramプロアカウントのユーザー名。Instagramのメッセージのみ "reactions": { "reaction": "❤️", "users" : [ { "username": "INSTAGRAM-USERNAME", "id": "ID", }, ] }
`shares` 配列	メッセージに含まれているメディアシェア(投稿や商品テンプレートなど)。シェアオブジェクトの場合、データを取り出すためにサブフィールドをリクエストする必要があることに注意してください。 "shares": { "data": [{ "template": { "payload":{ "product": { "elements":{ //Can contain multiple products if applicable "data": [ { "id" : "PRODUCT-ID", // 0 if business can't see this product "retailer_id": "ID-ASSIGNED-BY-THE-RETAILER", "image_url" : "IMAGE-URL", "name" : "PRODUCT-NAME", "price" : "10ドル" }, ], } } } } }] }
`story` 配列	ストーリーのリンクとID。サポートされているのはメンションと返信だけです。 StoryReply: { "link": "CDN-URL", "id": "STORY-ID" } StoryMention: { "link": "CDN-URL", "id": "STORY-ID" }
`tags` オブジェクト	メッセージフォルダとメッセージのソースを示すタグの名前を含む`data`配列。 Facebookページの場合、`name`は、`inbox`、`read`、`source:chat`のいずれかです。
`to` オブジェクト `data` 配列 `id` `email` `name` `username`	メッセージ受信者についての情報 IDは、ユーザーのInstagramスコープIDまたはページスコープID、ページID、ビジネスのInstagramプロアカウントIDのいずれかです。ユーザーまたはFacebookページのメールアドレス。ページのメッセージのみユーザーまたはFacebookページの名前。ページのメッセージのみ Instagram上でのユーザーのユーザー名、またはビジネスのInstagramプロアカウントのユーザー名。Instagramのメッセージのみ "to": { "data": [ { "username": "INSTAGRAM-USERNAME", "id": "ID" } ] }

エッジ

名前	説明
`/attachments`	メッセージに添付されたファイル。
`/shares`	シェアされたアイテム(リンク、写真、動画、スタンプ、商品など)。

作成

このエンドポイントではこの操作を実行できません。

更新

このエンドポイントではこの操作を実行できません。

削除

このエンドポイントではこの操作を実行できません。