Loading
Cart Total
$0.00
-
Your shopping cart is empty
Loading
Hello! Log in Your Account
New customer? Start here
SIP Account Management
Storefronts
Customer Management
VoIP Bundle (Subscriptions)
SIP Account Management
Audio Management
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
eFax Management
Voicemails & Mailboxes
Caller ID
SIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
Call Queueing
Phone Books
VoIP Phone Speed Dial
Text (SMS) Messaging
A SIP User is a set of credentials that can be used to a configure a device to make and receive calls
Become a ResellerFilter:
* You will be charged every time this command is run.
Gets a list of all active SIP Users on an account
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"allow_direct_calls" : true,
"allow_multi_device" : true,
"allowed_caller_ids" : [
"884b3094-5775-47b0-bc8b-566448892175"
],
"call_encryption" : true,
"call_recording" : true,
"caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
"can_auto_deploy" : true,
"can_barge" : true,
"can_be_barged" : true,
"can_be_listened" : true,
"can_be_picked_up" : true,
"can_be_whispered" : true,
"can_invite_anonymously" : true,
"can_listen" : true,
"can_pickup" : true,
"can_whisper" : true,
"chat_enabled" : true,
"country_code" : "GB",
"created_on" : "2023-06-07",
"display_name" : "Pete Plumber",
"emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
"extension" : 1001,
"hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
"mobile_dnd" : false,
"mobile_dnd_allow_internal" : true,
"mute_chat_notifications" : false,
"personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
"restrict_caller_id" : true,
"restrict_outbound" : false,
"ring_duration" : 10,
"show_missed_calls" : true,
"timezone" : "Europe/London",
"transfer_backup_extension" : 1002,
"type" : 9,
"updated_on" : "2023-06-07",
"use_default_playlist" : true,
"use_direct_calls" : true,
"use_mailbox_on_transfer" : true,
"user_name" : "pete_plumber_9",
"user_password" : "A3WcdxQ0iCk98hnbE1",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets the status of the all SIP Users on an account
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"status" : "open",
"uuid" : "1efbe2a5-2c21-4b2c-a316-798c18f0c123"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets the details for a specific SIP User
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the SIP User to be queried
200 Response
{
"result" : {
"allow_direct_calls" : true,
"allow_multi_device" : true,
"allowed_caller_ids" : [
"884b3094-5775-47b0-bc8b-566448892175"
],
"call_encryption" : true,
"call_recording" : true,
"caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
"can_auto_deploy" : true,
"can_barge" : true,
"can_be_barged" : true,
"can_be_listened" : true,
"can_be_picked_up" : true,
"can_be_whispered" : true,
"can_invite_anonymously" : true,
"can_listen" : true,
"can_pickup" : true,
"can_whisper" : true,
"chat_enabled" : true,
"country_code" : "GB",
"created_on" : "2023-06-07",
"display_name" : "Pete Plumber",
"emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
"extension" : 1001,
"hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
"mobile_dnd" : false,
"mobile_dnd_allow_internal" : true,
"mute_chat_notifications" : false,
"personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
"restrict_caller_id" : true,
"restrict_outbound" : false,
"ring_duration" : 10,
"show_missed_calls" : true,
"timezone" : "Europe/London",
"transfer_backup_extension" : 1002,
"type" : 9,
"updated_on" : "2023-06-07",
"use_default_playlist" : true,
"use_direct_calls" : true,
"use_mailbox_on_transfer" : true,
"user_name" : "pete_plumber_9",
"user_password" : "A3WcdxQ0iCk98hnbE1",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Gets the status of the specified SIP User
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the SIP User to be queried
200 Response
{
"result" : {
"status" : "open",
"uuid" : "1efbe2a5-2c21-4b2c-a316-798c18f0c123"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Gets the queue availability for a specific SIP User
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the SIP user to be queried
200 Response
{
"result" : {
"available" : true
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Updates the queue availability for a specific SIP User
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the SIP user to be updated
PUT body
Name
Type
Required
available
Boolean
True
The availability of the SIP User
JSON all-fields example:
{
"available" : true
}
200 Response
{
"result" : {
"available" : true
},
"status_code" : 200,
"status_message" : "OK"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Creates a new SIP User
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
POST body
Name
Type
Required
allow_direct_calls
Boolean
False
Should this SIP user be reachable by their mobile number activated on the app
allow_multi_device
Boolean
False
Indicates if this user may link additional mobile devices using the QR code option
allowed_caller_ids
Array of String
False
List of Caller ID UUID's that the user is allowed to set
call_encryption
Boolean
False
Whether or not this User's call encryption is enabled
call_recording
Boolean
False
Whether or not this User's call recording is enabled
caller_id
String
False
The UUID of the caller ID to be used, if restrict_caller_id is set, this must be one of the allowed UUIDs
can_auto_deploy
Boolean
False
When set to true, this user can be automatically assigned to the mobile apps when a company code is used
can_barge
Boolean
False
Whether or not this User can use the Barge feature
can_be_barged
Boolean
False
Whether or not this User's calls can be Barged to
can_be_listened
Boolean
False
Whether or not this User's calls can be Listened to
can_be_picked_up
Boolean
False
Whether or not this User's calls can be Picked up
can_be_whispered
Boolean
False
Whether or not this User's calls can be Whispered to
can_invite_anonymously
Boolean
False
Whether or not this User accepts invites from unknown sources
can_listen
Boolean
False
Whether or not this User can use the Listen feature
can_pickup
Boolean
False
Whether or not this User can use the Pickup feature
can_whisper
Boolean
False
Whether or not this User can use the Whisper feature
chat_enabled
Boolean
False
Should this user be able to use the chat feature in the mobile and desktop apps
country_code
String
False
The default country for this user, this will remove the need to provide the +/00 country prefix on outbound calls to this country
display_name
String
True
The nickname for this User
emergency_caller_id
String
False
The UUID of the Caller ID used by the emergency services for outbound calls
extension
Integer
True
The extension number assigned to this User
hold_playlist
String
False
The UUID of the Playlist used as music on hold
mobile_dnd
Boolean
False
Do not send inbound calls to the users mobile apps when set to true
mobile_dnd_allow_internal
Boolean
False
When mobile_dnd is true, this setting allows internal calls (from the same account) to still be sent to the user, please note, this setting will not override the native DND setting on the users device
mute_chat_notifications
Boolean
False
Mutes all chat push notifications to the users mobile apps when set to true
personal_mailbox
String
False
The UUID of the Mailbox used as a personal mailbox
related_product
String
True
The Voip Bundle UUID to link this user to
restrict_caller_id
boolean
False
Should this user be limited in which caller ID's they can be assigned
restrict_outbound
Boolean
False
Allows outbound calling to be disabled for this SIP user
ring_duration
Integer
False
How long to ring this SIP user for
show_missed_calls
Boolean
False
Whether or not calls answered by another User show in this User's missed calls list
timezone
String
False
The Unix timezone to use for the user, for example this will change the time played on mailbox messages
transfer_backup_extension
Integer
False
If the user does not answer on a blind transfer, redirect to this extension
type
VoipUserType
True
The type of user to be created, the type must match the VoIP Bundle on the account
Starting Out is type 8 (with minutes) or 14 (pay as you go)
Flying High is 9 (with minutes) or 15 (pay as you go)
Enterprise is 10 (unlimited) or 16 (pay as you go)
use_default_playlist
Boolean
False
Whether or not the User uses the default playlist for Music on Hold
use_direct_calls
Boolean
False
When calling an external number, should this user attempt to call via the Yay.com platform initially
use_mailbox_on_transfer
Boolean
False
Go to the users personal mailbox if they do not answer during a blind transfer
user_name
String
True
The SIP Username for this User
user_password
String
True
The SIP Password for this User
JSON all-fields example:
{
"allow_direct_calls" : true,
"allow_multi_device" : true,
"allowed_caller_ids" : [
"884b3094-5775-47b0-bc8b-566448892175"
],
"call_encryption" : true,
"call_recording" : true,
"caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
"can_auto_deploy" : true,
"can_barge" : true,
"can_be_barged" : true,
"can_be_listened" : true,
"can_be_picked_up" : true,
"can_be_whispered" : true,
"can_invite_anonymously" : true,
"can_listen" : true,
"can_pickup" : true,
"can_whisper" : true,
"chat_enabled" : true,
"country_code" : "GB",
"display_name" : "Pete Plumber",
"emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
"extension" : 1001,
"hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
"mobile_dnd" : false,
"mobile_dnd_allow_internal" : true,
"mute_chat_notifications" : false,
"personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
"restrict_caller_id" : true,
"restrict_outbound" : false,
"ring_duration" : 10,
"show_missed_calls" : true,
"timezone" : "Europe/London",
"transfer_backup_extension" : 1002,
"type" : 9,
"use_default_playlist" : true,
"use_direct_calls" : true,
"use_mailbox_on_transfer" : true,
"user_name" : "pete_plumber_9",
"user_password" : "A3WcdxQ0iCk98hnbE1"
}
201 Response
{
"result" : {
"allow_direct_calls" : true,
"allow_multi_device" : true,
"allowed_caller_ids" : [
"884b3094-5775-47b0-bc8b-566448892175"
],
"call_encryption" : true,
"call_recording" : true,
"caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
"can_auto_deploy" : true,
"can_barge" : true,
"can_be_barged" : true,
"can_be_listened" : true,
"can_be_picked_up" : true,
"can_be_whispered" : true,
"can_invite_anonymously" : true,
"can_listen" : true,
"can_pickup" : true,
"can_whisper" : true,
"chat_enabled" : true,
"country_code" : "GB",
"created_on" : "2023-06-07",
"display_name" : "Pete Plumber",
"emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
"extension" : 1001,
"hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
"mobile_dnd" : false,
"mobile_dnd_allow_internal" : true,
"mute_chat_notifications" : false,
"personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
"restrict_caller_id" : true,
"restrict_outbound" : false,
"ring_duration" : 10,
"show_missed_calls" : true,
"timezone" : "Europe/London",
"transfer_backup_extension" : 1002,
"type" : 9,
"use_default_playlist" : true,
"use_direct_calls" : true,
"use_mailbox_on_transfer" : true,
"user_name" : "pete_plumber_9",
"user_password" : "A3WcdxQ0iCk98hnbE1",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Updates the specified SIP User
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the SIP user to be updated
PUT body
Name
Type
Required
allow_direct_calls
Boolean
False
Should this SIP user be reachable by their mobile number activated on the app
allow_multi_device
Boolean
False
Indicates if this user may link additional mobile devices using the QR code option
allowed_caller_ids
Array of String
False
List of Caller ID UUID's that the user is allowed to set
call_encryption
Boolean
False
Whether or not this User's call encryption is enabled
call_recording
Boolean
False
Whether or not this User's call recording is enabled
caller_id
String
False
The UUID of the caller ID to be used, if restrict_caller_id is set, this must be one of the allowed UUIDs
can_auto_deploy
Boolean
False
When set to true, this user can be automatically assigned to the mobile apps when a company code is used
can_barge
Boolean
False
Whether or not this User can use the Barge feature
can_be_barged
Boolean
False
Whether or not this User's calls can be Barged to
can_be_listened
Boolean
False
Whether or not this User's calls can be Listened to
can_be_picked_up
Boolean
False
Whether or not this User's calls can be Picked up
can_be_whispered
Boolean
False
Whether or not this User's calls can be Whispered to
can_invite_anonymously
Boolean
False
Whether or not this User accepts invites from unknown sources
can_listen
Boolean
False
Whether or not this User can use the Listen feature
can_pickup
Boolean
False
Whether or not this User can use the Pickup feature
can_whisper
Boolean
False
Whether or not this User can use the Whisper feature
chat_enabled
Boolean
False
Should this user be able to use the chat feature in the mobile and desktop apps
country_code
String
False
The default country for this user, this will remove the need to provide the +/00 country prefix on outbound calls to this country
display_name
String
True
The nickname for this User
emergency_caller_id
String
False
The UUID of the Caller ID used by the emergency services for outbound calls
extension
Integer
True
The extension number assigned to this User
hold_playlist
String
False
The UUID of the Playlist used as music on hold
mobile_dnd
Boolean
False
Do not send inbound calls to the users mobile apps when set to true
mobile_dnd_allow_internal
Boolean
False
When mobile_dnd is true, this setting allows internal calls (from the same account) to still be sent to the user, please note, this setting will not override the native DND setting on the users device
mute_chat_notifications
Boolean
False
Mutes all chat push notifications to the users mobile apps when set to true
personal_mailbox
String
False
The UUID of the Mailbox used as a personal mailbox
related_product
String
True
The Voip Bundle UUID to link this user to
restrict_caller_id
boolean
False
Should this user be limited in which caller ID's they can be assigned
restrict_outbound
Boolean
False
Allows outbound calling to be disabled for this SIP user
ring_duration
Integer
False
How long to ring this SIP user for
show_missed_calls
Boolean
False
Whether or not calls answered by another User show in this User's missed calls list
timezone
String
False
The Unix timezone to use for the user, for example this will change the time played on mailbox messages
transfer_backup_extension
Integer
False
If the user does not answer on a blind transfer, redirect to this extension
type
VoipUserType
True
The type of user to be created, the type must match the VoIP Bundle on the account
Starting Out is type 8 (with minutes) or 14 (pay as you go)
Flying High is 9 (with minutes) or 15 (pay as you go)
Enterprise is 10 (unlimited) or 16 (pay as you go)
use_default_playlist
Boolean
False
Whether or not the User uses the default playlist for Music on Hold
use_direct_calls
Boolean
False
When calling an external number, should this user attempt to call via the Yay.com platform initially
use_mailbox_on_transfer
Boolean
False
Go to the users personal mailbox if they do not answer during a blind transfer
user_name
String
True
The SIP Username for this User
user_password
String
True
The SIP Password for this User
JSON all-fields example:
{
"allow_direct_calls" : true,
"allow_multi_device" : true,
"allowed_caller_ids" : [
"884b3094-5775-47b0-bc8b-566448892175"
],
"call_encryption" : true,
"call_recording" : true,
"caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
"can_auto_deploy" : true,
"can_barge" : true,
"can_be_barged" : true,
"can_be_listened" : true,
"can_be_picked_up" : true,
"can_be_whispered" : true,
"can_invite_anonymously" : true,
"can_listen" : true,
"can_pickup" : true,
"can_whisper" : true,
"chat_enabled" : true,
"country_code" : "GB",
"display_name" : "Pete Plumber",
"emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
"extension" : 1001,
"hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
"mobile_dnd" : false,
"mobile_dnd_allow_internal" : true,
"mute_chat_notifications" : false,
"personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
"restrict_caller_id" : true,
"restrict_outbound" : false,
"ring_duration" : 10,
"show_missed_calls" : true,
"timezone" : "Europe/London",
"transfer_backup_extension" : 1002,
"type" : 9,
"use_default_playlist" : true,
"use_direct_calls" : true,
"use_mailbox_on_transfer" : true,
"user_name" : "pete_plumber_9",
"user_password" : "A3WcdxQ0iCk98hnbE1"
}
200 Response
{
"result" : {
"allow_direct_calls" : true,
"allow_multi_device" : true,
"allowed_caller_ids" : [
"884b3094-5775-47b0-bc8b-566448892175"
],
"call_encryption" : true,
"call_recording" : true,
"caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
"can_auto_deploy" : true,
"can_barge" : true,
"can_be_barged" : true,
"can_be_listened" : true,
"can_be_picked_up" : true,
"can_be_whispered" : true,
"can_invite_anonymously" : true,
"can_listen" : true,
"can_pickup" : true,
"can_whisper" : true,
"chat_enabled" : true,
"country_code" : "GB",
"created_on" : "2023-06-07",
"display_name" : "Pete Plumber",
"emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
"extension" : 1001,
"hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
"mobile_dnd" : false,
"mobile_dnd_allow_internal" : true,
"mute_chat_notifications" : false,
"personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
"restrict_caller_id" : true,
"restrict_outbound" : false,
"ring_duration" : 10,
"show_missed_calls" : true,
"timezone" : "Europe/London",
"transfer_backup_extension" : 1002,
"type" : 9,
"updated_on" : "2023-06-07",
"use_default_playlist" : true,
"use_direct_calls" : true,
"use_mailbox_on_transfer" : true,
"user_name" : "pete_plumber_9",
"user_password" : "A3WcdxQ0iCk98hnbE1",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Restores the specified deleted SIP User
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the SIP user to be restored
201 Response
{
"result" : {
"allow_direct_calls" : true,
"allow_multi_device" : true,
"allowed_caller_ids" : [
"884b3094-5775-47b0-bc8b-566448892175"
],
"call_encryption" : true,
"call_recording" : true,
"caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
"can_auto_deploy" : true,
"can_barge" : true,
"can_be_barged" : true,
"can_be_listened" : true,
"can_be_picked_up" : true,
"can_be_whispered" : true,
"can_invite_anonymously" : true,
"can_listen" : true,
"can_pickup" : true,
"can_whisper" : true,
"chat_enabled" : true,
"country_code" : "GB",
"created_on" : "2023-06-07",
"display_name" : "Pete Plumber",
"emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
"extension" : 1001,
"hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
"mobile_dnd" : false,
"mobile_dnd_allow_internal" : true,
"mute_chat_notifications" : false,
"personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
"related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
"restrict_caller_id" : true,
"restrict_outbound" : false,
"ring_duration" : 10,
"show_missed_calls" : true,
"timezone" : "Europe/London",
"transfer_backup_extension" : 1002,
"type" : 9,
"updated_on" : "2023-06-07",
"use_default_playlist" : true,
"use_direct_calls" : true,
"use_mailbox_on_transfer" : true,
"user_name" : "pete_plumber_9",
"user_password" : "A3WcdxQ0iCk98hnbE1",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Gets the next valid SIP User extension
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Deletes the specified SIP User
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the SIP user to be deleted
204 Response
{
"result" : {},
"status_code" : 204,
"status_message" : "No Content"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}