API Reference • Conversy API

Documentação Conversy API

Total de controllers3 seções
Total de endpoints22 rotas documentadas
AutorizaçãoHeader apikey

BaseURL: https://conectorwp.conversy.net

Introdução

Visão geral da solução, sua missão e modelos de integração suportados.

A Conversy API é um serviço robusto desenvolvido para transformar o WhatsApp™ em um canal estratégico de integração, automação e atendimento. Mais do que uma simples solução de mensagens, ela foi criada para capacitar pequenas empresas, empreendedores, freelancers e profissionais com recursos limitados, oferecendo uma estrutura acessível, escalável e inteligente para fortalecer seus negócios, seja no ambiente local ou online.

Nossa missão é fornecer uma API abrangente que permita integrar o WhatsApp™ a múltiplas plataformas, sistemas e serviços, centralizando conversas, automatizando processos e otimizando fluxos de atendimento, vendas e relacionamento com clientes. Com a Conversy API, empresas podem reduzir gargalos operacionais, aumentar a eficiência das equipes e aproveitar todo o potencial do WhatsApp™ como canal de comunicação e crescimento.

A solução oferece suporte tanto à API de WhatsApp baseada no Baileys quanto à API oficial do WhatsApp Business, conhecida como WABA — API Oficial do WhatsApp. Dessa forma, a Conversy API entrega flexibilidade para diferentes tipos de operação, permitindo que cada negócio escolha o modelo mais adequado às suas necessidades, com mais controle, integração e performance.

Início

Endpoint inicial para validar a disponibilidade e metadados da API.

1 endpoint(s)Header apikey
GET

Get Information

Retorna informações gerais da API e confirma se o serviço está funcionando corretamente.

/

Especificação da rota

Body application/json

Este endpoint não possui body documentado.

Exemplos

cURL

Exemplo de requisição
curl --request GET \
  --url https://conectorwp.conversy.net/

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "status": 200,
  "message": "Welcome to the Conversy API, it is working!",
  "version": "2.3.7",
  "clientName": "conversy",
  "documentation": "https://doc.conectorwp.conversy.net"
}

Send Message

Rotas responsáveis por envio de mensagens e conteúdos via WhatsApp.

8 endpoint(s)Header apikey
POST

Send Plain Text

Envia uma mensagem de texto simples com suporte a delay, link preview, menções e citação.

/message/sendText/{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 para executar a operação.

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á enviada.
delayintegeropcional
Tempo de presença, em milissegundos, antes do envio.
linkPreviewbooleanopcional
Exibe prévia de link quando houver URL no conteúdo.
mentionsEveryOnebooleanopcional
Menciona todos os participantes quando aplicável.
mentionedenum<string>[]opcional
Lista de números/identificadores a mencionar. Opção documentada: {{remoteJID}}.
quotedobjectopcional
Objeto para responder/citar uma mensagem anterior.

Exemplos

cURL

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

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE594145F4C59B4"
  },
  "message": {
    "extendedTextMessage": {
      "text": "Olá!"
    }
  },
  "messageTimestamp": "1717689097",
  "status": "PENDING"
}
POST

Send Media

Envia imagem, vídeo ou documento por URL ou base64, com legenda e nome de arquivo.

/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 utilizada para executar a operação.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
mediatypestringobrigatório
Tipo da mídia: imagem, vídeo ou documento.
mimetypestringobrigatório
MIME type do arquivo, 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 enviado.
delayintegeropcional
Tempo de presença, em milissegundos, antes do envio.
linkPreviewbooleanopcional
Exibe prévia de link quando houver URL no conteúdo.
mentionsEveryOnebooleanopcional
Menciona todos os participantes quando aplicável.
mentionedenum<string>[]opcional
Lista de números/identificadores a mencionar. Opção documentada: {{remoteJID}}.
quotedobjectopcional
Objeto para responder/citar uma mensagem anterior.

Exemplos

cURL

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

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE5F5A632EAE722"
  },
  "message": {
    "imageMessage": {
      "mimetype": "image/png",
      "caption": "Caption text"
    }
  },
  "messageTimestamp": "1717775575",
  "status": "PENDING"
}
POST

Send WhatsApp Audio

Envia áudio em formato compatível com WhatsApp, aceitando arquivo por URL ou base64.

/message/sendWhatsAppAudio/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
audiostringobrigatório
URL ou base64 do áudio a ser enviado.
delayintegeropcional
Tempo de presença, em milissegundos, antes do envio.
linkPreviewbooleanopcional
Exibe prévia de link quando houver URL no conteúdo.
mentionsEveryOnebooleanopcional
Menciona todos os participantes quando aplicável.
mentionedenum<string>[]opcional
Lista de números/identificadores a mencionar. Opção documentada: {{remoteJID}}.
quotedobjectopcional
Objeto para responder/citar uma mensagem anterior.

Exemplos

cURL

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

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE5EFED2AB0BB9F"
  },
  "message": {
    "audioMessage": {
      "mimetype": "audio/mp4",
      "seconds": 42,
      "ptt": true
    }
  },
  "messageTimestamp": "1717776942",
  "status": "PENDING"
}
POST

Send Sticker

Envia um sticker a partir de uma URL pública ou conteúdo base64.

/message/sendSticker/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
stickerstringobrigatório
URL ou base64 do sticker.
delayintegeropcional
Tempo de presença, em milissegundos, antes do envio.
linkPreviewbooleanopcional
Exibe prévia de link quando houver URL no conteúdo.
mentionsEveryOnebooleanopcional
Menciona todos os participantes quando aplicável.
mentionedenum<string>[]opcional
Lista de números/identificadores a mencionar. Opção documentada: {{remoteJID}}.
quotedobjectopcional
Objeto para responder/citar uma mensagem anterior.

Exemplos

cURL

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

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Send Location

Envia uma localização com nome, endereço, latitude e longitude.

/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 para executar a operação.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
namestringobrigatório
Nome do local ou ponto de referência.
addressstringobrigatório
Endereço da localização.
latitudenumberobrigatório
Latitude da localização.
longitudenumberobrigatório
Longitude da localização.
delayintegeropcional
Tempo de presença, em milissegundos, antes do envio.
linkPreviewbooleanopcional
Exibe prévia de link quando houver URL no conteúdo.
mentionsEveryOnebooleanopcional
Menciona todos os participantes quando aplicável.
mentionedenum<string>[]opcional
Lista de números/identificadores a mencionar. Opção documentada: {{remoteJID}}.
quotedobjectopcional
Objeto para responder/citar uma mensagem anterior.

Exemplos

cURL

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

Resposta

201 CreatedRetorno documentado para a operação.
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"
    }
  },
  "messageTimestamp": "1717779606",
  "status": "PENDING"
}
POST

Send Contact

Envia um ou mais contatos no formato de cartão/vCard.

/message/sendContact/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
contactobject[]obrigatório
Lista de contatos. Cada item pode conter wuid, phoneNumber, organization, email, url e fullName.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/message/sendContact/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "contact": [
    {
      "wuid": "<string>",
      "phoneNumber": "<string>",
      "organization": "<string>",
      "email": "<string>",
      "url": "<string>",
      "fullName": "<string>"
    }
  ]
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE58DA6CBC941BC"
  },
  "message": {
    "contactMessage": {
      "displayName": "Guilherme Gomes",
      "vcard": "BEGIN:VCARD..."
    }
  },
  "messageTimestamp": "1717780437",
  "status": "PENDING"
}
POST

Send Reaction

Envia uma reação emoji para uma mensagem já existente.

/message/sendReaction/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
keyobjectobrigatório
Identificação da mensagem que receberá a reação: remoteJid, fromMe e id.
reactionstringobrigatório
Emoji de reação.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/message/sendReaction/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "key": {
    "remoteJid": "<string>",
    "fromMe": true,
    "id": "<string>"
  },
  "reaction": "<string>"
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE569F0E38F858D"
  },
  "message": {
    "reactionMessage": {
      "text": "",
      "senderTimestampMs": "1717781105034"
    }
  },
  "messageTimestamp": "1717781105",
  "status": "PENDING"
}
POST

Send Poll

Cria e envia uma enquete com nome, opções e quantidade de respostas selecionáveis.

/message/sendPoll/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número que receberá a mensagem, incluindo o código do país.
namestringobrigatório
Nome/título da enquete.
selectableCountintegerobrigatório
Quantidade de opções que podem ser selecionadas.
valuesstring[]obrigatório
Opções da enquete.
delayintegeropcional
Tempo de presença, em milissegundos, antes do envio.
linkPreviewbooleanopcional
Exibe prévia de link quando houver URL no conteúdo.
mentionsEveryOnebooleanopcional
Menciona todos os participantes quando aplicável.
mentionedenum<string>[]opcional
Lista de números/identificadores a mencionar. Opção documentada: {{remoteJID}}.
quotedobjectopcional
Objeto para responder/citar uma mensagem anterior.

Exemplos

cURL

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

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE53EC8D8E1FD8A"
  },
  "message": {
    "pollCreationMessage": {
      "name": "Poll Name",
      "options": [
        {
          "optionName": "Option 1"
        },
        {
          "optionName": "Option 2"
        }
      ],
      "selectableOptionsCount": 1
    }
  },
  "messageTimestamp": "1717781848",
  "status": "PENDING"
}

Chat Controller

Rotas para leitura, consulta e manutenção de chats, mensagens, presença e contatos.

14 endpoint(s)Header apikey
POST

Check is WhatsApp

Verifica se os números informados possuem conta no WhatsApp.

/chat/whatsappNumbers/{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 para executar a operação.

Body application/json

numbersstring[]obrigatório
Números com código do país a serem verificados.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/whatsappNumbers/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "numbers": [
    "<string>"
  ]
}
'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
[
  {
    "exists": true,
    "jid": "553198296801@s.whatsapp.net",
    "number": "553198296801"
  }
]
POST

Mark Message As Read

Marca uma ou mais mensagens como lidas.

/chat/markMessageAsRead/{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 para executar a operação.

Body application/json

readMessagesobject[]obrigatório
Mensagens a marcar como lidas. Cada item contém remoteJid, fromMe e id.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/markMessageAsRead/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "readMessages": [
    {
      "remoteJid": "<string>",
      "fromMe": true,
      "id": "<string>"
    }
  ]
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Read messages",
  "read": "success"
}
POST

Mark Message As Unread

Marca uma conversa como não lida a partir da última mensagem informada.

/chat/markChatUnread/{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 para executar a operação.

Body application/json

lastMessageobject[]obrigatório
Mensagens usadas como referência para marcar como não lida.
chatstringobrigatório
Remote JID do chat.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/markChatUnread/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastMessage": [
    {
      "remoteJid": "<string>",
      "fromMe": true,
      "id": "<string>"
    }
  ],
  "chat": "<string>"
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Read messages",
  "read": "success"
}
POST

Archive Chat

Arquiva ou desarquiva uma conversa.

/chat/archiveChat/{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 para executar a operação.

Body application/json

lastMessageobjectobrigatório
Última mensagem do chat, contendo key.remoteJid, key.fromMe e key.id.
archivebooleanobrigatório
Define se o chat será arquivado ou removido do arquivo.
chatstringobrigatório
Remote JID do chat.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/archiveChat/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastMessage": [
    {
      "remoteJid": "<string>",
      "fromMe": true,
      "id": "<string>"
    }
  ],
  "archive": true,
  "chat": "<string>"
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "chatId": "553198296801@s.whatsapp.net",
  "archived": true
}
DELETE

Delete Message for Everyone

Apaga uma mensagem para todos os participantes da conversa.

/chat/deleteMessageForEveryone/{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 para executar a operação.

Body application/json

idstringobrigatório
ID da mensagem.
remoteJidstringobrigatório
Remote JID do contato ou grupo.
fromMebooleanobrigatório
Indica se a mensagem foi enviada pela instância.
participantstringopcional
Participante em mensagens de grupo, quando aplicável.

Exemplos

cURL

Exemplo de requisição
curl --request DELETE \
  --url https://conectorwp.conversy.net/chat/deleteMessageForEveryone/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "remoteJid": "<string>",
  "fromMe": true,
  "participant": "<string>"
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.com",
    "fromMe": true,
    "id": "BAE5EABBD912C4E2"
  },
  "message": {
    "protocolMessage": {
      "type": "REVOKE"
    }
  },
  "messageTimestamp": "1718108455",
  "status": "PENDING"
}
POST

Update Message

Atualiza o conteúdo textual de uma mensagem enviada.

/chat/updateMessage/{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 para executar a operação.

Body application/json

numberintegerobrigatório
Número do destinatário com código do país.
textstringobrigatório
Novo conteúdo da mensagem.
keyobjectobrigatório
Chave da mensagem a atualizar: remoteJid, fromMe e id.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/updateMessage/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": 123,
  "text": "<string>",
  "key": {
    "remoteJid": "<string>",
    "fromMe": true,
    "id": "<string>"
  }
}
'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Send Presence

Envia presença de digitação/gravação para o chat antes de responder.

/chat/sendPresence/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número do destinatário com código do país.
optionsobjectobrigatório
Opções de presença: delay, presence e number.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/sendPresence/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "options": {
    "delay": 123,
    "presence": "composing",
    "number": "<string>"
  }
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Update Block Status

Bloqueia ou desbloqueia um contato.

/message/updateBlockStatus/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número com código do país.
statusstringobrigatório
Valores aceitos: block ou unblock.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/message/updateBlockStatus/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "status": "<string>"
}
'

Resposta

201 CreatedRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Fetch Profile Picture URL

Busca a URL da foto de perfil de um número/remoteJid.

/chat/fetchProfilePictureUrl/{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 para executar a operação.

Body application/json

numberstringobrigatório
Número ou remoteJid para consulta da foto de perfil.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/fetchProfilePictureUrl/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>"
}
'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "wuid": "553198296801@s.whatsapp.net",
  "profilePictureUrl": "https://pps.whatsapp.net/v/t61.2..."
}
POST

Get Base64

Obtém o base64 de uma mensagem de mídia; para vídeos, permite conversão para MP4.

/chat/getBase64FromMediaMessage/{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 para executar a operação.

Body application/json

messageobjectobrigatório
Mensagem de mídia contendo key.id.
convertToMp4booleanobrigatório
Converte vídeo para MP4 quando aplicável.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/getBase64FromMediaMessage/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": {
    "key": {
      "id": "<string>"
    }
  },
  "convertToMp4": true
}
'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Find Contacts

Lista todos os contatos ou filtra um contato usando where.

/chat/findContacts/{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 para executar a operação.

Body application/json

whereobjectobrigatório
Filtro opcional/obrigatório na documentação, por exemplo where.id.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/findContacts/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "where": {
    "id": "<string>"
  }
}
'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Find Messages

Busca mensagens salvas usando filtros dentro de where.

/chat/findMessages/{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 para executar a operação.

Body application/json

whereobjectobrigatório
Filtro de busca; exemplo: where.key.remoteJid.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/findMessages/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "where": {
    "id": "<string>"
  }
}
'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Find Status Message

Busca mensagens de status com filtros e limite de retorno.

/chat/findStatusMessage/{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 para executar a operação.

Body application/json

whereobjectobrigatório
Filtros como _id, id, remoteJid e fromMe.
limitintegeropcional
Limite de itens retornados.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/findStatusMessage/{instance} \
  --header 'apikey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "where": {
    "id": "<string>"
  },
  "limit": 123
}
'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}
POST

Find Chats

Lista todos os chats da instância.

/chat/findChats/{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 para executar a operação.

Body application/json

Este endpoint não possui body documentado.

Exemplos

cURL

Exemplo de requisição
curl --request POST \
  --url https://conectorwp.conversy.net/chat/findChats/{instance} \
  --header 'apikey: <api-key>'

Resposta

200 OKRetorno documentado para a operação.
Exemplo de retorno
{
  "message": "Esta resposta não possui body documentado."
}

Conversy API