Agents
Set SIP Registration
Configure SIP registration settings for an agent to receive calls from a PBX or SIP provider
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.comstring
required
SIP username for authentication. Also used as the extension number.Example:
1001string
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.cominteger
default:"5060"
SIP port number.Common values:
5060- Standard SIP (UDP/TCP)5061- SIP over TLS
string
default:"udp"
Transport protocol.Supported values:
udp- User Datagram Protocol (most common)tcp- Transmission Control Protocoltls- 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:
+15551234567string
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@exampleHow It Works
- API validates the SIP configuration fields
- Stores configuration in the agent’s
sip_registration_datafield, withregistrationEnabledset to the value you provide (defaults totrue) - Sync service picks up the change via Supabase realtime and registers with OpenSIPS
- 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.
