Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-call
Fazer ligação
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-call \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

Conceituação

Neste método você pode enviar uma ligação a um número que possua WhatsApp.

Atributos

instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
token
string
obrigatório
Token da sua instância Z-API.

Obrigatórios

phone
string
obrigatório
Telefone do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999

Opcionais

callDuration
number
Duração da chamada em segundos. Padrão: 5 segundos. Máximo: 15 segundos
callAudioUrl
string
Link do arquivo de áudio (16k bitrate). Disponível apenas para contas com funcionalidade de chamadas habilitada

Request Body

{
  "phone": "5511999999999",
  "callDuration": 5
}

Response

200

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

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início 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”.