versión API Graph

Mensaje

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

Para obtener el identificador de mensaje, usa el extremo de conversación o los webhooks a fin de 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 la aplicación

Se necesita para acceder a los datos de los usuarios que no tienen ningún rol en tu aplicación (como de desarrollador, evaluador o administrador).

Funciones

No es aplicable.

Identificadores

Un identificador de acceso a la página de un usuario que puede realizar la tarea MODERATE o MESSAGING en la página que se consulta o que está vinculada a la cuenta profesional de Instagram.

Permisos

Los permisos pages_messaging y pages_manage_metadata.

Los permisos instagram_basic e instagram_manage_messaging también son necesarios para los mensajes de Instagram.

Limitaciones

De los mensajes de Instagram

  • Solo las cuentas profesionales de Instagram con una página de Facebook vinculada pueden acceder a este extremo.
  • Al consultar este extremo, se devolverán todos los mensajes de esta conversación. Sin embargo, solo podrás consultar los datos de los 20 mensajes más recientes de la conversación. Si un mensaje no se encuentra entre los 20 más recientes, se devolverá un error que indica que el mensaje se ha eliminado.

Campos

Si un campo no tiene datos, 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, vídeo o URL de CDN de un archivo) adjunto al mensaje.


URL del archivo adjunto al mensaje.

URL de la imagen adjunta al mensaje. Puede incluir los siguientes pares de clave y valor:

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

Identificador del archivo adjunto.

URL de la imagen adjunta al mensaje. Puede incluir los siguientes pares de clave y 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, “true” o “false”.
  • url: cadena, URL de la imagen.
  • width: entero, en píxeles.

Nombre del archivo adjunto.

URL del vídeo adjunto al mensaje.

created_time

DateTime

Hora de creación del mensaje.

from

Objeto
id
email
name
username

Información sobre quién envió el mensaje. Puede ser un usuario, una página o una cuenta profesional de Instagram.

En el caso de un usuario, el identificador puede ser un identificador específico de Instagram o de la página y, en el caso de tu empresa, el identificador de la página o de la cuenta profesional de Instagram.

Correo electrónico de un usuario o página de Facebook. Solo mensajes de páginas

Nombre de un usuario o página de Facebook. Solo mensajes de páginas

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

Identificador de un mensaje.

is_unsupported

Booleano

Solo se devuelve si el valor es true e indica que un mensaje incluye contenido no admitido.

message

Cadena

Contenido del texto del mensaje. Si no hay texto en el mensaje, estará vacío.

reactions

Matriz
data Matriz
reaction Emoticono
users Matriz de objetos
id

username

Tipos de reacciones que ha recibido el mensaje, con una lista de todos los usuarios que han reaccionado con cada tipo de reacción.

Matriz de objetos de reacción.

Tipo de emoticono de reacción.

Lista de usuarios que han reaccionado al mensaje.


En el caso de un usuario de Instagram, el identificador puede ser un identificador específico de Instagram y, en el caso de tu empresa, el identificador de la cuenta profesional de Instagram.

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 del objeto de contenido compartido, también tienes que 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

Enlace e identificador de una historia. Solo se admiten las menciones y las respuestas.

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

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

tags

Objeto

Matriz de tipo data que contiene los nombres de las etiquetas que indican la carpeta de mensajes 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.



En el caso de un usuario, el identificador puede ser un identificador específico de Instagram o de la página y, en el caso de tu empresa, el identificador de la página o de la cuenta profesional de Instagram.

Correo electrónico de un usuario o página de Facebook. Solo mensajes de páginas

Nombre de un usuario o página de Facebook. Solo mensajes de páginas

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

Archivos adjuntos a un mensaje.

/shares

Elementos compartidos, como enlaces, fotos, vídeos, stickers y productos.

Creación

Esta operación no se puede realizar en este extremo.

Actualización

Esta operación no se puede realizar en este extremo.

Eliminación

Esta operación no se puede realizar en este extremo.