Como gerenciar QR codes e links curtos

Este guia explica como criar e gerenciar QR codes usando o 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.

Antes de começar

Você precisará do seguinte:

• O ID para o número de telefone atual da sua empresa (fromNumberId)
• Um token de acesso à plataforma para este telefone.

Criar QR code

Para criar um QR code, envie uma solicitação POST ao ponto de extremidade.

URI

URI: https://api.whatsapp.serpro.gov.br/cliente/{phoneNumberId}/v2/qrcode
Método: POST

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

Corpo da requisição

{
  "mensagemPrePreenchida": "string",
  "tipoDeImagem": "PNG"
}

Obter um QR code

Para obter informações sobre um QR code específico, envie uma solicitação GET ao ponto de extremidade e adicione o ID do QR code no parâmetro de caminho.

URI

URI: https://api.whatsapp.serpro.gov.br/cliente/{phoneNumberId}/v2/qrcode/{id}
Método: GET

Exemplo de resposta

{
    "codigo": "L22VMX2CVRJDN1",
    "mensagemPrePreenchida": "MSG",
    "deepLinkUrl": "https://wa.me/message/L22VMX2CVRJDN1"
}

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.

URI

URI: https://api.whatsapp.serpro.gov.br/cliente/{phoneNumberId}/v2/qrcode
Método: GET

Parâmetros de consulta a QR Code

Tanto a consulta individual quanto a lista de QR Code permitem que se coloque um parâmetro tipoDeImagem que irá especificar o tipo da imagem pesquisada.

Nome	Descrição
tipoDeImagem Tipo: String	Tipo da imagem do QR Code pesquisado. Valores: - PNG - SVG

Exemplo de resposta

{
    "qrImageUrl": "https://scontent.frao1-1.fna.fbcdn.net/m1/v/t6/An9HmebK4vkFj74Tt5JLP_me8Tde-rc5cpX8LPk9hCqpMf00otAknu85fo0Hbfdn7dFENkgHXJQCphZJJv7CDEaeb8swDjRQ6NlTA9JEYcu_whUqWd0_NWpGadbOy_JkDBrH-ikkSKE?ccb=10-5&oh=00_AfAwfkfgA2VGfChkl26mQoWDcTlH3HaHSGT6LeqyPTjB9Q&oe=65464D07&_nc_sid=5a413f"
}

Atualizar um QR code

Para atualizar um QR code, envie uma solicitação POST ao ponto de extremidade e adicione o ID do QR code no parâmetro de caminho.

URI

URI: https://api.whatsapp.serpro.gov.br/cliente/{phoneNumberId}/v2/qrcode/{id}
Método: POST

No corpo da solicitação, inclua o texto como text, que será novo texto do QR code.

Excluir QR code

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

URI

URI: https://api.whatsapp.serpro.gov.br/cliente/{phoneNumberId}/v2/qrcode/{id}
Método: DELETE

Exemplo de resposta

{
  "success": true
}