Skip to main content
PUT
https://api.telzino.com
/
v1
/
agents
/
{agentId}
/
sip
/
registration
curl -X PUT https://api.telzino.com/v1/agents/123e4567-e89b-12d3-a456-426614174000/sip/registration \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "aor": "[email protected]",
    "sipRealm": "sip.example.com",
    "username": "agent",
    "password": "secure_password",
    "proxy": "proxy.example.com",
    "port": 5060,
    "transport": "UDP",
    "subscribe": false
  }'

{
  "success": true,
  "message": "SIP account registered successfully"
}

​
Path Parameters

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

​
Request Body

​
Required Fields

​
aor
string
required
Address of Record - the SIP URI for the agent.Format: [email protected]Example: [email protected]
​
sipRealm
string
required
SIP realm/domain for authentication.Example: sip.example.com
​
username
string
required
SIP username for authentication.Example: agent or 1001
​
password
string
required
SIP password for authentication.

​
Optional Fields

​
proxy
string
SIP proxy server address. Use this if your SIP provider requires routing through a proxy.Example: proxy.sip.example.com
​
port
integer
default:"5060"
SIP port number.Common values:
  • 5060 - Standard SIP (UDP/TCP)
  • 5061 - SIP over TLS
​
transport
string
default:"UDP"
Transport protocol.Supported values:
  • UDP - User Datagram Protocol (most common)
  • TCP - Transmission Control Protocol
  • TLS - Transport Layer Security (encrypted)
​
subscribe
boolean
default:"false"
Enable SIP SUBSCRIBE for presence/BLF (Busy Lamp Field).Set to true if you need presence information from the PBX.
curl -X PUT https://api.telzino.com/v1/agents/123e4567-e89b-12d3-a456-426614174000/sip/registration \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "aor": "[email protected]",
    "sipRealm": "sip.example.com",
    "username": "agent",
    "password": "secure_password",
    "proxy": "proxy.example.com",
    "port": 5060,
    "transport": "UDP",
    "subscribe": false
  }'

{
  "success": true,
  "message": "SIP account registered successfully"
}

​
How It Works

  1. API validates the SIP configuration
  2. Registers with SIP infrastructure using the provided credentials
  3. Stores configuration in the agent’s sip_registration_data field
  4. Agent can now receive inbound calls via the SIP address

​
Common PBX Configurations

​
FreePBX / Asterisk

{
  "aor": "[email protected]",
  "sipRealm": "pbx.local",
  "username": "100",
  "password": "extension_password",
  "port": 5060,
  "transport": "UDP"
}

​
3CX

{
  "aor": "[email protected]",
  "sipRealm": "company.3cx.us",
  "username": "agent",
  "password": "sip_password",
  "proxy": "company.3cx.us",
  "port": 5060,
  "transport": "TLS"
}

​
Twilio SIP

{
  "aor": "[email protected]",
  "sipRealm": "yourdomain.sip.twilio.com",
  "username": "agent",
  "password": "twilio_password",
  "port": 5060,
  "transport": "TLS"
}
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

ErrorCauseSolution
”Agent not found”Invalid agentId or no accessVerify the agent ID and your access token
”Failed to register SIP account”API errorCheck SIP credentials are correct
Agent not receiving callsSIP registration failedVerify sipRealm, username, password are correct
One-way audioNAT/firewall issuesTry TCP or TLS transport, check proxy settings