Enviar evento
Método#
/send-event#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-event
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Neste método você poderá enviar mensagens do tipo Evento. Só é possível enviar esse tipo para um grupo.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Telefone (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 |
| event | Event | Dados do evento |
Event#
| Atributos | Tipo | Descrição |
|---|---|---|
| name | string | Nome do event |
| description | string (opcional) | Descrição do evento |
| dateTime | string | Data e hora do evento (sem timezone) |
| location | Location (opcional) | Localização do evento |
| callLinkType | string (voice/video) (opcional) | Tipo de chamada do evento (voz ou video) |
| canceled | boolean | Define se o evento está cancelado |
Request Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| zaapId | string | id no z-api |
| messageId | string | id no whatsapp |
| id | string | Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId |
Exemplo
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)