Referência da API
Uma página por rota, gerada do documento OpenAPI 3.1 da API pública. Toda chamada leva a chave no cabeçalho Authorization: veja Autenticação.
Organização#
A chave, a organização e os números que ela alcança (qualquer escopo).
- GETQuem é esta chave
/v1/me - GETListar os números
/v1/numbers
Mensagens#
Envio pelo contrato da Cloud API.
- POSTEnviar uma mensagem
/{version}/{phone_number_id}/messages
Mídia#
Upload, consulta, download e remoção de arquivos.
- POSTEnviar um arquivo de mídia
/{version}/{phone_number_id}/media - GETConsultar uma mídia
/{version}/{media_id} - DELETEApagar uma mídia
/{version}/{media_id} - GETBaixar o arquivo de uma mídia
/{version}/{media_id}/download
Modelos#
Os modelos de mensagem da conta do número: ler (escopo `messages`), criar, editar, apagar e subir mídia de exemplo (escopo `management`).
- GETListar os modelos do número
/v1/numbers/{phone_number_id}/templates - POSTCriar um modelo
/v1/numbers/{phone_number_id}/templates - POSTSubir a mídia de exemplo de um modelo
/v1/numbers/{phone_number_id}/templates/media - GETConsultar um modelo
/v1/numbers/{phone_number_id}/templates/{template_id} - POSTEditar um modelo
/v1/numbers/{phone_number_id}/templates/{template_id} - DELETEApagar um modelo
/v1/numbers/{phone_number_id}/templates/{template_id}
Conversas#
Ler conversas, mensagens e contatos (escopo `read`, plano com Inbox) e a passagem entre a automação e os atendentes.
- POSTPassar uma conversa para um atendente
/v1/numbers/{phone_number_id}/handoff - GETListar as conversas
/v1/numbers/{phone_number_id}/conversations - POSTBuscar conversas
/v1/numbers/{phone_number_id}/conversations/search - GETO que mudou nas conversas
/v1/numbers/{phone_number_id}/conversations/changes - GETListar as mensagens de uma conversa
/v1/numbers/{phone_number_id}/conversations/{conversation_id}/messages - GETListar os cliques em anúncio
/v1/numbers/{phone_number_id}/referrals - POSTBuscar contatos
/v1/numbers/{phone_number_id}/contacts/search
Cadastro de números#
O cadastro hospedado: o seu cliente conecta o WhatsApp dele numa página da Synergy (escopo `onboarding`).
- POSTCriar uma sessão de cadastro de número
/v1/onboarding-sessions - GETConsultar uma sessão de cadastro
/v1/onboarding-sessions/{session_id} - POSTCancelar uma sessão de cadastro
/v1/onboarding-sessions/{session_id}/cancel
Flows#
WhatsApp Flows com endpoint da Synergy.
- POSTEmitir o flow_token de um envio de flow
/v1/numbers/{phone_number_id}/flows/{flow_id}/token
Jornadas#
Listar as Jornadas ativas de uma conta e iniciar uma de gatilho `api` (WhatsApp e Instagram).
- GETListar as Jornadas ativas
/{version}/{id}/journeys - POSTIniciar uma Jornada
/{version}/{id}/journeys/{journey_id}/runs
Webhooks#
A gestão dos webhooks da organização (escopo `management`).
- GETListar os webhooks
/v1/webhooks - POSTCriar um webhook
/v1/webhooks - GETConsultar a saúde dos webhooks
/v1/webhooks/health - GETConsultar as métricas de entrega
/v1/webhooks/stats - PATCHAlterar um webhook
/v1/webhooks/{hook_id} - DELETEApagar um webhook
/v1/webhooks/{hook_id} - POSTTrocar o segredo de um webhook
/v1/webhooks/{hook_id}/rotate-secret - POSTTentar entregar a fila agora
/v1/webhooks/{hook_id}/retry - POSTReenviar os eventos desde um momento
/v1/webhooks/{hook_id}/replay - POSTEnviar um evento de teste
/v1/webhooks/{hook_id}/test
Ficou com dúvida? Escreva para suporte@synergyconnect.com.br.