v1

latestOpenAPI 3.0.02026-07-26253547.8 KB

Contacts

Cadastrar contato

Cria um contato após validar o número no WhatsApp.

Obrigatórios: connection (UUID — id de GET /v1/connections), number (DDI + DDD + telefone ).

Opcionais: name, email, agent, user, status.

post/v1/contacts

connectionstring uuid required

ID da conexão — o mesmo id retornado em GET /v1/connections.

numberstring required

Número para validação no WhatsApp (DDI + dígitos, com ou sem +).

namestring

Nome exibido no chat (string; não envie objeto).

emailstring

E-mail associado ao contato (string).

agentstring uuid

Agente de IA — mesmo id que recebe em GET /v1/agents.

userstring uuid

Usuário humano — mesmo campo user que recebe em GET /v1/users.

statusstring uuid

Label de status — mesmo campo status na resposta de chat. GET /v1/settings/status.

{
  "connection": "e3c9be60-fbe0-4630-abd2-d6b3d699c9b2",
  "number": "554892171075",
  "name": "Maria Silva",
  "email": "maria@empresa.com.br"
}

exist: false se o número não for WhatsApp válido; caso contrário exist, id e created.

existboolean required

Indica se o número existe no WhatsApp.

idstring uuid

Presente quando exist é true: UUID do chat/contato (Chat.id).

createdboolean

Presente quando exist é true: true se o chat foi criado nesta chamada.

{
  "exist": true,
  "id": "1cbcb7a8-8bf6-4016-8ed5-8ea38c4a9a05",
  "created": true
}