SIP Guide (PREVIEW)
Create incoming & outgoing SIP calls with Ultravox agents.
SIP calls are currently free of charge while in preview but will incur an additional $0.01 per minute charge when it moves to full release.
Session Initiation Protocol (SIP) enables Ultravox agents to connect with your existing phone systems and SIP clients. This guide explains how to set up both incoming and outgoing SIP calls with Ultravox agents.
SIP Quickstart
The fastest way to start using SIP with Ultravox:
Create an Agent
Create a SIP Call
sip
medium.Make sure you have an Ultravox API key. You can create one in the console.
SIP Overview
Ultravox uses a medium
for each call, which defines how the call will occur. When using sip
as the medium, you can connect your Ultravox agents with standard SIP-compatible systems.
You can create a SIP call with the Ultravox Realtime Create Agent Call or Create Call endpoints using the sip
medium.
The sip
medium supports the creation of both incoming and outgoing calls.
Incoming SIP Calls
Incoming calls are initiated by a SIP client to your Ultravox agent. When the Ultravox incoming SIP call is created, the returned join URL is a SIP URI to which an invite can be sent.
Outgoing SIP Calls
Outgoing calls are when Ultravox initiates the call to a SIP endpoint or client. The configuration varies slightly depending on which SIP client/system you’re using.
When creating an outbound SIP call, Ultravox will initiate the call directly and no join URL will be returned.
Create an Outgoing SIP Call
For outgoing SIP calls, you’ll need to add the outgoing
configuration data for the sip
medium and add it to the request body of the Create Agent Call or Create Call request:
Linphone Example
Create an Incoming SIP Call
For incoming SIP calls, you’ll need to use incoming
for the sip
medium and add it to the request body of the Create Agent Call or Create Call request. This will return a joinUrl
that can be used to connect to a SIP client.
Supported Codecs
Ultravox Realtime currently supports the following codecs for SIP:
- PCMA
- PCMU
Using any other codec will cause calls to fail.
Integrations
- jambonz enables SIP connections and has an integration for Ultravox. Learn more.
- Voximplant Provides a native connector for Ultravox. Learn more