Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-text
Mencionar todos
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-text \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "mentionAll": true
}
'

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

Este método é responsável por mencionar todos os participantes de um grupo de uma só vez, sem a necessidade de listar cada número individualmente.
Para que a menção apareça como @todos em verde no WhatsApp (como uma menção real), o conteúdo da mensagem deve conter @all.Exemplo: "Mensagem Teste @all"
  • @todos não funciona — apenas @all é reconhecido pelo WhatsApp
  • Funciona somente em grupos — não é compatível com Newsletters

​
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
ID do grupo onde todos os participantes serão mencionados
​
message
string
obrigatório
Texto a ser enviado. Para que a menção apareça corretamente no WhatsApp, inclua @all no conteúdo da mensagem
​
mentionAll
boolean
obrigatório
Quando true, menciona todos os participantes do grupo

​
Opcionais

​
delayMessage
number
Delay adicionado na mensagem. Você pode decidir entre um range de 1 a 15 sec. O delay default caso não seja informado é de 1 a 3 sec

​
Request Body

{
  "phone": "120363019502650977-group",
  "message": "Mensagem Teste @all",
  "mentionAll": true
}

​
Response

​
200

{
  "zaapId": "019DXXXXXXXXXXXXXXXXXXXXXXXX8B",
  "messageId": "3EXXXXXXXXXXXXXXXD",
  "id": "3XXXXXXXXXXXXXXXXX1D"
}

​
400

{
  "error": "mentionAll can only be used in groups"
}

​
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”.