Conexões SIP

CRUD completo para as conexões SIP da conta.

Endpoints

Método	Rota	Descrição
GET	/api/v1/sip-connections	Lista conexões
POST	/api/v1/sip-connections	Cria uma conexão
GET	/api/v1/sip-connections/{sip_connection}	Exibe uma conexão
PUT/PATCH	/api/v1/sip-connections/{sip_connection}	Atualiza uma conexão
DELETE	/api/v1/sip-connections/{sip_connection}	Remove uma conexão

Filtros de listagem

search, is_active, transport.

Campos

Campo	Tipo	Obrigatório	Descrição
name	string, max 255	Sim	Nome da conexão.
phone_number	string, max 30	Não	Número (DID/DDR).
description	string	Não	Observações livres.
is_active	boolean	Não	Padrão: conforme cadastro.
agent_id	integer	Não	ID de um agente ativo da conta, usado como fallback.
host	string, max 255	Sim	Servidor SIP da operadora.
port	integer (1–65535)	Sim	Porta do servidor SIP.
transport	string	Sim	udp, tcp ou tls.
username	string, max 255	Não	Usuário de autenticação.
password	string, max 255	Não	Senha de autenticação. Somente escrita — nunca é retornada.
realm	string, max 255	Não	Domínio de autenticação SIP.
from_domain	string, max 255	Não	Domínio usado nas chamadas de saída.
outbound_proxy	string, max 255	Não	Proxy de saída.
requires_registration	boolean	Não	Se o Rouxinol deve registrar as credenciais no servidor.
is_configured	boolean	Não	Marcação manual de homologação.

Exemplo de resposta

{
  "id": 5,
  "name": "Tronco Principal",
  "phone_number": "+551130001000",
  "description": null,
  "is_active": true,
  "agent_id": 12,
  "host": "sip.operadora.com.br",
  "port": 5060,
  "transport": "udp",
  "username": "rouxinol",
  "realm": "operadora.com.br",
  "from_domain": null,
  "outbound_proxy": null,
  "requires_registration": true,
  "is_configured": true,
  "created_at": "2026-08-01T12:00:00Z",
  "updated_at": "2026-08-01T12:00:00Z"
}

Note que o campo password não aparece na resposta.

Exemplos com curl

Listar conexões

curl "$ROUXINOL_URL/api/v1/sip-connections?transport=udp" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"

Criar uma conexão

curl -X POST "$ROUXINOL_URL/api/v1/sip-connections" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "Tronco Principal",
        "phone_number": "+551130001000",
        "agent_id": 12,
        "host": "sip.operadora.com.br",
        "port": 5060,
        "transport": "udp",
        "username": "rouxinol",
        "password": "senha-secreta",
        "requires_registration": true
      }'

Exibir uma conexão

curl "$ROUXINOL_URL/api/v1/sip-connections/5" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"

Atualizar uma conexão

curl -X PATCH "$ROUXINOL_URL/api/v1/sip-connections/5" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "is_configured": true }'

Remover uma conexão

curl -X DELETE "$ROUXINOL_URL/api/v1/sip-connections/5" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"