Introdução

A API REST do SIP Caller permite que suas próprias aplicações trabalhem com a sua conta SIP Caller, da mesma forma que você faz a partir do Console Web. Use-a para conectar o SIP Caller ao seu CRM, ERP, helpdesk ou qualquer sistema interno, e automatizar suas operações de chamadas outbound de ponta a ponta.

Com a API você pode:

• Gerenciar campanhas: criar, editar, duplicar e excluir campanhas, e iniciá-las, pausá-las ou cancelá-las.
• Alimentar campanhas com números: adicionar números um a um ou em massa, com os valores de variáveis que seus fluxos de chamada e agentes de IA usam para personalizar cada chamada, ou copiá-los de uma lista de contatos.
• Manter suas listas sincronizadas: manter as listas negras e as listas de contatos a partir dos sistemas onde esses dados estão.
• Ler resultados: obter os detalhes de cada chamada e de cada número de uma campanha, para atualizar seus próprios registros com o desfecho.

A API é complementada pelos webhooks, que notificam seus sistemas em tempo real quando algo acontece no SIP Caller, como a ativação de uma campanha ou o término de uma chamada. Juntos, eles permitem criar integrações em que as campanhas são criadas, alimentadas e monitoradas sem trabalho manual.

A API REST e os webhooks estão disponíveis nos planos Enterprise do SIP Caller. Consulte a página de Preços para comparar os planos e seus recursos.

URL base

Todos os endpoints descritos nesta referência estão disponíveis na seguinte URL base:

https://api.sipcaller.com/v1

A API é servida somente por HTTPS. A versão (v1) faz parte da URL, e qualquer alteração incompatível com versões anteriores será lançada em uma nova versão, para que sua integração continue funcionando sem alterações.

Solicitações e respostas

A API segue as convenções REST:

• Os recursos são identificados por URLs, e as ações são expressas com métodos HTTP padrão: GET para ler, POST para criar, PUT para atualizar e DELETE para excluir.
• Os corpos das solicitações e das respostas são JSON, codificados em UTF-8. Envie o cabeçalho Content-Type: application/json em toda solicitação que tenha um corpo JSON.
• As solicitações bem-sucedidas retornam um código de status 2xx. Os erros retornam um código de status 4xx ou 5xx, com um corpo JSON que descreve o problema, conforme explicado em Erros.
• Os identificadores são UUIDs (por exemplo 01a0dedd-b9a2-729d-8e0a-4e3ad9197aea), exceto os números das campanhas, listas negras e listas de contatos, que são identificados por inteiros.
• As datas usam o formato YYYY-MM-DD, e os timestamps usam o formato ISO 8601 sem fuso horário (por exemplo 2026-09-26T17:57:48.064).

ID da conta

Todos os endpoints estão vinculados à sua conta SIP Caller, cujo ID faz parte da URL:

https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns

Você pode copiar o ID da sua conta no Console Web, conforme mostrado abaixo.

Os IDs de outros recursos, como as campanhas, podem ser obtidos pela própria API, ou copiados do Console Web:

Primeiros passos

1. Crie uma chave de API no Console Web, com as funções de que sua integração precisa.
2. Leia como autenticar suas solicitações.
3. Experimente o endpoint Listar campanhas para verificar se tudo funciona.
4. Explore a referência usando o menu à esquerda. Todos os endpoints incluem exemplos prontos para usar em cURL, Python, Java, Node.js e .NET: escolha sua linguagem no painel de código, e sua escolha será lembrada em todas as páginas.

Nos exemplos, substitua API_KEY_TOKEN, ACCOUNT_ID e os demais marcadores em maiúsculas pelos seus próprios valores.