API de perfiles de Messenger

El perfil de Messenger de la página es donde configuras las propiedades que definen varios aspectos de las siguientes funciones de la plataforma de Messenger. Para obtener más información, consulta la tabla Propiedades del perfil de Messenger, que se muestra a continuación.

La API del perfil de Messenger te permite configurar, actualizar, recuperar y eliminar propiedades desde el perfil de Messenger de la página.

Permisos

Se requiere el token de acceso a la página con permiso pages_messaging para interactuar con este punto de conexión.

En las apps en modo de desarrollo, solo las personas que tengan un rol en la app podrán ver la configuración del perfil de Messenger.

URI de la solicitud

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

Propiedades de perfiles de Messenger

Se pueden incluir las siguientes propiedades en el perfil de Messenger de una página. Consulta las descripciones de la tabla que se muestra a continuación para informarte sobre el tipo y la función de las propiedades.

Propiedad Tipo Descripción

get_started

Objeto

Se enviará la carga como un evento messaging_postbacks cuando alguien toque el botón "Empezar" de la pantalla de bienvenida de la página de Messenger.


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

greeting

Matriz <Object>

Una matriz de mensajes de bienvenida con configuración regional que se muestran en la pantalla de bienvenida de la página de Messenger.


Para obtener más información, consulta la referencia del texto de saludo.

ice_breakers

Matriz <Object>

Una matriz con un objeto para empezar una conversación.


Para obtener más información, consulta la referencia sobre mensajes para empezar una conversación.

persistent_menu

Matriz <Object>

Una matriz de botones de llamada a la acción que se pueden incluir en el menú persistente.


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

whitelisted_domains

Matriz <String>

Una lista de los dominios agregados a una lista blanca. Es obligatorio en el caso de las páginas que usan el SDK de extensiones de Messenger y el plugin de casilla de verificación.


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

account_linking_url

Cadena

URL de devolución de llamada de autenticación. Es necesario utilizar un protocolo https.


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

home_url

Objeto

La URL que se mostrará en la vista web de Messenger cuando una persona abra el plugin de chat de Messenger.


Elemento obsoleto para todas las operaciones (GET, POST, DELETE) a partir de la versión 7.0.

commands

Matriz <Object>

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


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

target_audience (obsoleto)

Objeto

Un conjunto de criterios que determina el público que podrá ver el Messenger en la pestaña "Sugerencias".


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

subject_to_new_eu_privacy_rules

Booleano

Un indicador booleano que determina si las actualizaciones de la API de Messenger de Europa impactaron en la página. Esta 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

Se incluyen los siguientes parámetros en la cadena de consulta de la solicitud:

ParámetroDescripción

Campos

Una lista separada por comas de las propiedades del perfil de Messenger que se desea 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

Se devolverá el valor actual de las propiedades solicitadas en la matriz data:

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

Configurar/actualizar propiedades

Configura los valores de una o más propiedades del perfil de Messenger. Se reemplazarán solo las propiedades que se configuraron 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. Se eliminarán únicamente las propiedades especificadas 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 se limitan a 10 llamadas de API por intervalo de 10 minutos. Este límite de frecuencia se aplica por página.