Skip to main content
PUT

Path Parameters

string
required
The unique identifier of the agent (UUID format)

Request Body

Required Fields

string
required
SIP domain for the registration.Example: sip.example.com
string
required
SIP username for authentication. Also used as the extension number.Example: 1001
string
required
SIP password for authentication.

Optional Fields

string
SIP proxy server address. Use this if your SIP provider requires routing through a proxy.Example: proxy.sip.example.com
integer | null
default:"5060"
Registrar/proxy port.Common values:
  • 5060 - Standard SIP (UDP/TCP)
  • 5061 - SIP over TLS
Send null to omit the port from the SIP URI, so the platform resolves the host by DNS SRV (with failover) instead of an A record. This is required for SRV-only hosts, which publish _sip._udp / _sip._tcp / _sips._tcp records and no A record. 0 is not accepted; null is the only “no port” spelling.
string
Optional User-Agent header sent on the outbound SIP REGISTER in place of the platform default. Use it when the registrar only accepts registrations from specific phone models, for example Yealink SIP-T54W 96.86.0.75. Printable ASCII only, a single line, at most 255 characters. Omit or send an empty string to use the default.
string
default:"udp"
Transport protocol.Supported values:
  • udp - User Datagram Protocol (most common)
  • tcp - Transmission Control Protocol
  • tls - Transport Layer Security (encrypted)
boolean
default:"false"
Enable SIP SUBSCRIBE for presence/BLF (Busy Lamp Field).Set to true if you need presence information from the PBX.
boolean
default:"true"
Whether the SIP registration is active.Defaults to true when omitted, so saving a registration enables it. Set to false to disable the registration — marking the agent inactive — while keeping its SIP configuration stored. Use the DELETE method instead if you want to remove the configuration entirely.
string
Optional authentication username, if different from the SIP username.Some providers use a separate auth identity. If not set, username is used for authentication.
string
DID (Direct Inward Dialing) number to send in the SIP INVITE.Example: +15551234567
string
Optional value sent in the SIP X-Dest-User routing header. Used by upstream providers/PBXs that route calls based on a destination user identifier rather than the SIP username.Sent on the wire only when set. Empty strings are treated as unset.Allowed characters: a-z, A-Z, 0-9, and . _ + @ ~ / -Example: routing.user+1@example

How It Works

  1. API validates the SIP configuration fields
  2. Stores configuration in the agent’s sip_registration_data field, with registrationEnabled set to the value you provide (defaults to true)
  3. Sync service picks up the change via Supabase realtime and registers with OpenSIPS
  4. Agent can now receive inbound calls via the SIP registration
The extension field is automatically set to match username. The registrationEnabled flag defaults to true when saving — so saving a registration enables it unless you explicitly pass registrationEnabled: false.

Common PBX Configurations

FreePBX / Asterisk

3CX

Twilio SIP

After configuring SIP registration, the agent will automatically receive calls sent to the configured SIP address. Make sure your PBX or SIP provider is configured to route calls to this address.

Troubleshooting