Pular para o conteúdo principal

Enviar evento

Método#

/send-event#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-event

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Neste método você poderá enviar mensagens do tipo Evento.

warning

Até o momento, não temos suporte a geração de link para chamadas.

tip

As mensagens de evento podem ser enviadas somente para grupos de comunidades

image


Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringTelefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara
eventEventDados do evento

Event#

AtributosTipoDescrição
namestringNome do event
descriptionstring (opcional)Descrição do evento
dateTimestringData e hora do evento (sem timezone)
locationLocation (opcional)Localização do evento
canceledbooleanDefine se o evento está cancelado

Request Body#

{
"phone": "120363019502650977-group",
"event": {
"name": "Nome do evento",
"description": "Descrição do evento",
"dateTime": "2024-04-29T09:30:53.309Z",
"location": {
"name": "Nome do lugar"
},
"canceled": false
}
}

Response#

200#

AtributosTipoDescrição
zaapIdstringid no z-api
messageIdstringid no whatsapp
idstringAdicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId

Exemplo

{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}

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"


Webhook Response#

Link para a response do webhook (ao receber)

Webhook


Code#