API Graph versión

Mensaje

Un mensaje individual en una conversación con mensajes de Instagram o Messenger.

Usa el punto de conexión de la conversación para obtener el identificador del mensaje o Webhooks para recuperar los identificadores de mensajes individuales.

Lectura

Explorador de la API Graph
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
}];

Requisitos

TipoDescripción

Revisión de apps

Es obligatorio para acceder a los datos de las personas que no tienen un rol en tu app, como un desarrollador, un verificador o un administrador.

Funciones

No aplica

Tokens

Un token de acceso a la página de una persona que puede realizar la tarea MODERATE o MESSAGING en la página que se está consultando o que está vinculada a la cuenta profesional de Instagram.

Permisos

Los permisos pages_messaging y pages_manage_metadata.

Los permisos instagram_basic y instagram_manage_messaging también son obligatorios para los mensajes de Instagram.

Limitaciones

Mensajes de Instagram

  • Solo las cuentas profesionales de Instagram con una página de Facebook vinculada pueden acceder a este punto de conexión.
  • Cuando se consulte este punto de conexión, se devolverán todos los mensajes correspondientes a esta conversación. Sin embargo, solo podrás consultar datos de los 20 mensajes más recientes de la conversación. Si un mensaje no se encuentra dentro de los 20 más recientes, se devolverá un error indicando que el mensaje se borró.

Campos

Si un campo no contiene datos, dicho campo no se devolverá en la respuesta JSON.

NombreDescripción

attachments.data

matriz
file_url
generic_template
id
image_data
name
video_data

Contenido multimedia, como una imagen, un video o una URL de la CDN de un archivo, adjunto en el mensaje.


La URL del archivo adjunto del mensaje.

La URL de la imagen adjunta del mensaje. Puede incluir los siguientes pares clave-valor:

  • cta: objeto con title, type y url
  • medial_url: cadena, URL de la imagen
  • subtitle: cadena, en píxeles
  • title: cadena

El identificador del adjunto.

La URL de la imagen adjunta del mensaje. Puede incluir los siguientes pares clave-valor:

  • animated_gif_preview_url: cadena, URL de la vista previa del GIF
  • animated_gif_url: cadena, URL del GIF
  • height: entero, en píxeles
  • max_height: entero, en píxeles
  • max_width: entero, en píxeles
  • preview_url: cadena, vista previa de la URL
  • render_as_sticker: booleano, verdadero o falso
  • url: cadena, URL de la imagen
  • width: entero, en píxeles

El nombre del adjunto.

La URL del video adjunto del mensaje.

created_time

datetime

El momento en que se creó el mensaje.

from

objeto
id
email
name
username

Información sobre quién envió el mensaje (puede ser una persona, una página o una cuenta de profesional de Instagram).

El identificador puede ser específico de Instagram o específico de la página, en el caso de tratarse de una persona, o bien el identificador de la página o de la cuenta profesional de Instagram, en el caso de que se trate de una empresa.

El correo electrónico de una persona o página de Facebook (solo mensajes de la página).

El nombre de una persona o página de Facebook (solo mensajes de la página).

El nombre de usuario de una persona en Instagram o tu cuenta profesional de Instagram. (solo mensajes de Instagram).

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

id

cadena

El identificador de un mensaje.

is_unsupported

booleano

Solo se devuelve cuando el valor es true y el mensaje tiene contenido no compatible.

message

cadena

El contenido de texto del mensaje. Si no hay texto en el mensaje, aparecerá vacío.

reactions

matriz
data matriz
reaction emoji
users matriz de objetos
id

username

Los tipos de reacciones que recibió el mensaje con una lista de todas las personas que utilizaron ese tipo de reacción.

Una matriz de objetos de reacción.

El tipo de emoji vinculado a la reacción.

Una lista de las personas que reaccionaron al mensaje.


El identificador puede ser específico de Instagram en el caso de que se trate de una persona que usa Instagram, o bien puede ser un identificador de cuenta profesional de Instagram en el caso de que se trate de una empresa.

El nombre de usuario de una persona en Instagram o tu cuenta profesional de Instagram. (solo mensajes de Instagram).

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

shares

matriz

Contenido multimedia compartido, como una publicación o una plantilla de producto, incluido en el mensaje. Ten en cuenta que, en el caso de los objetos compartidos, también debes solicitar los subcampos para recuperar los datos.

"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

El enlace y el identificador de una historia. Solo se admiten menciones y respuestas.

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

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

tags

objeto

Una matriz data que contiene los nombres de las etiquetas que indican la carpeta y el origen del mensaje.

  • En el caso de las páginas de Facebook, name puede ser inbox, read o source:chat.

to

objeto
data matriz
id
email
name
username

Información sobre quién recibió el mensaje.



El identificador puede ser específico de Instagram o específico de la página, en el caso de tratarse de una persona, o bien el identificador de la página o de la cuenta profesional de Instagram, en el caso de que se trate de una empresa.

El correo electrónico de una persona o página de Facebook (solo mensajes de la página).

El nombre de una persona o página de Facebook (solo mensajes de la página).

El nombre de usuario de una persona en Instagram o tu cuenta profesional de Instagram. (solo mensajes de Instagram).

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

Perímetros

Nombre Descripción

/attachments

Los archivos adjuntos al mensaje.

/shares

Elementos compartidos (incluye enlaces, fotos, videos, stickers y productos).

Crear

No es posible realizar esta operación en este punto de conexión.

Actualizar

No es posible realizar esta operación en este punto de conexión.

Eliminar

No es posible realizar esta operación en este punto de conexión.