Graph API
Graph API 版本

訊息

Messenger 或 Instagram 訊息對話中的個別訊息。

如要獲取訊息編號，請使用對話端點或 Webhooks 檢索個別訊息編號。

讀取

Graph API 測試工具
GET /v21.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 網址。


訊息附加檔案的網址

訊息附加圖片的網址。可包含以下鍵值組合：

  • cta：帶有 title、type、url 的物件
  • medial_url：字串，圖片網址
  • subtitle：字串，以像素為單位
  • title：字串，

附件編號

訊息附加圖片的網址。可包含以下鍵值組合：

  • animated_gif_preview_url：字串，GIF 預覽網址
  • animated_gif_url：字串，GIF 網址
  • height：整數，以像素為單位
  • max_height：整數，以像素為單位
  • max_width：整數，以像素為單位
  • preview_url：字串，網址預覽
  • render_as_sticker：布林值，true 或 false
  • url：字串，圖片網址
  • width：整數，以像素為單位

附件名稱

訊息附加影片的網址

created_time

日期時間

訊息的建立時間

from

物件
id
email
name
username

有關訊息傳送者的資訊。可以是用戶、專頁或 Instagram 專業帳戶

此編號可以是用戶的 Instagram 範圍編號或專頁範圍編號，也可以是您企業的專頁編號或 Instagram 專業帳戶編號。

用戶或 Facebook 專頁的電郵地址。僅適用於專頁訊息往來

用戶或 Facebook 專頁的名稱。僅適用於專頁訊息往來

Instagram 用戶或您 Instagram 專業帳戶的用戶名稱。僅適用於 Instagram 訊息往來

"from": {
    "username": "INSTAGRAM-USERNAME",
    "id": "ID"
  }

id

字串

訊息編號

is_unsupported

布林值

只會在 true 時傳回，表示訊息包含不支援的內容。

message

字串

訊息的文字內容。如果訊息中沒有文字，則此欄位為空。

reactions

陣列
data 陣列
reaction 表情符號
users 物件陣列
id

username

訊息所接收到的心情類型，以及表達該心情類型的用戶之完整名單。

心情物件陣列

心情表情符號類型

對訊息表達心情的用戶之名單


此編號可以是 Instagram 用戶的 Instagram 範圍編號，也可以是您企業的 Instagram 專業帳戶編號。

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

陣列

限時動態的連結和編號。僅支援提及和回覆功能。

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

有關訊息接收者的資訊



此編號可以是用戶的 Instagram 範圍編號或專頁範圍編號，也可以是您企業的專頁編號或 Instagram 專業帳戶編號。

用戶或 Facebook 專頁的電郵地址。僅適用於專頁訊息往來

用戶或 Facebook 專頁的名稱。僅適用於專頁訊息往來

Instagram 用戶或您 Instagram 專業帳戶的用戶名稱。僅適用於 Instagram 訊息往來

"to": {
  "data": [
    { 
      "username": "INSTAGRAM-USERNAME", 
      "id": "ID" 
    }
  ]
}

關係連線

名稱 說明

/attachments

附加至訊息的檔案。

/shares

分享的物件，包括連結、相片、影片、貼圖和商品。

建立

您無法在此端點上執行此操作。

更新

您無法在此端點上執行此操作。

刪除

您無法在此端點上執行此操作。