Graph API
Versão Graph API

Mensagem

Uma mensagem específica em uma conversa no Messenger ou nas Mensagens do Instagram.

Para obter o ID de mensagens individuais, use o ponto de extremidade de conversas ou Webhooks.

Leitura

Explorador da Graph 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
}];

Requisitos

TipoDescrição

Análise do app da Meta

Obrigatório para acessar os dados de pessoas sem função no app (como desenvolvedor, testador ou administrador).

Recursos

Não aplicável

Tokens

Um token de acesso da Página solicitado por uma pessoa que pode executar a tarefa MODERATE ou MESSAGING na Página consultada ou vinculada à conta profissional do Instagram.

Permissões

As permissões pages_messaging e pages_manage_metadata.

As permissões instagram_basic e instagram_manage_messaging também são obrigatórias para Mensagens do Instagram.

Limitações

De Mensagens do Instagram

  • Somente contas profissionais do Instagram com uma Página do Facebook têm acesso a esse ponto de extremidade.
  • Ao consultar esse ponto de extremidade, todas as mensagens da conversa serão retornadas. Entretanto, será possível consultar dados apenas das 20 mensagens mais recentes na conversa. Se a mensagem consultada estiver além desse limite, será retornado um erro declarando que a mensagem foi excluída.

Campos

Se um campo não tiver dados, ele não será retornado na resposta JSON.

NomeDescrição

attachments.data

Matriz
file_url
generic_template
id
image_data
name
video_data

A mídia (por exemplo, uma imagem, um vídeo ou uma URL do CDN de arquivo) anexada à mensagem.


A URL do arquivo anexado à mensagem.

A URL da imagem anexada à mensagem. Pode incluir os seguintes pares de chave-valor:

  • cta: objeto com title, type e url
  • medial_url: string, URL da imagem
  • subtitle: string, em pixels
  • title: string

O ID do anexo.

A URL da imagem anexada à mensagem. Pode incluir os seguintes pares de chave-valor:

  • animated_gif_preview_url: string, URL para prévia do GIF
  • animated_gif_url: string, URL do GIF
  • height: número inteiro, em pixels
  • max_height: número inteiro, em pixels
  • max_width: número inteiro, em pixels
  • preview_url: string, prévia da URL
  • render_as_sticker: booliano, true ou false
  • url: string, URL da imagem
  • width: número inteiro, em pixels

O nome do anexo.

A URL do vídeo anexado à mensagem.

created_time

DateTime

A hora em que a mensagem foi criada.

from

Objeto
id
email
name
username

As informações de quem enviou a mensagem. Pode ser uma pessoa, Página ou conta profissional do Instagram.

O ID no escopo do Instagram ou ID no escopo da Página de uma pessoa, a identificação da Página ou identificação da conta profissional da empresa.

O email da pessoa ou da Página do Facebook. Somente mensagens de Páginas.

O nome da pessoa ou da Página do Facebook. Somente mensagens de Páginas.

O nome de usuário de uma pessoa no Instagram ou da sua conta profissional. Somente Mensagens do Instagram.

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

id

String

O ID de uma mensagem.

is_unsupported

Booliano

Só é retornado quando true. Uma mensagem que inclui conteúdo não compatível.

message

String

O conteúdo de texto da mensagem. Se não houver texto na mensagem, o campo ficará vazio.

reactions

Matriz
data Matriz
reaction Emoji
users Matriz de objetos
id

username

Os tipos de reações que a mensagem recebeu, com a lista das pessoas que enviaram cada reação.

Uma matriz de objetos de reação.

O tipo de emoji de reação.

Uma lista das pessoas que reagiram à mensagem.


O ID no escopo do Instagram para uma pessoa no Instagram ou para a identificação da conta profissional da empresa.

O nome de usuário de uma pessoa no Instagram ou da sua conta profissional. Somente Mensagens do Instagram.

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

shares

Matriz

Os compartilhamentos de mídia (por exemplo, uma publicação ou um modelo de produto) incluídos na mensagem. Para recuperar os dados do objeto de compartilhamento, também é preciso solicitar os subcampos.

"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

Matriz

O link e o ID de um story. Compatível somente com menções e respostas.

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

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

tags

Objeto

Uma matriz de data com nomes de tags indicando a pasta e a fonte da mensagem.

  • Para Páginas do Facebook, name pode ser inbox, read ou source:chat.

to

Objeto
data Matriz
id
email
name
username

As informações de quem recebeu a mensagem.



O ID no escopo do Instagram ou ID no escopo da Página de uma pessoa, a identificação da Página ou identificação da conta profissional da empresa.

O email da pessoa ou da Página do Facebook. Somente mensagens de Páginas.

O nome da pessoa ou da Página do Facebook. Somente mensagens de Páginas.

O nome de usuário de uma pessoa no Instagram ou da sua conta profissional. Somente Mensagens do Instagram.

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

Bordas

Nome Descrição

/attachments

Arquivos anexados a uma mensagem.

/shares

Itens compartilhados, incluindo links, fotos, vídeos, figurinhas e produtos.

Criar

Não é possível executar essa operação no ponto de extremidade.

Atualizar

Não é possível executar essa operação no ponto de extremidade.

Excluir

Não é possível executar essa operação no ponto de extremidade.