Phiên bản API Đồ thị

Thông báo

Một tin nhắn riêng lẻ trong cuộc trò chuyện qua tin nhắn trên Messenger hoặc Instagram.

Để lấy ID tin nhắn, hãy sử dụng điểm cuối cuộc trò chuyện hoặc Webhooks để truy xuất từng ID tin nhắn.

Đọc

Trình khám phá API Đồ thị
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
}];

Yêu cầu

LoạiMô tả

Xét duyệt ứng dụng

Bắt buộc để truy cập dữ liệu đối với những người không có vai trò trên ứng dụng của bạn, chẳng hạn như nhà phát triển, người dùng thử hoặc quản trị viên

Tính năng

Không áp dụng

Mã truy cập

Mã truy cập Trang từ người có thể thực hiện tác vụ MODERATE hoặc MESSAGING trên Trang được truy vấn hoặc liên kết đến Tài khoản công việc trên Instagram.

Quyền

Quyền pages_messagingpages_manage_metadata

Bạn cũng cần có quyền instagram_basicinstagram_manage_messaging để Nhắn tin trên Instagram

Giới hạn

Để Nhắn tin trên Instagram

  • Chỉ Tài khoản công việc trên Instagram có Trang Facebook được liên kết mới có thể truy cập điểm cuối này.
  • Khi truy vấn điểm cuối này, tất cả tin nhắn trong cuộc trò chuyện này sẽ được trả về. Tuy nhiên, bạn chỉ có thể truy vấn dữ liệu của 20 tin nhắn gần đây nhất trong cuộc trò chuyện đó. Nếu một tin nhắn không nằm trong 20 tin nhắn gần đây nhất, hệ thống sẽ trả về lỗi cho biết tin nhắn này đã bị xóa.

Trường

Nếu không có dữ liệu, trường sẽ không được trả về trong phản hồi JSON.

TênMô tả

attachments.data

mảng
file_url
generic_template
id
image_data
name
video_data

File phương tiện - chẳng hạn như hình ảnh, video hoặc URL CDN của file - được đính kèm vào tin nhắn.


URL của file đính kèm vào tin nhắn

URL của hình ảnh đính kèm vào tin nhắn. Có thể thêm các cặp khóa:giá trị sau:

  • cta: đối tượng có title, type, url
  • medial_url: chuỗi, URL của hình ảnh
  • subtitle: chuỗi, tính bằng pixel
  • title: chuỗi,

ID của file đính kèm

URL của hình ảnh đính kèm vào tin nhắn. Có thể thêm các cặp khóa:giá trị sau:

  • animated_gif_preview_url: chuỗi, URL của bản xem trước file GIF
  • animated_gif_url: chuỗi, URL của file GIF
  • height: số nguyên, tính bằng pixel
  • max_height: số nguyên, tính bằng pixel
  • max_width: số nguyên, tính bằng pixel
  • preview_url: chuỗi, Bản xem trước của URL
  • render_as_sticker: boolean, true hoặc false
  • url: chuỗi, URL của hình ảnh
  • width: số nguyên, tính bằng pixel

Tên file đính kèm

URL của video đính kèm vào tin nhắn

created_time

ngày giờ

Thời gian tạo tin nhắn

from

đối tượng
id
email
name
username

Thông tin về người gửi tin nhắn. Có thể là người, Trang hoặc Tài khoản công việc trên Instagram

ID có thể là ID trong Instagram hoặc ID trong Trang của một người hoặc ID Trang hay ID Tài khoản công việc trên Instagram của doanh nghiệp.

Email của một người hoặc Trang Facebook. Chỉ nhắn tin trên Trang

Tên của một người hoặc Trang Facebook. Chỉ nhắn tin trên Trang

Tên người dùng của một người trên Instagram hoặc tài khoản Công việc trên Instagram của bạn. Chỉ nhắn tin trên Instagram

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

id

chuỗi

ID của tin nhắn

is_unsupported

boolean

Chỉ được trả về khi true; tin nhắn chứa nội dung không được hỗ trợ.

message

chuỗi

Nội dung văn bản của tin nhắn. Nếu tin nhắn không chứa văn bản, trường này sẽ trống.

reactions

mảng
data mảng
reaction biểu tượng cảm xúc
users mảng đối tượng
id

username

Các loại cảm xúc mà tin nhắn đã nhận cùng với danh sách tất cả những người đã bày tỏ cảm xúc bằng loại cảm xúc đó.

Mảng đối tượng cảm xúc

Loại biểu tượng cảm xúc

Danh sách những người đã bày tỏ cảm xúc với tin nhắn


ID có thể là ID trong Instagram của một người hoặc ID Tài khoản công việc trên Instagram của doanh nghiệp.

Tên người dùng của một người trên Instagram hoặc Tài khoản công việc trên Instagram. Chỉ nhắn tin trên Instagram

"reactions":
  {
    "reaction": "❤️",
    "users" : [
      {
        "username": "INSTAGRAM-USERNAME",
        "id": "ID", 
      },
    ]
  }

shares

mảng

Lượt chia sẻ file phương tiện - chẳng hạn như bài viết hoặc mẫu sản phẩm - được bao gồm trong tin nhắn. Lưu ý rằng đối với đối tượng chia sẻ, bạn cũng cần yêu cầu trường phụ để truy xuất dữ liệu.

"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

mảng

Liên kết và ID của tin. Chỉ hỗ trợ tính năng nhắc đến và trả lời.

StoryReply: 
{
    "link": "CDN-URL",
    "id": "STORY-ID"
}

StoryMention: 
{
    "link": "CDN-URL",
    "id": "STORY-ID"
}

tags

đối tượng

Một mảng data chứa tên dành cho thẻ biểu thị thư mục tin nhắn và nguồn tin nhắn.

  • Đối với Trang Facebook, name có thể là inbox, read, source:chat,

to

đối tượng
data mảng
id
email
name
username

Thông tin về người nhận tin nhắn



ID có thể là ID trong Instagram hoặc ID trong Trang của một người hoặc ID Trang hay ID tài khoản Công việc trên Instagram của doanh nghiệp.

Email của một người hoặc Trang Facebook. Chỉ nhắn tin trên Trang

Tên của một người hoặc Trang Facebook. Chỉ nhắn tin trên Trang

Tên người dùng của một người trên Instagram hoặc tài khoản Công việc trên Instagram của bạn. Chỉ nhắn tin trên Instagram

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

Cạnh

Tên Mô tả

/attachments

File đính kèm tin nhắn.

/shares

Mục được chia sẻ, bao gồm cả liên kết, ảnh, video, nhãn dán và sản phẩm.

Tạo

Bạn không thể thực hiện thao tác đó trên điểm cuối này.

Cập nhật

Bạn không thể thực hiện thao tác đó trên điểm cuối này.

Xóa

Bạn không thể thực hiện thao tác đó trên điểm cuối này.