IDs de usuário por empresa

Um ID de usuário por empresa (BSUID) permite enviar mensagens a um usuário do WhatsApp sem o número de telefone dele. O ID identifica o usuário dentro do seu portfólio empresarial da Meta.

Nomes de usuário do WhatsApp

Usuários do WhatsApp com um nome de usuário podem enviar mensagens para você sem compartilhar o número de telefone. As mensagens incluem from.bsuid; from.phone_number pode estar ausente. Usuários sem nome de usuário também podem ter um BSUID.

A Meta inclui o número de telefone se o usuário estiver na sua agenda de contatos da Meta ou tiver trocado mensagens ou chamadas com seu número comercial nos últimos 30 dias. A regra de 30 dias se aplica por número comercial.

from.username e from.display_name são opcionais. Você não pode enviar mensagens para nenhum desses valores.

Formato do BSUID

Um BSUID tem um código de país ISO 3166 alpha-2 em maiúsculas, um ponto e até 128 letras ou dígitos. Por exemplo: US.13491208655302741918.

Armazene e envie o valor completo sem alterações. Use um número de remetente do mesmo portfólio empresarial. A Meta rejeita mensagens enviadas de outros portfólios.

O BSUID muda quando o usuário troca de número de telefone. Por isso, armazene-o sob seu próprio ID de cliente.

Um BSUID principal funciona nos portfólios cadastrados por uma empresa gerenciada. Ele acrescenta ENT. após o código de país: US.ENT.11815799212886844830. O limite de 128 caracteres se aplica à parte após ENT.. A Bird aceita os dois formatos.

Pedir um número de telefone

Estes exemplos da API de mensagens mostram apenas os campos necessários para esta troca.

{
  "direction": "inbound",
  "from": {
    "bsuid": "US.13491208655302741918"
  },
  "to": {
    "phone_number": "+14155550100"
  },
  "text": {
    "body": "Can I book a repair?"
  }
}

{
  "direction": "outbound",
  "from": {
    "phone_number": "+14155550100"
  },
  "to": {
    "bsuid": "US.13491208655302741918"
  },
  "interactive": {
    "type": "request_contact_info",
    "body_text": "Share your number."
  }
}

{
  "direction": "inbound",
  "from": {
    "bsuid": "US.13491208655302741918",
    "phone_number": "+14155550101"
  },
  "contact_cards": [
    {
      "origin": "contact_request",
      "phone_numbers": [
        {
          "phone_number": "+14155550101"
        }
      ]
    }
  ]
}

Se o usuário fechar a solicitação, você não recebe mensagem nem webhook. Defina um tempo limite para que seu aplicativo possa continuar sem o número.

Enviar uma mensagem

Defina to com o BSUID e from com seu número comercial do WhatsApp:

{
  "to": "US.13491208655302741918",
  "from": "+14155550100",
  "text": { "body": "Your repair is booked." }
}

Se a mensagem recebida tiver apenas um BSUID, responda a esse BSUID usando o mesmo número comercial. Um número de telefone dos seus próprios registros pode não ter uma janela de atendimento aberta, causando 422 E15044.

• Modelos de autenticação exigem um número de telefone.
• Um número de telefone ou BSUID inválido retorna 422 E15001.
• O preço da mensagem depende do código de país do BSUID.

A janela de atendimento ao cliente também se aplica aos BSUIDs. Uma resposta 202 significa que a API aceitou sua solicitação. Confira o status da mensagem para confirmar a entrega.

Encontrar mensagens

Nas mensagens e nos webhooks, from identifica o remetente e to identifica o destinatário. Cada um pode conter phone_number, bsuid ou ambos.

Para listar mensagens, filtre por:

• from ou to para um remetente ou destinatário, usando o número de telefone ou BSUID.
• bsuid para mensagens enviadas ao mesmo usuário do WhatsApp ou recebidas dele.

O filtro phone_number foi descontinuado. Use from ou to em seu lugar.

Guias relacionados

• Receber cartões de contato
• Solicitações de informações de contato do WhatsApp
• Enviar mensagens do WhatsApp
• Referência da Meta sobre IDs de usuário por empresa