Pular para o conteúdo principal

Mencionar membro

Método#

/send-text#

POST https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-text


Conceituação#

Este método é responsável por fazer a menção dos participantes em um grupo.


Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringTelefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NUMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara
messagestringTexto a ser enviado. Deve conter o @ com o numero
mentionedstringNumero a ser mencionado

Opcionais#

AtributosTipoDescrição
delayMessagenumberNesse atributo um delay é adicionado na mensagem. Você pode decidir entre um range de 1~15 sec, significa quantos segundos ele vai esperar para enviar a próxima mensagem. (Ex "delayMessage": 5, ). O delay default caso não seja informado é de 1~3 sec

Request Body#

{
"phone": "5511999999999",
"message": "Bem vindo @numero",
"mentioned": [numero]
}

Response#

200#

AtributosTipoDescrição
zaapIdstringid no Plugzapi
messageIdstringid no whatsapp

Exemplo

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

405#

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


Webhook Response#

Link para a response do webhook (ao receber)

Webhook


Code#