Config API Version 2 SIP Phone System

Introduction

Infinity Tracking can provide a hosted phone system on SIP (Session Initiation Protocol).

This section describes the API routes available to configure domains, users, groups and queues in the system.

List SIP Domains

Lists the SIP Domains you have access to.

Request:

GET /config/v2/sip/domains

Response:

HTTP 200 - OK

SIP Domain rows.

Read SIP Domain

Returns the properties for a particular SIP Domain.

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}

Response:

HTTP 200 - OK

SIP Domain row.

Update SIP Domain

Updates a particular SIP domain

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

POST Params

displayName (string) - The display name of the SIP domain
rec (int) - A flag (1 or 0) to enable call recording

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}

Response:

HTTP 204 - NO CONTENT

List SIP Users

Lists the SIP Users in a domain.

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/users

Response:

HTTP 200 - OK

SIP User rows.

Read SIP User

Returns the properties for a particular SIP User.

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - User ID.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}

Response:

HTTP 200 - OK

SIP User row.

Create SIP User

Create a new SIP User.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/users

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

POST Params

user (string) - User Name (e.g. joe.blogs)
password (string) - Password
displayName (string) - Display Name (e.g. Joe Blogs)
pin (string) OPTIONAL - Pin number for hotdesking
extensionNumber (string) - Internal Extension number (calleable by other users within the same domain)
email (string) OPTIONAL - E-Mail Address (e.g. joe.blogs@company.com)
firstName (string) OPTIONAL - First Name (e.g. Joe)
lastName (string) OPTIONAL - Last Name (e.g. Blogs)
jobName (string) OPTIONAL - Job Name
departmentName (string) OPTIONAL - Department Name
companyName (string) OPTIONAL - Company Name
officeName (string) OPTIONAL - Office Name
ukCallerId (string) OPTIONAL - Caller ID to use when calling UK phone numbers
usCallerId (string) OPTIONAL - Caller ID to use when calling US phone numbers
mobileNumber (string) OPTIONAL - Mobile number of user, if specified will forward missed calls to this number.
mobileFollow (int) OPTIONAL - Enable/Disable follow to mobile number if no answer from SIP devices.
ukPhoneId (int) OPTIONAL - Phone ID to provision for this user
usPhoneId (int) OPTIONAL - Phone ID to provision for this user
hotdeskAllowed (tinyint) OPTIONAL - Enable/Disable whether hot desking login with a pin number is allowed for this user.
dashboard (int) OPTIONAL - Flag which indicates whether user should be displayed on real-time dashboard.

Response:

HTTP 201 - CREATED

Update SIP User

Update the properties for a particular SIP User.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - User ID.

POST Params

password (string) OPTIONAL - Password
displayName (string) OPTIONAL - Display Name (e.g. Joe Blogs)
pin (string) OPTIONAL - Pin number for hotdesking
email (string) OPTIONAL - E-Mail Address (e.g. joe.blogs@company.com)
firstName (string) OPTIONAL - First Name (e.g. Joe)
lastName (string) OPTIONAL - Last Name (e.g. Blogs)
jobName (string) OPTIONAL - Job Name
departmentName (string) OPTIONAL - Department Name
companyName (string) OPTIONAL - Company Name
officeName (string) OPTIONAL - Office Name
extensionNumber (string) OPTIONAL - Internal Extension number (calleable by other users within the same domain)
ukCallerId (string) OPTIONAL - Caller ID to use when calling UK phone numbers
usCallerId (string) OPTIONAL - Caller ID to use when calling US phone numbers
mobileNumber (string) OPTIONAL - Mobile number of user, if specified will forward missed calls to this number.
mobileFollow (int) OPTIONAL - Enable/Disable follow to mobile number if no answer from SIP devices.
hotdeskAllowed (tinyint) OPTIONAL - Enable/Disable whether hot desking login with a pin number is allowed for this user.
dashboard (int) OPTIONAL - Flag which indicates whether user should be displayed on real-time dashboard.

Response:

HTTP 204 - NO CONTENT

Delete SIP User

Delete a particular SIP User.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - User ID.

Response:

HTTP 204 - NO CONTENT

List SIP Groups

Lists the SIP Groups for a domain.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

Response:

HTTP 200 - OK

SIP Group rows.

Read SIP Group

Returns the properties for a particular SIP Group.

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
GROUP SPECIFIER (int) - SIP Group ID.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups/{GROUP SPECIFIER}

Response:

HTTP 200 - OK

SIP Group row.

Create SIP Group

Create a new SIP Group.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

POST Params

groupName (string) - Group Name (e.g. sales)
displayName (string) - Display Name (e.g. Sales Dept)
extensionNumber (string) - Extension number for the group
ringRetry (int) - A flag (1 or 0) to enable ring retry
ringExclusive (int) - A flag (1 or 0) to enable call queuing for this group
callerNameFormat (string) - A formatting string for the group that is presented to the device. See callerNameFormat below

callerNameFormat

The formatting string can contain any of the variables defined below using brackets

displayName
srcPhoneNumber
dgrpName

E.g. for ‘displayName - srcPhoneNumber’ use ‘{displayName} - {srcPhoneNumber}’. This will be compiled to ‘Group display name - 0123456789’

Response:

HTTP 201 - CREATED

Update SIP Group

Update a SIP Group.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups/{GROUP SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
GROUP SPECIFIER (int) - SIP Group ID.

POST Params

groupName (string) - Group Name (e.g. sales)
displayName (string) - Display Name (e.g. Sales Dept)
extensionNumber (string) - Extension number for the group
ringRetry (int) - A flag (1 or 0) to enable ring retry
ringExclusive (int) - A flag (1 or 0) to enable call queuing for this group
callerNameFormat (string) - A formatting string for the group that is presented to the device. See callerNameFormat above

Response:

HTTP 204 - NO CONTENT

Delete SIP Group

Delete a particular SIP Group.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups/{GROUP SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
GROUP SPECIFIER (int) - SIP Group ID.

Response:

HTTP 204 - NO CONTENT

List SIP Group Users

Lists the Users who are members of a SIP Group for a domain.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups/{GROUP SPECIFIER}/users

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
GROUP SPECIFIER (int) - SIP Group ID.

Response:

HTTP 200 - OK

SIP Group User rows.

Add SIP Group Users

Add Users to a SIP Group for a domain.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups/{GROUP SPECIFIER}/users

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
GROUP SPECIFIER (int) - SIP Group ID.

POST Params

userSpec (array) - Array of SIP User IDs (int) to add to group.

Response:

HTTP 204 - NO CONTENT

Delete SIP Group Users

Delete Users from a SIP Group for a domain.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/groups/{GROUP SPECIFIER}/users

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
GROUP SPECIFIER (int) - SIP Group ID.

POST Params

userSpec (array) - Array of SIP User IDs (int) to delete from group.

Response:

HTTP 204 - NO CONTENT

List PBX User Devices

Lists the PBX devices that a SIP user is associated with.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}/devices

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - SIP user ID.

GET Params

filter (array) - One or more filters (see filter types)
sort (array) - One or more sort fields (see sort types)
limit (int) - A limit on the result set
offset (int) - An offset for the result set

Filter Fields

Any of the returned fields

Sort Fields

Any of the returned fields

Response:

Returns a list of all PBX devices that a user is associated with.

userId (int) - The user ID.
pbxDeviceId (int) - The ID of the PBX device.
user (string) - The SIP user name.
updateDatetime (datetime) - The datetime this record was last updated.
pbxDeviceName (string) - The name of the PBX device.

HTTP 200 - OK

{"userId":"1","pbxDeviceId":"1","user":"user.name","updateDatetime":"2001-01-01 00:00:00","pbxDeviceName":"deviceName 1"}
{"userId":"1","pbxDeviceId":"2","user":"user.name","updateDatetime":"2001-01-01 00:00:00","pbxDeviceName":"deviceName 2"}

Read PBX User Device

Reads a single PBX device that a SIP user is associated with.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}/devices/{DEVICE SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - SIP user ID.
DEVICE SPECIFIER (int) - PBX device ID.

Response:

Returns a single PBX devices that a user is associated with.

userId (int) - The user ID.
pbxDeviceId (int) - The ID of the PBX device.
user (string) - The SIP user.
updateDatetime (datetime) - The datetime this record was last updated.
pbxDeviceName (string) - The name of the PBX device.

HTTP 200 - OK

{"userId":"1","pbxDeviceId":"1","user":"user.name","updateDatetime":"2001-01-01 00:00:00","pbxDeviceName":"deviceName 1"}

Create PBX User Device

Creates a new PBX user device association with a SIP user.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}/devices

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - SIP user ID.

POST Params

pbxDeviceId (int) - The ID of the PBX device that is to be associated to the SIP user.

Response:

Returns the HTTP 201 (Created) status code if successful.

HTTP 201 - CREATED

Returns the entire newly created PBX user device:

{"pbxDeviceId":"1","userId":"1","pbxDeviceToken":"432e2286a22f28a3e3a4d2dde"}

Delete PBX User Device

Deletes the association between PBX device and a SIP user.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}/devices/{DEVICE SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - SIP user ID.
DEVICE SPECIFIER (int) - PBX device ID.

Response:

HTTP 204 - NO CONTENT

List SIP User Groups

Lists the groups for a SIP user for a domain.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}/groups

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - User ID.

GET Params

filter (array) - One or more filters (see filter types)
sort (array) - One or more sort fields (see sort types)
limit (int) - A limit on the result set
offset (int) - An offset for the result set

Filter Fields

Any of the returned fields

Sort Fields

Any of the returned fields

Response:

HTTP 200 - OK

SIP User Group rows.

Add SIP User Groups

Add groups to a SIP user for a domain.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/users/{USER SPECIFIER}/groups

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
USER SPECIFIER (int) - User ID.

POST Params

groupSpec (array) - Array of SIP Group IDs (int) to add to user.

Response:

HTTP 204 - NO CONTENT

List SIP queues

Lists the SIP queues for a domain.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

GET Params

filter (array) - One or more filters (see filter types)
sort (array) - One or more sort fields (see sort types)
limit (int) - A limit on the result set
offset (int) - An offset for the result set

Filter Fields

Any of the returned fields

Sort Fields

Any of the returned fields

Response:

HTTP 200 - OK

SIP queue rows.

Read SIP queue

Returns the properties for a particular SIP queue.

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}

Response:

HTTP 200 - OK

SIP queue row.

Create SIP queue

Create a new SIP queue.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

POST Params

queueName (string) - Queue Name (e.g. sales)
displayName (string) - Display Name (e.g. Sales Dept)
extensionNumber (string) - Extension number for the queue
callerNameFormat (string) OPTIONAL - A formatting string for the queue that is presented to the device. See callerNameFormat below

callerNameFormat

The formatting string can contain any of the variables defined below using brackets

displayName
srcPhoneNumber
dgrpName

E.g. for ‘displayName - srcPhoneNumber’ use ‘{displayName} - {srcPhoneNumber}’. This will be compiled to ‘queue display name - 0123456789’

Response:

HTTP 201 - CREATED

Update SIP queue

Updates a SIP queue.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.

POST Params

queueName (string) OPTIONAL - Queue Name (e.g. sales)
displayName (string) OPTIONAL - Display Name (e.g. Sales Dept)
extensionNumber (string) OPTIONAL - Extension number for the queue
callerNameFormat (string) OPTIONAL - A formatting string for the queue that is presented to the device. See callerNameFormat above

Response:

HTTP 204 - NO CONTENT

Delete SIP queue

Delete a particular SIP queue.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.

Response:

HTTP 204 - NO CONTENT

List SIP queue members

Lists the members in a SIP queue.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}/members

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.

Response:

HTTP 200 - OK

SIP queue rows.

Read SIP queue member

Returns the properties for a particular SIP queue member.

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.
QUEUE MEMBER SPECIFIER (int) - SIP queue member ID.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}/members/{QUEUE MEMBER SPECIFIER}

Response:

HTTP 200 - OK

SIP queue member row.

Create SIP queue member

Create a new SIP queue member.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}/members

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.

POST Params

groupId (int) - Group ID
ringStrategy (string) - Ring strategy for this group, either ‘all’ to ring all users at the same time or ‘huntLongestIdle’ to ring users sequentially based on longest idle time
ringAttempts (int) - Number of attempts to ring the member users if all users are busy
ringSecs (int) - Number of seconds to ring the members users before moving onto the next member
ringOrder (int) - The order to ring each member, lowest is first

Response:

HTTP 201 - CREATED

Update SIP queue member

Updates a SIP queue member.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}/members/{QUEUE MEMBER SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.
QUEUE MEMBER SPECIFIER (int) - SIP queue member ID.

POST Params

groupId (int) OPTIONAL - Group ID
ringStrategy (string) OPTIONAL - Ring strategy for this group, either ‘all’ to ring all users at the same time or ‘huntLongestIdle’ to ring users sequentially based on longest idle time
ringAttempts (int) OPTIONAL - Number of attempts to ring the member users if all users are busy
ringSecs (int) OPTIONAL - Number of seconds to ring the members users before moving onto the next member
ringOrder (int) OPTIONAL - The order to ring each member, lowest is first

Response:

HTTP 204 - NO CONTENT

Delete SIP queue member

Delete a particular SIP queue member.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}/members/{QUEUE MEMBER SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.
QUEUE MEMBER SPECIFIER (int) - SIP queue member ID.

Response:

HTTP 204 - NO CONTENT

Set SIP queue member order

Sets the SIP queue member order.

Request:

PUT /config/v2/sip/domains/{DOMAIN SPECIFIER}/queues/{QUEUE SPECIFIER}/members/order

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
QUEUE SPECIFIER (int) - SIP queue ID.

POST Params

queueMemberId (array) - An array of queueMemberIds, the array index used as the order

Response:

HTTP 204 - NO CONTENT

List SIP trusted networks

Lists the SIP trusted networks for a domain.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/trustednetworks

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

GET Params

filter (array) - One or more filters (see filter types)
sort (array) - One or more sort fields (see sort types)
limit (int) - A limit on the result set
offset (int) - An offset for the result set

Filter Fields

Any of the returned fields

Sort Fields

Any of the returned fields

Response:

HTTP 200 - OK

SIP trusted networks rows.

Read SIP trusted network

Returns the properties for a particular SIP trusted network.

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
TRUSTED NETWORK SPECIFIER (int) - SIP trusted network ID.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/trustedNetworks/{TRUSTED NETWORK SPECIFIER}

Response:

HTTP 200 - OK

SIP trusted network row.

Create SIP trusted network

Create a new SIP trusted network.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/trustedNetworks

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

POST Params

network (string) - CIDR network value (e.g. 10.0.20.10/24)
description (string) OPTIONAL - description

Response:

HTTP 201 - CREATED

Update SIP trusted network

Updates a SIP trusted network.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/trustedNetwork/{TRUSTED NETWORK SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
TRUSTED NETWORK SPECIFIER (int) - SIP trusted network ID.

POST Params

network (string) OPTIONAL - CIDR network value (e.g. 10.0.20.10/24)
description (string) OPTIONAL - description

Response:

HTTP 204 - NO CONTENT

Delete SIP trusted network

Delete a particular SIP trusted network.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/trustedNetwork/{TRUSTED NETWORK SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
TRUSTED NETWORK SPECIFIER (int) - SIP trusted network ID.

Response:

HTTP 204 - NO CONTENT

List PBX devices

Lists the SIP registered PBX devices.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/devices

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

GET Params

filter (array) - One or more filters (see filter types)
sort (array) - One or more sort fields (see sort types)
limit (int) - A limit on the result set
offset (int) - An offset for the result set

Filter Types

pbxDeviceId (integer) - ID of the PBX device
pbxDeviceName (string) - PBX device alias (e.g. “My Device” etc.)
domainId (integer) - ID of the domain
deviceMacAddress (string) - PBX Device MAC address (e.g 10:20:30:1A:2B:3C)
createDatetime (datetime) - Create date time
updateDatetime (datetime) - Last update date time
userId (integer) - ID of the SIP user associated with this device
user (integer) - SIP user name associated with the device

Sort Types

Same fields as Filter Types, see above.

Response:

List of details of PBX Devices

pbxDeviceId (integer) - ID of the PBX device
pbxDeviceName (string) - PBX device alias (e.g. “My Device” etc.)
domainId (integer) - ID of the domain
deviceMacAddress (string) - PBX Device MAC address (e.g 10:20:30:1A:2B:3C)
createDatetime (datetime) - Create date time
updateDatetime (datetime) - Last update date time
userId (integer) - ID of the SIP user associated with this device
user (integer) - The SIP user name associated with this device

HTTP 200 - OK

{"pbxDeviceId":"1","pbxDeviceName":"My PBX Device 1","domainId":"1","deviceMacAddress":"10:20:30:1A:2B:3C","createDatetime":"2019-10-31 09:42:56","updateDatetime":"2019-10-31 09:50:06","userId":"11","user":"test.user"}
{"pbxDeviceId":"2","pbxDeviceName":"My PBX Device 2","domainId":"1","deviceMacAddress":"10:20:30:5C:4F:2A","createDatetime":"2019-10-31 14:41:10","updateDatetime":"2019-10-31 15:54:22","userId":"11","user":"test.user"}

Read PBX devices

Reads the SIP registered PBX device.

Request:

GET /config/v2/sip/domains/{DOMAIN SPECIFIER}/devices/{DEVICE SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
DEVICE SPECIFIER (int) - PBX Device ID.

Response:

Details of a specific PBX device

pbxDeviceId (integer) - ID of the PBX device
pbxDeviceName (string) - PBX device alias (e.g. “My Device” etc.)
domainId (integer) - ID of the domain
deviceMacAddress (string) - PBX Device MAC address (e.g 10:20:30:1A:2B:3C)
createDatetime (datetime) - Create date time
updateDatetime (datetime) - Last update date time
userId (integer) - ID of the SIP user associated with this device
user (integer) - The SIP user name associated with this device

HTTP 200 - OK

{"pbxDeviceId":"1","pbxDeviceName":"My PBX Device 1","domainId":"1","deviceMacAddress":"10:20:30:1A:2B:3C","createDatetime":"2019-10-31 09:42:56","updateDatetime":"2019-10-31 09:50:06","userId":"11","user":"test.user"}

Create PBX device

Create a new PBX device.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/devices

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.

POST Params

pbxDeviceName (string) - Device friendly name (e.g. My PBX Device 1)
deviceMacAddress (string) - PBX Device MAC address (e.g 10:20:30:1A:2B:3C)

Response:

HTTP 201 - CREATED

{"pbxDeviceId":"1"}

Update PBX device

Update given PBX device.

Request:

POST /config/v2/sip/domains/{DOMAIN SPECIFIER}/devices/{DEVICE SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
DEVICE SPECIFIER (int) - PBX Device ID.

POST Params

pbxDeviceName (string) - Device friendly name (e.g. My PBX Device 1)

Response:

HTTP 204 - NO CONTENT

Delete PBX device

Delete given PBX device.

Request:

DELETE /config/v2/sip/domains/{DOMAIN SPECIFIER}/devices/{DEVICE SPECIFIER}

URL Path Params

DOMAIN SPECIFIER (int) - SIP Domain ID.
DEVICE SPECIFIER (int) - PBX Device ID.

Response:

HTTP 204 - NO CONTENT