图谱 API
图谱 API 版

消息

Messenger 或 Instagram 消息对话中的一条消息。

如要获取消息编号，请使用对话端点或 Webhooks 检索单条消息的编号。

读取

图谱 API 探索工具
GET /v19.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：字符串，动图的预览网址
  • animated_gif_url：字符串，动图的网址
  • 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

分享的内容，包括链接、照片、视频、贴图和商品。

创建

您无法在此端点上执行此操作。

更新

您无法在此端点上执行此操作。

删除

您无法在此端点上执行此操作。