Introduction

The EscalaZap API follows RESTful architecture standards, offering clear and consistent resource-based endpoints. All requests and responses are transmitted in JSON format, leveraging standard HTTP verbs, status codes, and authentication protocols to enable secure, efficient, and scalable integrations.

API Base URL

Please note that EscalaZap does not provide a sandbox or test environment. All API requests are processed in the live environment, so ensure that all request data and parameters are accurate before making any calls.

string 
https://www.escalazap.com/external-api

Authentication

All requests to the EscalaZap API require authentication. Each API request must include a valid client-id and client-secret to the request header, which can be obtained from your EscalaZap Dashboard under Developer Tools.

In addition to credentials, EscalaZap enforces IP-based security. You must register and enable your server’s public IP address in the IP Whitelist section of the dashboard. Requests originating from non-whitelisted IP addresses will be automatically rejected.

Both valid API credentials and an approved IP address are mandatory. Without completing these two steps, authentication will fail and API access will not be granted.

Response Format

All responses from the EscalaZap API are returned in JSON format. Each response follows a consistent structure and includes a status indicator, message, and relevant data payload when applicable. Standard HTTP status codes are used to represent the outcome of each request.

Exemplo de Resposta de Sucesso

JSON 
{
"status": "success",
"remark": "contact_list",
"message":[
    "Contact list fetched successfully"
],
"data": {
   ...you get all data here
    }
}

Exemplo de Resposta de Erro

JSON 
{
    "remark": "Unauthorized",
    "status": "error",
    "message": [
        "The client secret is required"
    ]
}
JSON 
 {
    "remark": "Unauthorized",
    "status": "error",
    "message": [
        "Access to this API endpoint is restricted to IP addresses that have been explicitly whitelisted.",
        "In order to access this API endpoint, please add your IP address (::1) to the white list from the user dashboard."
    ]
}
php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/contact/list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Get Contact List

This endpoint allows you to retrieve a complete list of contacts associated with your EscalaZap account.

GET
contact/list
Parâmetros de Consulta

Parâmetros de consulta que permitem personalizar a resposta da API.

Nome Descrição Obrigatório Padrão
página Especifica o número da página a ser recuperada. Não 1
paginar Define o número de itens retornados por página. Não 20
buscar Busca contatos por nome, sobrenome ou número de celular. Não -
php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/contact/store',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Criar Novo Contato

This endpoint allows you to add a new contact to your EscalaZap account. Provide the necessary contact details, and upon successful request, the API returns the created contact’s information in JSON format for easy integration.

POST
/contact/store
Campos Obrigatórios

Os seguintes campos são obrigatórios para criar um novo contato no sistema.

Nome Obrigatório Padrão
nome Sim -
sobrenome Sim -
código_celular Sim -
celular Sim -
cidade Não -
estado Não -
cep Não -
endereço Não -
imagem_perfil Não -
php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/contact/update/{contactId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Atualizar Contato

Este endpoint permite atualizar um contato existente. Você só precisa enviar os campos que deseja modificar. Qualquer campo não incluído na solicitação permanecerá inalterado.

POST
/contact/update/{id}
Campos Obrigatórios

Os seguintes campos são obrigatórios para criar um novo contato no sistema.

Nome Obrigatório Padrão
nome Sim -
sobrenome Sim -
código_celular Sim -
celular Sim -
cidade Não -
estado Não -
cep Não -
endereço Não -
imagem_perfil Não -
php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/contact/delete/{contactId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Excluir Contato

Este endpoint permite excluir um contato por seu ID exclusivo. A exclusão pode ser restrita se o contato tiver mensagens associadas ou estiver bloqueado.

DELETE
/contact/delete/{id}
php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/inbox/conversation-list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Lista de Conversas

Recupere uma lista paginada de conversas para o usuário autenticado, incluindo informações de contato e status da conversa.

GET
/inbox/conversation-list

Parâmetros de Consulta

Nome Descrição Padrão
status Filtrar conversas por status. Use o valor abaixo para filtrar a conversa via status. Done = 1; Pending = 2; Important = 3; Unread = 4; Todas
página Especifica o número da página a ser recuperada. 1
paginar Define o número de itens retornados por página. 20
php 

$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/inbox/change-conversation-status/2',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('status' => '1'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Alterar Status da Conversa

Atualize o status de uma conversa como pendente, concluída ou importante. Aqui Concluída = 1, Pendente = 2 e Importante = 3, Não Lida = 4

POST
/inbox/change-conversation-status/{conversation_id}

Parâmetros de URL

Parâmetro Tipo Descrição
conversation_id integer ID exclusivo da conversa

Corpo da Solicitação

Campo Tipo Obrigatório
status integer YEs
php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/inbox/conversation-details/2',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS => array('status' => '1'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Detalhes da Conversa

Recupere detalhes completos de uma conversa, incluindo informações de contato, notas, etiquetas e associações de lista.

GET
/inbox/conversation-details/{conversation_id}

Parâmetros de URL

Parâmetro Tipo Descrição
conversation_id integer ID exclusivo da conversa
php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/inbox/send-message',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('mobile_code' => '880','mobile' => xxxxxxxxx','message' => 'Hello world'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Enviar Mensagem

Envie mensagens do WhatsApp para um número de celular. Este endpoint suporta texto, mídia, localização, listas interativas, URLs de CTA e mensagens de e-commerce. Se nenhum contato ou conversa existente for encontrado para o número de telefone fornecido, um novo contato e conversa serão criados automaticamente.

POST
/inbox/send-message

Corpo da Solicitação

Campo Tipo Obrigatório Descrição
mobile_code string yes Código do país do celular. Deve ser um código numérico de país válido sem o sinal de mais (+).
mobile string yes Um número de celular válido associado ao código do país fornecido.
from_number string conditional É necessário um número de telefone do WhatsApp Business válido registrado em sua conta e no painel da Meta. Se nenhum ID for fornecido, a mensagem será enviada usando sua conta padrão do WhatsApp registrada.
message string Conditional Corpo da mensagem de texto. Obrigatório se nenhum dado de mídia, localização ou interativo for fornecido
image file No Arquivo de imagem (jpg, jpeg, png – máx 5MB)
document file No Arquivo de documento (pdf, doc, docx – máx 100MB)
video file No Arquivo de vídeo (mp4 – máx 16MB)
audio file No Arquivo de áudio – máx 16MB
latitude decimal Conditional Latitude para mensagem de localização
longitude decimal Conditional Longitude para mensagem de localização
cta_url_id integer No ID da URL de CTA para mensagens de botão interativo
interactive_list_id integer No ID da lista interativa

Notas

Pelo menos um tipo de mensagem deve ser fornecido.

Mensagens interativas exigem um plano ativo.

Contatos bloqueados não podem enviar ou receber mensagens.

php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/inbox/send-template-message',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('mobile_code' => '880','mobile' => 'xxxxxx','testmplate_id' => 'your template id'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Enviar Mensagem de Modelo

Envie uma mensagem de modelo do WhatsApp aprovada para uma conversa existente. Mensagens de modelo são comumente usadas para notificações, alertas e comunicação iniciada pela empresa.

POST
/external-api/inbox/send-template-message

Corpo da Solicitação

Campo Tipo Obrigatório Descrição
mobile_code string yes Código do país do celular. Deve ser um código numérico de país válido sem o sinal de mais (+).
mobile string yes Um número de celular válido associado ao código do país fornecido.
from_number string conditional É necessário um número de telefone do WhatsApp Business válido registrado em sua conta e no painel da Meta. Se nenhum ID for fornecido, a mensagem será enviada usando sua conta padrão do WhatsApp registrada.
template_id integer Yes ID do modelo do WhatsApp aprovado

Notas

Apenas modelos do WhatsApp aprovados podem ser enviados.

Mensagens de modelo são normalmente usadas para conversas iniciadas pela empresa.

Contatos bloqueados não podem receber mensagens de modelo.

A conta do WhatsApp deve estar conectada antes de enviar mensagens.

php 

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.escalazap.com/extern-api/inbox/template-list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Obter Lista de Modelos

Este endpoint permite buscar todos os modelos do WhatsApp associados à sua conta.

POST
/inbox/template-list