Skip to content

SIP Devices

A SIP device is a device that handles a call to an extension. Go to Settings β†’ Devices β†’ SIP devices to manage your SIP devices.

A SIP device can be:

This page is the field reference. For choosing between the device types and the end-to-end setup, see How Devices Work and Set Up Calling for Your Agents.

What Is the Difference Between an Extension and a Device?

Explained, with an example, in How Devices Work.

Device Details

To use your SIP device, set up the following important settings.

Setting Description
Device / Number Enter a number. The device number must be unique and cannot be changed later. You will need it to sign in to your hardware or software phone.
Title Enter a title. The device's title will be displayed in your device list.
Password Enter a password. You will need to enter the password in your hardware or software phone settings.
Transport Select the protocol used to transmit communication. We recommend using the default udp protocol for most hardware and software phone use and wss protocol for WebRTC.
Language Select the language of PBX voice messages.

Optionally, you can also set up the following:

Setting Description
Description Enter a description that will help you identify the device in future.
Pickup member Enter the number (0–63) of the device group that can perform a General call pickup (default feature code *8) on this device. See the example below the table.
Pickup allow Enter the number (0–63) of the device group on which this device can perform a General call pickup (default feature code *8). See the example below the table.
Voicemail enable Turn on to activate voicemail on the SIP device. You can access it using a feature code (the default code for accessing your own voicemail is 97; to access other devices' voicemail, use 98). Warning: Messages shorter than 3 seconds are ignored by the voicemail system.
Voicemail PIN Enter a PIN to access your voicemail.
Voicemail email Enter an email address where a notification email will be sent when you receive a new voicemail message.
Voicemail attachment Turn on if you want to receive the voicemail recording as an attachment to the email notification. An email address must be set in Voicemail email.
Delete voicemail after send Turn on if you want to automatically delete the voicemail message after an email with the recording is sent out.
How long is voicemail stored Select for how long you want your voice mail to be stored.
Available for dynamic selection Turn on to make this device available for agents to select dynamically from the navbar. Turn off to only make it possible to assign the device from Settings β†’ Users β†’ List of Users.
SIP headers template Example: {"X-UserId": "${HASH(call,activity.user.id)}", "X-UserName": "${HASH(call,activity.user.name)}", "X-UserExtension": "${HASH(call,activity.user.extension)}", "X-Extension": "${HASH(call,activity.endpoint)}", "X-CallName": "${HASH(call,activity.call.name)}", "X-CallDid": "${HASH(call,activity.call.did)}", "X-CallClid": "${HASH(call,activity.call.clid)}", "X-CallOptions": "${HASH(call,activity.call.options)}", "X-ActivityName": "${HASH(call,activity.name)}", "X-QueueId": "${HASH(call,activity.queue.id)}", "X-QueueName": "${HASH(call,activity.queue.name)}"} β€” the parameters "QueueId" and "QueueName" are displayed if there is a queue.
Username R-URI Leave empty – expert setting.

Call pickup example

In the device details of devices SIP1 and SIP2, enter "15" into the Pickup member field. In the device details of device SIP3, enter "15" into the Pickup allow and the Pickup member fields. The device SIP3 will be able to answer a call that is ringing on either of the devices SIP1 and SIP2. Devices SIP1 and SIP2 cannot answer calls ringing on any other devices.

Save your device.

Working With Devices

When you have set up your device, assign it to a user in Settings β†’ Users β†’ List of Users or make it available for agents to pick themselves β€” see Permanent Assignment vs Dynamic Selection.