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:
Response:
Read SIP Domain
Returns the properties for a particular SIP Domain.
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
Request:
Response:
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:
Response:
List SIP Users
Lists the SIP Users in a domain.
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
Request:
Response:
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:
Response:
Create SIP User
Create a new SIP User.
Request:
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:
Update SIP User
Update the properties for a particular SIP User.
Request:
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:
Delete SIP User
Delete a particular SIP User.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- USER SPECIFIER (int) - User ID.
Response:
List SIP Groups
Lists the SIP Groups for a domain.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
Response:
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:
Response:
Create SIP Group
Create a new SIP Group.
Request:
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:
Update SIP Group
Update a SIP Group.
Request:
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:
Delete SIP Group
Delete a particular SIP Group.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- GROUP SPECIFIER (int) - SIP Group ID.
Response:
List SIP Group Users
Lists the Users who are members of a SIP Group for a domain.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- GROUP SPECIFIER (int) - SIP Group ID.
Response:
Add SIP Group Users
Add Users to a SIP Group for a domain.
Request:
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:
Delete SIP Group Users
Delete Users from a SIP Group for a domain.
Request:
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:
List PBX User Devices
Lists the PBX devices that a SIP user is associated with.
Request:
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.
Read PBX User Device
Reads a single PBX device that a SIP user is associated with.
Request:
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.
Create PBX User Device
Creates a new PBX user device association with a SIP user.
Request:
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.
Returns the entire newly created PBX user device:
Delete PBX User Device
Deletes the association between PBX device and a SIP user.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- USER SPECIFIER (int) - SIP user ID.
- DEVICE SPECIFIER (int) - PBX device ID.
Response:
List SIP User Groups
Lists the groups for a SIP user for a domain.
Request:
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:
Add SIP User Groups
Add groups to a SIP user for a domain.
Request:
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:
List SIP queues
Lists the SIP queues for a domain.
Request:
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:
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:
Response:
Create SIP queue
Create a new SIP queue.
Request:
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:
Update SIP queue
Updates a SIP queue.
Request:
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:
Delete SIP queue
Delete a particular SIP queue.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- QUEUE SPECIFIER (int) - SIP queue ID.
Response:
List SIP queue members
Lists the members in a SIP queue.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- QUEUE SPECIFIER (int) - SIP queue ID.
Response:
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:
Response:
Create SIP queue member
Create a new SIP queue member.
Request:
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:
Update SIP queue member
Updates a SIP queue member.
Request:
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:
Delete SIP queue member
Delete a particular SIP queue member.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- QUEUE SPECIFIER (int) - SIP queue ID.
- QUEUE MEMBER SPECIFIER (int) - SIP queue member ID.
Response:
Set SIP queue member order
Sets the SIP queue member order.
Request:
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:
List SIP trusted networks
Lists the SIP trusted networks for a domain.
Request:
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:
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:
Response:
Create SIP trusted network
Create a new SIP trusted network.
Request:
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:
Update SIP trusted network
Updates a SIP trusted network.
Request:
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:
Delete SIP trusted network
Delete a particular SIP trusted network.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- TRUSTED NETWORK SPECIFIER (int) - SIP trusted network ID.
Response:
List PBX devices
Lists the SIP registered PBX devices.
Request:
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
Read PBX devices
Reads the SIP registered PBX device.
Request:
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
Create PBX device
Create a new PBX device.
Request:
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:
Update PBX device
Update given PBX device.
Request:
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:
Delete PBX device
Delete given PBX device.
Request:
URL Path Params
- DOMAIN SPECIFIER (int) - SIP Domain ID.
- DEVICE SPECIFIER (int) - PBX Device ID.