DOCUMENTAÇÃO DISPARO COM API - ALÔCHAT
Estrutura de requisição utilizada para disparo de mensagens via API.
POST
https://suaempresa.alochat.com.br/int/enqueueMessageToSend
Autenticação
queueId
Obrigatório
ID da fila utilizada para envio da mensagem.
apiKey
Obrigatório
Chave de autenticação da API vinculada à fila informada.
Parâmetros
numberObrigatório
Número do destinatário. Deve ser informado number ou clientId.
templateIdObrigatório
ID do template da mensagem. Obrigatório para filas oficiais.
varsdataarrayOpcional
Lista de variáveis utilizadas no template seguindo a ordem: cabeçalho, corpo, botões, listas e rodapé.
hiddenbooleanOpcional
Define se a mensagem ficará oculta no histórico de atendimentos.
Exemplos
{
"queueId": "96",
"apiKey": "SUA_API_KEY",
"templateId": "284",
"number": "5586995555555",
"hidden": false,
"varsdata": [
"Maria", "João", "20/06/2026", "14:30"
]
}Visualização do Template
curl --request POST \
--url https://suaempresa.alochat.com.br/int/enqueueMessageToSend \
--header 'Content-Type: application/json' \
--data '{
"queueId": "96",
"apiKey": "SUA_API_KEY",
"templateId": "284",
"number": "5586995555555",
"hidden": false,
"varsdata": [
"Maria", "João", "20/06/2026", "14:30"
]
}'{
"queueId": 0,
"apiKey": "string",
"templateId": 0,
"headerFile": "string",
"number": "string",
"country": "string",
"clientId": "string",
"text": "string",
"fileId": 0,
"buttonsConfig": {
"title": "string",
"buttons": [
"string",
{
"text": "string",
"id": "string"
}
]
},
"urlButtonConfig": {
"title": "string",
"buttons": [
{
"url": "string",
"text": "string"
}
]
},
"listConfig": {
"title": "string",
"items": [
{
"title": "string",
"description": "string"
}
]
},
"campaignName": "string",
"extData": "string",
"extFlag": 0,
"hidden": true
}Respostas da API
Sucesso (200)
{
"status": "success",
"message": "Enviada",
"messageId": "ID_MSG"
}Erro (400/401)
{
"status": "error",
"message": "Motivo",
"details": ["Erro X"]
}