SIP UAC
The SIP UAC resource configures an agent's SIP registration. Once set, the agent registers to the specified PBX and behaves as a fully capable SIP user agent for as long as the registration is active.
What the agent can do once registered
- Receive inbound calls — the PBX routes calls to the agent's address of record (AOR); the agent answers and begins the conversation
- Initiate outbound calls — the agent dials a specified number through the PBX
- Transfer calls — both cold (unattended) transfer, where the call is handed off immediately, and warm (attended) transfer, where the agent introduces the caller before completing the transfer
No further API interaction is required once the agent is registered. Calls arrive and are handled automatically.
Configuration
SIP UAC is configured per agent with PUT /agents/:id/sip-uac. The operation is an upsert — it creates the registration if one doesn't exist, or replaces it entirely if it does.
curl -X PUT https://api.simwood.com/convai/v1/agents/<agent-id>/sip-uac \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"sip_username": "agent-001",
"sip_domain": "pbx.example.com",
"sip_password": "secret",
"sip_registrar": "sip.example.com"
}'
| Field | Required | Description |
|---|---|---|
sip_username |
Yes | The SIP username the agent registers with |
sip_domain |
Yes | The SIP domain |
sip_password |
No | SIP registration password |
sip_registrar |
No | Explicit registrar address; defaults to sip_domain if omitted |
aor |
No | Address of record override; defaults to sip_username@sip_domain |
Retrieving the current configuration
curl https://api.simwood.com/convai/v1/agents/<agent-id>/sip-uac \
-H "Authorization: Bearer sk_live_..."
The response includes the aor the agent is registered under. The sip_password is not returned.
Deregistering
Deleting the SIP UAC configuration deregisters the agent and stops it from receiving or initiating calls:
curl -X DELETE https://api.simwood.com/convai/v1/agents/<agent-id>/sip-uac \
-H "Authorization: Bearer sk_live_..."
Deleting an agent (DELETE /agents/:id) also removes its SIP UAC configuration and deregisters it.