圖形 API 版本

訊息

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

若要取得訊息編號,請使用對話端點Webhooks 擷取個別訊息編號。

讀取

圖形 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 專業帳號之粉絲專頁執行 MODERATEMESSAGING 任務的用戶。

權限

pages_messagingpages_manage_metadata 權限

instagram_basicinstagram_manage_messaging 權限也是 Instagram 傳訊的必要權限

限制

Instagram 傳訊

  • 只有與 Facebook 粉絲專頁連結的 Instagram 專業帳號可以存取此端點。
  • 查詢此端點時會傳回這個對話中的所有訊息。不過,您只能查詢對話中最近 20 則訊息的資料。若您所查詢的訊息非最近 20 則訊息,會傳回錯誤,註明已刪除該則訊息。

欄位

若欄位不含任何資料,JSON 回應就不會傳回該欄位。

名稱說明

attachments.data

陣列
file_url
generic_template
id
image_data
name
video_data

附加於訊息中的影音素材,例如圖像、影片或檔案 CDN 網址。


訊息附加檔案的網址

訊息附加圖像的網址。可包含下列「索引鍵:值」組合:

  • cta:包含 titletypeurl 的物件
  • 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 可以是 inboxreadsource:chat

to

物件
data 陣列
id
email
name
username

訊息擷取者的相關資訊



此編號可以是用戶的 Instagram 範圍編號或粉絲專頁範圍編號,或是您的商家 Instagram 專業帳號編號。

用戶或 Facebook 粉絲專頁的電子郵件。粉絲專頁傳訊限定

用戶或 Facebook 粉絲專頁的名稱。粉絲專頁傳訊限定

Instagram 用戶或您 Instagram 專業帳號的用戶名稱。Instagram 傳訊限定

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

關係連線

名稱 說明

/attachments

訊息附加的檔案。

/shares

分享的項目,包含連結、相片、影片、貼圖和產品。

建立

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

更新

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

刪除

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