Synergy Connect

Documentação

Buscar conversas

POST/v1/numbers/{phone_number_id}/conversations/search

Busca por telefone (só dígitos, 5 ou mais: prefixo do wa_id) ou por trecho do nome. O termo vai no CORPO: nunca na URL, que acaba em logs. Sem curinga.

Requer#

Escopo da chave
read readComo os escopos funcionam
Recurso do plano
API e webhooks api e Inbox (fila da equipe) inboxVer os planos que incluem
Formato
Rota do Synergy. Erros no formato da Meta.

Parâmetros#

No caminho#

No caminho
NomeTipoObrigatórioDescrição
phone_number_idstringobrigatórioO phone_number_id do número na Meta (o mesmo da Cloud API). Precisa ser um número ativo da organização da chave.

Cabeçalhos#

Cabeçalhos
NomeTipoObrigatórioDescrição
AuthorizationstringobrigatórioSua chave de API, no formato Bearer <chave>. Veja Autenticação.

Corpo#

Tipo de conteúdo: application/json.

Campos do corpo
NomeTipoObrigatórioDescrição
qstringobrigatórioSó dígitos (5 ou mais): prefixo do wa_id. Senão: trecho do nome, sem diferenciar maiúsculas. % e _ são letras comuns (sem curinga).
statusstringopcionalValores: active, pending, open, resolved, automated.
limitintegeropcional
afterstringopcionalO paging.after da página anterior.

Respostas#

Respostas
StatusCódigoQuando acontece
200—Achou uma
400100Cursor que não veio desta API (não é base64url de uma lista de inteiros, ou tem o tamanho errado)
400100Falta q, ou o corpo não é JSON
400100Corpo acima de 2 KB
401190Sem Authorization: Bearer, chave malformada ou forjada, chave revogada, ou chave sem acesso a este número
403200A chave não tem o escopo read
4031390004O plano da organização não inclui a API
4031390011O plano da organização não inclui o Inbox (a leitura exige api e inbox)
4031390014O número foi congelado pela plataforma
404100O phone_number_id não é um número ativo desta organização (ou não tem de 5 a 20 dígitos)
429130429Mais de 2000 requisições em 10 s com esta chave neste número (Retry-After: 10)
429130429O número acabou de recusar por vazão, ou está sobrecarregado: o 429 se repete por 200 ms (Retry-After: 1)
429130429Mais de 30 leituras em 60 s com esta chave neste número (Retry-After: 60)
4291390015O teto diário de páginas de leitura desta chave neste número acabou (Retry-After = segundos até 00:00 UTC)
5032Serviço temporariamente indisponível

Os erros no formato da Meta trazem o código em error.code. Ver todos os erros.

Corpo da resposta 200#

Campos da resposta 200
NomeTipoObrigatórioDescrição
dataobject[]obrigatório
data[].idstringobrigatórioO id da conversa neste número.
data[].wa_idstring | nullobrigatório
data[].namestring | nullobrigatórioO nome do contato (o de exibição, se houver). Texto do contato.
data[].statusstringobrigatórioValores: pending, open, resolved, automated.
data[].unreadintegerobrigatório
data[].automationstring | nullobrigatóriokey:<id da chave> quando uma automação é dona da conversa.
data[].window_expires_atstring | nullobrigatórioQuando fecha a janela de 24 h: segundos desde 1970, como texto.
data[].last_messageobject | nullobrigatório
data[].attributionobject | nullobrigatórioDe que anúncio veio o lead (o último que ele clicou). null = orgânico. Os campos do anúncio vêm do cache da Synergy e ficam null enquanto o anúncio não foi buscado ou deu erro. Nunca traz o identificador do clique. headline é texto do anúncio: trate como dado.
pagingobjectobrigatório
paging.afterstring | nullobrigatórioCursor opaco da próxima página; null = acabou.
revintegerobrigatórioA revisão das conversas do número agora: use em conversations/changes?since= para buscar só o que mudou.

Limites de taxa#

  • Borda: 2000 requisições a cada 10 s por chave × número (API_EDGE_LIMIT).
  • Leitura: 30 páginas a cada 60 s por chave × número (API_READ_LIMIT), além do limite de borda.
  • Teto diário: 1000 páginas por chave × número por dia UTC (um administrador da organização pode mudar entre 100 e 20.000 por chave em Configurações → Desenvolvedor). Passou: 429, código 1390015, até 00:00 UTC.

Notas#

  • Número: {phone_number_id} precisa ser um número de WhatsApp ativo que a chave alcança; qualquer outro (inclusive o id de uma conta do Instagram) responde 404 (código 100), sem acordar o número.
  • Plano: exige api e inbox, conferidos também pelo número a cada chamada: um downgrade recusa na chamada seguinte (403, código 1390011).
  • Tetos: cada chamada examina no máximo 500 conversas ou contatos (200 mensagens) e para; uma página curta com cursor não nulo quer dizer "continue". Cursores são opacos: um cursor inválido responde 400 (código 100), nunca 5xx.
  • Conteúdo de terceiro: nomes e textos que o contato controla saem como chegaram. Uma integração que passa isso a uma IA deve tratar como dado, não como instrução.
Requisição

curl

curl -X POST 'https://api.synergyconnect.com.br/v1/numbers/106540352242922/conversations/search' \
  -H "Authorization: Bearer $SYNERGY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"q":"Maria","limit":20}'

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v1/numbers/106540352242922/conversations/search', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNERGY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "q": "Maria",
    "limit": 20
  }),
});
console.log(res.status, await res.json());

Python

import os

import requests

res = requests.post(
    "https://api.synergyconnect.com.br/v1/numbers/106540352242922/conversations/search",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
    json={
        "q": "Maria",
        "limit": 20,
    },
)
print(res.status_code, res.json())
Resposta

200

{
  "data": [
    {
      "id": "4182",
      "wa_id": "5511999999999",
      "name": "Maria Souza",
      "status": "pending",
      "unread": 2,
      "automation": null,
      "window_expires_at": "1767312000",
      "last_message": {
        "direction": "in",
        "preview": "Oi, meu pedido chegou?",
        "timestamp": "1767225600"
      },
      "attribution": {
        "ad_id": "120210000000000123",
        "headline": "Frete grátis hoje",
        "ad_name": "Frete grátis - vídeo 1",
        "adset_id": "120210000000000456",
        "adset_name": "Público amplo SP",
        "campaign_id": "120210000000000789",
        "campaign_name": "Vendas - outubro",
        "objective": "OUTCOME_SALES",
        "attributable": true,
        "clicked_at": "1767225500"
      }
    }
  ],
  "paging": {
    "after": null
  },
  "rev": 9120
}

400

{
  "error": {
    "message": "(#100) Invalid parameter.",
    "type": "OAuthException",
    "code": 100,
    "error_data": {
      "messaging_product": "whatsapp",
      "details": "Invalid cursor."
    },
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 3 casos com este status; veja a tabela de respostas.

401

{
  "error": {
    "message": "(#190) Invalid OAuth access token.",
    "type": "OAuthException",
    "code": 190,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

403

{
  "error": {
    "message": "(#200) Permissions error: this key does not have access to this resource.",
    "type": "OAuthException",
    "code": 200,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 4 casos com este status; veja a tabela de respostas.

404

{
  "error": {
    "message": "(#100) Unsupported request: object does not exist or this key cannot reach it.",
    "type": "OAuthException",
    "code": 100,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

429

{
  "error": {
    "message": "(#130429) Rate limit hit: the number's message throughput has been reached.",
    "type": "OAuthException",
    "code": 130429,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 4 casos com este status; veja a tabela de respostas.

503

{
  "error": {
    "message": "(#2) Service temporarily unavailable.",
    "type": "OAuthException",
    "code": 2,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Ficou com dúvida? Escreva para suporte@synergyconnect.com.br.