API de Perfil do Messenger

No perfil do Messenger da Página, é possível configurar propriedades que definem vários aspectos dos recursos a seguir da plataforma do Messenger. Para mais informações, veja a tabela Propriedades do perfil do Messenger abaixo.

• Botão Começar
• Página de boas-vindas
• Quebra-gelos
• Menu persistente
• Lista de liberação de domínios
• Vinculação de conta
• Comandos
• Aba Descobrir (obsoleto)

A API de Perfil do Messenger permite que você defina, atualize, recupere e exclua as propriedades do perfil do Messenger da Página.

Permissões

Para interagir com esse ponto de extremidade, é preciso ter um token de acesso à Página com a permissão pages_messaging.

Nos apps em modo de desenvolvimento, as configurações do perfil do Messenger ficarão visíveis somente para pessoas com uma função no app.

Conteúdo

• Solicitar URI
• Propriedades do perfil do Messenger
• Recuperar as propriedades
• Definir ou atualizar propriedades
• Excluir propriedades
• Limites de volume

Solicitar URI

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

Propriedades do perfil do Messenger

As propriedades a seguir podem ser incluídas no perfil do Messenger da Página. Veja a descrição do tipo e da função de cada propriedade na tabela abaixo.

Recuperar as propriedades

Recupera o valor atual de uma ou mais propriedades do perfil do Messenger por nome.

Parâmetros da solicitação

Estes parâmetros são incluídos na string de consulta da solicitação:

Solicitação de exemplo

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

Exemplo de resposta

O valor atual das propriedades solicitadas será retornado na matriz data:

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

Definir ou atualizar propriedades

Define o valor de uma ou mais propriedades do perfil do Messenger. Somente as propriedades definidas no corpo da solicitação serão substituídas.

Solicitação de exemplo

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

Exemplo de resposta

{
    "result": "success"
}

Excluir propriedades

Exclui uma ou mais propriedades do perfil do Messenger. Somente propriedades especificadas na matriz fields serão excluídas.

Solicitação de exemplo

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

Exemplo de resposta

{
    "result": "success"
}