Identidade da ID do WhatsApp do usuário

/v1/contacts/{users-whatsapp-id}/identity

É possível receber notificações do WhatsApp quando um usuário com quem você estiver se comunicando for potencialmente alterado. Use essa borda de /v1/contacts para gerenciar as identidades do usuário. Consulte Entenda a mudança de identidade no WhatsApp Business para saber mais.

Para obter mais informações sobre a notificação do sistema enviada a partir do WhatsApp, veja Notificações de entrada — Exemplo: possível alteração de usuário. A resposta à notificação do sistema é gerenciada por sua empresa.

Leitura

Uma chamada GET ao ponto de extremidade recuperará o hash de identidade mais recente de um usuário.

Exemplo

Solicitação:

GET /v1/contacts/users-whatsapp-id/identity

Resposta:

Se for bem-sucedida, sua solicitação retornará 200 OK e um corpo de mensagem contendo um objeto contacts. Por exemplo, a resposta completa, incluindo o objeto contacts, poderá ter esta aparência:

{
    "contacts":
    {
        "hash": "UKD6Y/5SqDU=",
        "created_timestamp": 1600132094000,
        "acknowledged": true 
    }
}
  

Campos de retorno

O objeto da resposta contacts contém as seguintes informações sobre a identidade do usuário.

NomeDescrição

acknowledged

tipo: cadeia de caracteres

O estado de confirmação da notificação do sistema user_identity_changed mais recente.

created_timestamp

tipo: número inteiro

O registro de data e hora do momento em que o cliente da WhatsApp Business API detectou a possível alteração no usuário.

hash

tipo: cadeia de caracteres

O identificador da notificação do sistema user_identity_changed mais recente.

Como criar

Faça chamadas PUT ao ponto de extremidade para confirmar a notificação do sistema user_identity_changed mais recente.

Até que você realize uma chamada de API identity bem-sucedida após receber uma notificação user_identity_changed, todas as mensagens de saída para esse usuário serão bloqueadas se a configuração show_security_notifications estiver ativada nas configurações do aplicativo.

Exemplo

Solicitação:

PUT /v1/contacts/users-whatsapp-id/identity
  {
    “hash”: “Rc/eg9RQ0JA=”
  }

Resposta:

Uma resposta bem-sucedida é 200 OK com um corpo de mensagem null ou {}.

Parâmetros

NomeDescrição

hash

tipo: cadeia de caracteres

Identificador da notificação do sistema user_identity_change mais recente recebida por esse contato