API de perfiles de Messenger

En el perfil de Messenger de tu página puedes establecer propiedades que definen distintos aspectos de las funciones siguientes de la plataforma de Messenger. Para obtener más información, consulta la tabla Propiedades de los perfiles de Messenger que se encuentra a continuación.

Con la API de perfiles de Messenger, puedes establecer, actualizar, recuperar y eliminar propiedades del perfil de Messenger de la página.

Permisos

Se necesita un identificador de acceso a la página con el permiso pages_messaging para interactuar con este extremo.

En el caso de las aplicaciones que se encuentren en el modo de desarrollo, la configuración del perfil de Messenger solo será visible para los usuarios que tengan un rol en la aplicación.

URI de solicitud

https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>

Propiedades del perfil de Messenger

Puedes incluir las propiedades siguientes en el perfil de Messenger de tu página. Consulta las descripciones de la tabla siguiente para ver el tipo y el propósito de cada propiedad.

Propiedad Tipo Descripción

get_started

Objeto

Carga útil que se enviará como evento messaging_postbacks cuando alguien toque el botón "Empezar" de la pantalla de bienvenida de Messenger de tu página.


Para obtener más información, consulta la referencia sobre el botón "Empezar".

greeting

Matriz<Object>

Una matriz de mensajes de bienvenida específicos de cada región que se mostrarán en la pantalla de bienvenida de Messenger de tu página.


Para obtener más información, consulta la referencia sobre el texto de bienvenida.

ice_breakers

Matriz<Object>

Matriz con un objeto de frase para romper el hielo.


Para obtener más información, consulta la referencia sobre las frases para romper el hielo.

persistent_menu

Matriz<Object>

Matriz de botones de llamada a la acción que se van a incluir en el menú persistente.


Para obtener más información, consulta la referencia sobre el menú persistente.

whitelisted_domains

Matriz<String>

Lista de dominios autorizados. Obligatorio para las páginas que usan el SDK de extensiones de Messenger y el plugin de casillas.


Para obtener más información, consulta la referencia sobre la lista de dominios autorizados.

account_linking_url

Cadena

URL de devolución de llamada de autenticación. Debe usar el protocolo HTTPS.


Para obtener más información, consulta la referencia sobre las URL de vinculación de cuentas.

home_url

Objeto

URL que se mostrará en la vista web de Messenger cuando alguien abra tu plugin de chat de Messenger.


Obsoleto para todas las operaciones (GET, POST y DELETE) de la versión 7.0 y posteriores.

commands

Matriz<Object>

Argumento opcional. Si se proporciona, no puede ser nulo.


Para obtener más información, consulta la referencia sobre los comandos.

target_audience (obsoleto)

Objeto

Conjunto de criterios que determinan la audiencia para la que aparecerá tu Messenger en la pestaña Sugerencias.


Para obtener más información, consulta la referencia sobre la configuración de la audiencia objetivo.

subject_to_new_eu_privacy_rules

Booleano

Marca booleana que determina si la página se ve afectada por las actualizaciones de la API de Messenger para Europa. La propiedad solo está disponible para la solicitud GET.

Recuperar propiedades

Recupera el valor actual de una o más propiedades del perfil de Messenger según el nombre.

Parámetros de la solicitud

Los parámetros siguientes se incluyen en la cadena de consulta de la solicitud:

ParámetroDescripción

Campos

Lista separada por comas de las propiedades del perfil de Messenger que se van a recuperar.

Ejemplo de solicitud

curl -X GET "https://graph.facebook.com/v21.0/me/messenger_profile?fields=whitelisted_domains,greeting&access_token=<PAGE_ACCESS_TOKEN>"

Ejemplo de respuesta

El valor actual de las propiedades solicitadas se devolverá en la matriz data:

{
   "data": [
        {
          "whitelisted_domains": [
            "https://facebook.com/"
          ],
          "greeting": [
            {
               "locale": "default",
               "text": "Hello!"
            },
            {
               "locale": "en_US",
               "text": "Timeless apparel for the masses."
            }
         ]
      }
   ]
}

Establecer/actualizar propiedades

Establece los valores de una o más propiedades del perfil de Messenger. Solo se sobrescribirán las propiedades establecidas en el cuerpo de la solicitud.

Ejemplo de solicitud

curl -X POST -H "Content-Type: application/json" -d '{
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  ...
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Ejemplo de respuesta

{
    "result": "success"
}

Eliminar propiedades

Elimina una o más propiedades del perfil de Messenger. Únicamente se eliminarán las propiedades que se especifiquen en la matriz fields.

Ejemplo de solicitud

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    ...
  ]
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Ejemplo de respuesta

{
    "result": "success"
}

Límite de frecuencia

Las llamadas a la API de perfiles de Messenger están limitadas a 10 llamadas a la API por cada intervalo de 10 minutos. El límite de frecuencia se aplica por página.