Passar uma conversa para um atendente

POST/v1/numbers/{phone_number_id}/handoff

A integração pede uma pessoa: a conversa automatizada do cliente vai para a fila dos atendentes (pending) e um aviso aparece na plataforma. Rota da Synergy, sem equivalente na Meta.

O cliente vai no CORPO (wa_id), nunca no caminho: caminhos acabam em logs, um telefone não deve.

Só a automação dona da conversa pode passá-la adiante: a conversa automatizada de outra chave responde 403. Se a conversa já não está com a automação, nada muda e a resposta traz o status atual. Este pedido não gera o evento synergy_conversations.

Requer#

Escopo da chave: Enviar mensagens messagesComo 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
Nome	Tipo	Obrigatório	Descrição
phone_number_id	string	obrigatório	O `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
Nome	Tipo	Obrigatório	Descrição
Authorization	string	obrigatório	Sua chave de API, no formato `Bearer <chave>`. Veja Autenticação.

Corpo#

Tipo de conteúdo: application/json.

Campos do corpo
Nome	Tipo	Obrigatório	Descrição
wa_id	string	obrigatório	O cliente da conversa. Só os dígitos são usados.

Respostas#

Respostas
Status	Código	Quando acontece
200	—	Conversa na fila
400	100	Falta `wa_id` (ou o corpo não é JSON)
401	190	Sem `Authorization: Bearer`, chave malformada ou forjada, chave revogada, ou chave sem acesso a este número
403	200	A chave não tem o escopo `messages`
403	1390004	O plano da organização não inclui a API
403	200	A conversa é da automação de outra chave
404	100	O `phone_number_id` não é um número ativo desta organização (ou não tem de 5 a 20 dígitos)
404	100	Não há conversa com este cliente neste número
429	130429	Mais de 2000 requisições em 10 s com esta chave neste número (`Retry-After: 10`)
429	130429	O número acabou de recusar por vazão, ou está sobrecarregado: o 429 se repete por 200 ms (`Retry-After: 1`)
503	2	Serviç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
Nome	Tipo	Obrigatório	Descrição
success	true	obrigatório
status	string	obrigatório	`pending` quando a conversa foi para a fila; se nada mudou, o status em que ela já estava. Valores: `pending`, `open`, `resolved`, `automated`.

Limites de taxa#

Borda: 2000 requisições a cada 10 s por chave × número (API_EDGE_LIMIT).

Notas#

Um corpo acima de 1024 bytes não é lido e responde o mesmo 400 de "falta wa_id".
Sem o Inbox no plano a recusa é a mesma de quem não tem a API: 403, código 1390004, com a mensagem da API.

Requisição

curl

curl -X POST 'https://api.synergyconnect.com.br/v1/numbers/106540352242922/handoff' \
  -H "Authorization: Bearer $SYNERGY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"wa_id":"5511999999999"}'

JavaScript

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

Python

import os

import requests

res = requests.post(
    "https://api.synergyconnect.com.br/v1/numbers/106540352242922/handoff",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
    json={
        "wa_id": "5511999999999",
    },
)
print(res.status_code, res.json())

Resposta

200

{
  "success": true,
  "status": "pending"
}

400

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

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á 3 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"
  }
}

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

429

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

Há 2 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.