Usar IDs de usuário com escopo de negócios (BSUIDs)

​

Por que os BSUIDs existem

​

Entenda os identificadores

• Um BSUID é exclusivo para um par de portfólio de negócios e usuário.
• O BSUID de um usuário muda quando o usuário altera seu número de telefone.
• Um BSUID pai funciona em todos os portfólios vinculados para os quais a Meta o habilitou.
• Um número de telefone comercial não pode usar um BSUID regular com escopo definido para outro portfólio.

​

Antes de começar

• Armazene sua chave de API da YCloud em YCLOUD_API_KEY.
• Use um número de telefone comercial do WhatsApp de propriedade do mesmo portfólio que o BSUID regular.
• Inscreva seu endpoint de Webhook nos eventos do WhatsApp que sua integração utiliza.
• Trate cada novo campo de BSUID, BSUID pai, número de telefone e nome de usuário como opcional ao desserializar webhooks.
• Armazene o BSUID regular e o BSUID pai de forma independente quando ambos estiverem presentes.

​

Enviar uma mensagem com um BSUID

curl --request POST \
  https://api.ycloud.com/v2/whatsapp/messages/sendDirectly \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "from": "+16315551111",
    "recipient": "US.13491208655302741918",
    "type": "text",
    "text": {
      "body": "Hello from YCloud!"
    }
  }'

​

Solicitar o número de telefone de um usuário

​

Usar um botão de modelo

{
  "type": "buttons",
  "buttons": [
    {
      "type": "REQUEST_CONTACT_INFO",
      "text": "Share Contact Info"
    }
  ]
}

​

Usar uma mensagem interativa

curl --request POST \
  https://api.ycloud.com/v2/whatsapp/messages/sendDirectly \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "from": "+16315551111",
    "recipient": "US.13491208655302741918",
    "type": "interactive",
    "interactive": {
      "type": "request_contact_info",
      "body": {
        "text": "Please share your phone number."
      },
      "action": {
        "name": "request_contact_info"
      }
    }
  }'

​

Processar a resposta do contato

{
  "type": "whatsapp.inbound_message.received",
  "whatsappInboundMessage": {
    "fromUserId": "US.13491208655302741918",
    "type": "contacts",
    "contacts": [
      {
        "origin": "contact_request",
        "phones": [
          {
            "phone": "+16315551111",
            "wa_id": "16315551111"
          }
        ]
      }
    ]
  }
}

​

Entender o catálogo de contatos da Meta

​

Solicitações de contato e Armazenamento Local

​

Excluir uma entrada do catálogo de contatos da Meta

curl --request DELETE \
  "https://api.ycloud.com/v2/whatsapp/phoneNumbers/WABA_ID/%2B16315551111/contactBook/US.13491208655302741918" \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Accept: application/json"

​

Iniciar uma chamada com um BSUID

curl --request POST \
  https://api.ycloud.com/v2/whatsapp/calls/connect \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "from": "+16315551111",
    "recipient": "US.13491208655302741918",
    "sdpType": "offer",
    "sdp": "SDP_OFFER"
  }'

​

Processar campos de webhook de BSUID

• Um campo de BSUID principal fica ausente quando BSUIDs principais não estão ativados.
• Um campo de destino de mensagem ou chamada enviada pode estar ausente quando você se direcionou ao usuário por número de telefone.
• customerProfile aparece em atualizações de mensagens sent, delivered e read, mas não em atualizações de failed.
• customerProfile.username fica ausente quando o usuário não tiver ativado nomes de usuário. Ele também fica ausente das atualizações de status de sent.
• Um número de telefone pode estar ausente mesmo quando o BSUID correspondente estiver presente.

​

Lidar com a alteração de número de telefone por um usuário

{
  "type": "system",
  "system": {
    "type": "user_changed_number",
    "wa_id": "16315552222",
    "user_id": "US.13491208655302741919",
    "parent_user_id": "US.ENT.11815799212886844831"
  }
}

​

Nomes de usuário comerciais

​

Nomes de usuário reservados

​

Prioridade de exibição na janela de conversa

1. O nome salvo nos contatos do cliente.
2. O nome comercial verificado ou o nome da Conta Comercial Oficial.
3. O nome de usuário comercial.
4. O número de telefone.

​

Lista de verificação de migração

1. Adicione todos os campos de webhook relacionados a BSUID ao seu modelo de desserialização como um campo opcional.
2. Armazene os BSUIDs comuns e principais separadamente dos números de telefone e nomes de usuário.
3. Indexe a identidade do cliente por portfólio e BSUID. Não trate um BSUID como um identificador globalmente portátil.
4. Encaminhe as solicitações de mensagens e chamadas por meio de to ou recipient, e teste a regra de precedência de to.
5. Teste usuários somente com nome de usuário, números de telefone ausentes, alterações de número de telefone, BSUIDs principais ausentes, webhooks duplicados e recriação da lista de contatos.