organization_id
UUID
obrigatório
Identificador da organização consultada. Continua obrigatório mesmo com API key.
Buscar contatos por mensagens
GET
https://crm.oficinamartech.com/api/contacts/message-search
•••
Retorna contatos de uma organização que mencionaram uma palavra, frase ou lista de termos em mensagens.
Escopos
contacts:read + messages:read
Requisições recentes
Entre no CRM para ver histórico completo
Horário
Status
Agente
Faça uma requisição para ver o histórico.
Parâmetros de consulta
q
string
Palavra ou frase única para busca. Exemplo: produto exemplo.
keywords
string
Lista separada por vírgula, ponto e vírgula ou quebra de linha.
keyword
string[]
Parâmetro repetível para múltiplas frases.
match
any | all
Define se qualquer termo basta ou se todos devem aparecer. Padrão: any.
direction
inbound | outbound | all
Filtra mensagens recebidas, enviadas ou ambas. Padrão: inbound.
channel
whatsapp | whatsapp_cloud_api | instagram | telegram | email
Filtra conversas por canal.
from
date-time
Início do período em ISO 8601.
to
date-time
Fim do período em ISO 8601.
limit
integer
Quantidade de contatos retornados por página. Máximo: 100. Padrão: 50.
offset
integer
Deslocamento da página atual. Use junto com limit para paginação.
messages_limit
integer
Amostras de mensagens por contato. Máximo: 20. Padrão: 3.
Respostas
Sucesso
Requisição concluída com sucesso.
Requisição inválida
Parâmetros inválidos, paginação fora do limite ou nenhum termo informado.
Não autorizado
API key ausente, inválida, revogada ou expirada.
Acesso negado
Escopo ausente ou organização não autorizada para a chave.
Erro interno
Erro interno. Repetir com backoff e registrar a requisição.
Atualizado em 19/05/2026