Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-text
Mencionar grupo
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>",
  "groupMentioned": [
    {
      "phone": "<string>",
      "subject": "<string>"
    }
  ]
}
'

​
Conceituação

Este método é responsável por fazer a menção de grupos relacionados a uma comunidade. O sistema restringe menções a grupos dentro da mesma estrutura de comunidade.

​
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 a menção será enviada
​
message
string
obrigatório
Texto a ser enviado (deve conter @ com o ID do grupo)
​
groupMentioned
array
obrigatório
Array com os dados dos grupos a serem mencionados

​
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": "5511999999999-group",
  "message": "Welcome to *Z-API group* @1203634230225498-group",
  "groupMentioned": [
    {
      "phone": "1203634230225498-group",
      "subject": "Z-API subgroup"
    }
  ]
}

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