Pular para o conteúdo principal

Buscar email da conta

Método#

/security/email#

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/security/email

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Método utilizado para buscar o email configurado na conta do WhatsApp.

Atenção

Essa API está disponível apenas para instâncias mobile.


Response#

200#

AtributosTipoDescrição
successbooleanDefine se a requisição foi executada com sucesso
hasEmailbooleanDefine se a conta tem um email configurado
emailstringEmail configurado na conta
verifiedbooleanDefine se o email foi verificado

Exemplo#

{
"success": true,
"hasEmail": true,
"email": "example@email.com",
"verified": true
}

400#

Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado acima.

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio deste tópico.

415#

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"

Code#