API de Gerenciamento do WhatsApp Business

QR codes e links curtos

Este guia explica como criar e gerenciar QR codes usando a API de Gerenciamento do WhatsApp Business.

Os clientes podem ler um QR code com o telefone para começar rapidamente uma conversa com a sua empresa. A API de Gerenciamento do WhatsApp Business permite que você crie e acesse esses QR codes e links curtos associados.

Se você puder usar o Gerenciador de Negócios para gerenciar os seus QR codes em vez da API, consulte Gerenciar o seu código QR da Plataforma do WhatsApp Business.

Antes de começar

Você precisará do seguinte:

Criar QR code

Para criar um QR code, envie uma solicitação POST ao ponto de extremidade WhatsApp Business Phone Number > Message Qrdls.

No corpo da publicação, inclua um objeto com uma propriedade prefilled_message definida como a mensagem de texto, assim como uma propriedade generate_qr_image definida como o formato de imagem de sua preferência (SVG ou PNG).

Exemplo de solicitação

curl 'https://graph.facebook.com/v21.0/106540352242922/message_qrdls' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "prefilled_message": "Cyber Monday",
  "generate_qr_image": "SVG"
}'

Exemplo de resposta

{
  "code": "4O4YGZEG3RIVE1",
  "prefilled_message": "Cyber Monday 1",
  "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1",
  "qr_image_url": "https://scontent-iad3-2.xx.fbcdn.net/..."
}

Obter lista de QR codes

Para obter uma lista de todos os QR codes em um número de telefone comercial, envie uma solicitação GET ao ponto de extremidade WhatsApp Business Phone Number > Message Qrdls.

Exemplo de solicitação

curl 'https://graph.facebook.com/v21.0/106540352242922/message_qrdls' \
-H 'Authorization: Bearer EAAJB...'

Exemplo de resposta

{
  "data": [
    {
      "code": "4O4YGZEG3RIVE1",
      "prefilled_message": "Cyber Monday",
      "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1"
    },
    {
      "code": "WOMVT6TJ2BP7A1",
      "prefilled_message": "Tell me more about your production workshop",
      "deep_link_url": "https://wa.me/message/WOMVT6TJ2BP7A1"
    }
  ]
}

Obter um QR code

Para obter informações sobre um QR code específico, envie uma solicitação GET ao ponto de extremidade WhatsApp Business Phone Number > Message Qrdls e adicione o ID do QR code como parâmetro de caminho.

Exemplo de solicitação

curl 'https://graph.facebook.com/v21.0/106540352242922/message_qrdls/4O4YGZEG3RIVE1' \
-H 'Authorization: Bearer EAAJB...'

Exemplo de resposta

{
  "data": [
    {
      "code": "4O4YGZEG3RIVE1",
      "prefilled_message": "Cyber Monday",
      "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1"
    }
  ]
}

Atualizar um QR code

Para atualizar um QR code, envie uma solicitação POST ao ponto de extremidade WhatsApp Business Phone Number > Message Qrdls.

No corpo da solicitação, inclua uma propriedade code definida como o ID do QR code que você quer atualizar, assim como uma propriedade prefilled_message definida como novo texto do QR code.

Exemplo de solicitação

curl 'https://graph.facebook.com/v21.0/106540352242922/message_qrdls' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
    "code": "4O4YGZEG3RIVE1",
    "prefilled_message": "Cyber Tuesday"
}'

Exemplo de resposta

{
  "code": "4O4YGZEG3RIVE1",
  "prefilled_message": "Cyber Tuesday",
  "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1"
}

Excluir QR code

Os QR codes não expiram automaticamente. Para excluir um QR code, envie uma solicitação DELETE ao ponto de extremidade WhatsApp Business Phone Number > Message Qrdls e adicione o ID do QR code que você quer desativar como parâmetro de caminho.

Exemplo de solicitação

curl -X DELETE 'https://graph.facebook.com/v21.0/106540352242922/message_qrdls/4O4YGZEG3RIVE1' \
-H 'Authorization: Bearer EAAJB...'

Exemplo de resposta

{
  "success": true
}

Referência

Saiba mais