API Reference • conversy-api

Controller Send Message

Total de endpoints 3 rotas documentadas
Autorização Header apikey
Resposta esperada Status 201 Created

BaseURL: https://conectorwp.conversy.net

POST

Send Plain Text

Envia uma mensagem de texto simples para um número informado, com suporte opcional a atraso de envio, prévia de link, menções e citação de mensagem anterior.

/message/sendText/{instance}

Especificação da rota

Autorização

apikey stringheaderobrigatório
Chave de autorização enviada no header da requisição.

Parâmetro de rota

instance stringobrigatório
Nome da instância que será utilizada para o envio da mensagem.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
textstringobrigatório
Texto da mensagem que será enviado.
delayinteger
Tempo de presença, em milissegundos, antes do envio da mensagem.
linkPreviewboolean
Exibe uma prévia do site de destino quando houver um link dentro da mensagem.
mentionsEveryOneboolean
Marca todos os participantes quando a mensagem for enviada.
mentionedenum<string>[]
Lista de números/identificadores a serem mencionados. Opção disponível documentada: {{remoteJID}}.
quotedobject
Objeto usado para responder ou citar uma mensagem anterior. Na documentação original, o exemplo inclui quoted.key.id e quoted.message.conversation.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/message/sendText/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "number": "<string>",
  "text": "<string>",
  "delay": 123,
  "linkPreview": true,
  "mentionsEveryOne": true,
  "mentioned": [
    "{{remoteJID}}"
  ],
  "quoted": {
    "key": {
      "id": "<string>"
    },
    "message": {
      "conversation": "<string>"
    }
  }
}'

Resposta

201 CreatedMensagem criada com sucesso.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE594145F4C59B4"
  },
  "message": {
    "extendedTextMessage": {
      "text": "Olá!"
    }
  },
  "messageTimestamp": "1717689097",
  "status": "PENDING"
}
Campos descritos na resposta: key identifica a mensagem no chat, message contém o conteúdo enviado, messageTimestamp representa o timestamp da mensagem e status indica o estado atual do envio.
POST

Send Media

Envia uma mensagem com mídia, permitindo o envio de imagem, vídeo ou documento por URL ou base64, com legenda, nome de arquivo, menções e citação de mensagem.

/message/sendMedia/{instance}

Especificação da rota

Autorização

apikeystringheaderobrigatório
Chave de autorização enviada no header da requisição.

Parâmetro de rota

instancestringobrigatório
Nome da instância usada para processar o envio.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, com código do país.
mediatypestringobrigatório
Tipo da mídia. A documentação indica: imagem, vídeo ou documento.
mimetypestringobrigatório
MIME type do arquivo enviado, por exemplo image/png.
captionstringobrigatório
Legenda associada à mídia.
mediastringobrigatório
Conteúdo da mídia via URL pública ou base64.
fileNamestringobrigatório
Nome do arquivo, por exemplo Image.png.
delayinteger
Tempo de presença, em milissegundos, antes do envio da mensagem.
linkPreviewboolean
Exibe uma prévia do site de destino quando houver link na mensagem.
mentionsEveryOneboolean
Marca todos os participantes no envio da mensagem.
mentionedenum<string>[]
Lista de números/identificadores a mencionar. Opção documentada: {{remoteJID}}.
quotedobject
Objeto para resposta/citação de mensagem anterior. O exemplo inclui quoted.key.id e quoted.message.conversation.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://{server-url}/message/sendMedia/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "number": "<string>",
  "mediatype": "<string>",
  "mimetype": "<string>",
  "caption": "<string>",
  "media": "<string>",
  "fileName": "<string>",
  "delay": 123,
  "linkPreview": true,
  "mentionsEveryOne": true,
  "mentioned": [
    "{{remoteJID}}"
  ],
  "quoted": {
    "key": {
      "id": "<string>"
    },
    "message": {
      "conversation": "<string>"
    }
  }
}'

Resposta

201 CreatedMídia enviada com sucesso.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE5F5A632EAE722"
  },
  "message": {
    "imageMessage": {
      "url": "https://mmg.whatsapp.net/o1/v/t62.7118-2...",
      "mimetype": "image/png",
      "caption": "Caption text",
      "fileSha256": "VbCGkGBv5SZStLD5PHdkBWpQav/lNsXcY...",
      "fileLength": "1305757",
      "height": 1080,
      "width": 1920,
      "mediaKey": "aFQK9Ocw5tE7Nf0iBA42Xcb4Dee6G1k/pLL...",
      "fileEncSha256": "bGVtYeR3458RwC0p1tsGDNuj+vOu/...",
      "directPath": "/o1/v/t62.7118-24/f1/m232/up-oil...",
      "mediaKeyTimestamp": "1717775573",
      "jpegThumbnail": "/9j/2wBDABALDA4MChAODQ4SERATG...",
      "contextInfo": {}
    }
  },
  "messageTimestamp": "1717775575",
  "status": "PENDING"
}
A documentação descreve que a resposta retorna key, message, messageTimestamp e status. No exemplo, o conteúdo aparece em imageMessage, mas o objeto message pode representar diferentes formatos de mídia conforme o envio.
POST

Send Location

Envia uma localização com nome, endereço, latitude e longitude, incluindo suporte a delay, menções, prévia de link e resposta a mensagem citada.

/message/sendLocation/{instance}

Especificação da rota

Autorização

apikeystringheaderobrigatório
Chave de autorização enviada no header da requisição.

Parâmetro de rota

instancestringobrigatório
Nome da instância utilizada no envio da localização.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
namestringobrigatório
Nome da cidade ou ponto de referência da localização.
addressstringobrigatório
Endereço da localização.
latitudenumberobrigatório
Latitude da localização.
longitudenumberobrigatório
Longitude da localização.
delayinteger
Tempo de presença, em milissegundos, antes do envio da mensagem.
linkPreviewboolean
Exibe uma prévia do site de destino quando houver link na mensagem.
mentionsEveryOneboolean
Marca todos os participantes no envio da mensagem.
mentionedenum<string>[]
Lista de números/identificadores a mencionar. A opção documentada é {{remoteJID}}.
quotedobject
Objeto para citar uma mensagem anterior. O exemplo inclui quoted.key.id e quoted.message.conversation.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://{server-url}/message/sendLocation/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "number": "<string>",
  "name": "<string>",
  "address": "<string>",
  "latitude": 123,
  "longitude": 123,
  "delay": 123,
  "linkPreview": true,
  "mentionsEveryOne": true,
  "mentioned": [
    "{{remoteJID}}"
  ],
  "quoted": {
    "key": {
      "id": "<string>"
    },
    "message": {
      "conversation": "<string>"
    }
  }
}'

Resposta

201 CreatedLocalização enviada com sucesso.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE51B6FF4470AF9"
  },
  "message": {
    "locationMessage": {
      "degreesLatitude": -19.93359,
      "degreesLongitude": -43.93851,
      "name": "Palácio da Liberdade",
      "address": "Praça da Liberdade, Belo Horizonte, MG 30140-050",
      "contextInfo": {}
    }
  },
  "messageTimestamp": "1717779606",
  "status": "PENDING"
}
A resposta documentada contém key, message, messageTimestamp e status. No exemplo, a localização vem dentro de locationMessage com latitude, longitude, nome e endereço.

Conversy API