Common Objects

Several services are using similar objects. They are described in this section.

Service User Id

The attribute serviceUserId is a String. From high level point of view it is a mandatory parameter.

However For Hunt Groups, IVRs (aka Auto-Attendants), Call Centers, and Meet-Me Conferencing APIO offers the possibility to generate it based on its id auto-generation mechanism. This mechanism can be triggered either via a rule defined in a template (priority one) or in configuration settings.

For the template it is done by including a “default_values” section and inside this section a “serviceUserId” element:

"default_values": {
    "serviceUserId": "{{group_id}}_hg{{country_code}}{{national_no_0}}@{{domain}}"
}

For the settings it is by using the the following attributes (note that this section comports more parameters not described here)

"AUTOMATIC_ID_RULES": {
    "SUID_HUNT_GROUP_AUTO_GENERATE": True,
    "SUID_HUNT_GROUP_RULE": "{{group_id}}_hg{{name}}@{{domain}}",
    "SUID_MEET_ME_CONF_AUTO_GENERATE": True,
    "SUID_MEET_ME_CONF_GROUP_RULE": "{{group_id}}_mmc{{name}}@{{domain}}",
    "SUID_AUTO_ATTENDANT_AUTO_GENERATE": True,
    "SUID_AUTO_ATTENDANT_RULE": "{{group_id}}_aa{{name}}@{{domain}}",
    "SUID_CALL_CENTER_AUTO_GENERATE": True,
    "SUID_CALL_CENTER_RULE": "{{group_id}}_cc{{name}}@{{domain}}",
}

In these rules the following variables can be used:

• phone_number_e164: The phone number in E164 format (if a phone number in the profile of the service user defined)

• country_code: The country code of the phone number (if a phone number in the profile of the service user defined)

• national_no_0: The national number, without trailing 0, of the phone number (if a phone number in the profile of the service user defined)

• domain: the domain

• tenant_id: the Tenant Id

• group_id: the Group Id

• name: The name of the service user (if provided)

Audio File attributes

Name	Type	Methods		Description
		GET	PUT
name	String	C	O	The name of the file
level	String	C	O	Who owns the announcement. Allowed values Group, User. Default value for User services: User Default value for Group services: Group

Admin Detail Attributes

Name	Type	Methods			Description
		GET	POST	PUT
userId	String	A	R	F	The unique id of the admin if the network element allows/requires to specify it.
firstName	String	A	O	O	The first name of the admin.
lastName	String	A	O	O	The last name of the admin.
language	String	A	O	O	The preferred language for the admin. Default as defined in settings.
department	Object	A	F	F	An object as defined as Group department key attributes.
password	String	F	O	O	The password for a new admin. Auto-generated if not provided.
emailAddress	String	A	O	O	The email address for the admin.
userProfileType	String	F	O	F	The User Profile Type to be used for this Admin if not the default one.
loginMode	Integer	F	O	F	To override the loginMode of the User Profile Type used. Usually to force a SSO login (3).
role	String	O	O	O	An optional role for the admin. No logic associated in the APIO itself.

Note: if the userProfileType is not of the level Group, it will be ignored.

Admin Detail List Item Attributes

Name	Type	Method	Description
		GET
userId	String	A	The unique id of the admin if the network element allows/requires to specify it.
firstName	String	A	The first name of the admin.
lastName	String	A	The last name of the admin.
language	String	A	The preferred language for the admin. Default as defined in settings.

Call Center Instance

Name	Type	Methods			Description
		GET	POST	PUT
serviceUserId	String	A	C	F	Uniquely identifies a call center. For PUT the value is an URL parameter. See Service User Id for the ways it could be auto-generated.
serviceInstanceProfile	Object	A	R	O	Service Profile Information for a call center. See Call Center Service Instance Profile.
type	String	A	O	O	Type of call center.
routingType	String	A	O	O	Routing type for distributing calls within a call center.
policy	String	A	R	O	Policy for distributing calls within a hunt group or call center.
queueLength	Integer	A	O	O	The limit for the number of calls the system will keep in queue, waiting for an available agent.
enableReporting	Boolean	A	O	O	Toggle enable reporting functionality.
allowCallerToDialEscapeDigit	Boolean	A	O	O	Toggle allow caller to dial escape digit functionality.
escapeDigit	String	A	O	O	A single DTMF dialing digit.
resetCallStatisticsUponEntryInQueue	Boolean	A	O	O	Toggle reset call statistics upon entry in queue functionality.
allowAgentLogoff	Boolean	A	O	O	Toggle allow agent logoff functionality.
allowCallWaitingForAgents	Boolean	A	O	O	Toggle allow call waiting for agents functionality.
allowCallsToAgentsInWrapUp	Boolean	A	O	O	Toggle allow calls to agents in Wrap-Up functionality.
overrideAgentWrapUpTime	Boolean	A	O	O	Toggle override agent Wrap-Up time functionality.
wrapUpSeconds	Integer	A	O	O	The Automatic Call Distribution (ACD) Wrap-Up time in seconds.
forceDeliveryOfCalls	Boolean	A	O	O	Toggle force delivery of calls functionality.
forceDeliveryWaitTimeSecondsSeconds	Integer	A	O	O	Force delivery wait time in seconds.
enableAutomaticStateChangeForAgents	Boolean	A	O	O	Toggle automatic state change for agents functionality.
agentStateAfterCall	String	A	O	O	Agent Automatic Call Distribution (ACD) State. States available for Wrap-Up agent state management.
agentUnavailableCode	String	C	O	O	Agent Unavailable Code value. In order to set it correctly: enableAutomaticStateChangeForAgents must be true, agentStateAfterCall must be “Unavailable”.
externalPreferredAudioCodec	String	A	O	O	Audio file codec.
internalPreferredAudioCodec	String	A	O	O	Audio file codec.
playRingingWhenOfferingCall	Boolean	A	O	O	Toggle play ringing when offering call functionality.
callCenterQueueThresholdsIsActive	Boolean	A	F	F	Toggle call center queue thresholds functionality.
networkClassOfService	String	A	O	O	Network Class of Service name.

Call Center Service Instance Profile

This is also valid for Route Points.

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	R	O	See name.from Service User Profile.
cliFirstName	String	A	R	O	See cliFirstName.from Service User Profile.
cliLastName	String	A	R	O	See cliLastName.from Service User Profile.
phoneNumber	String	A	O	O	See phoneNumber.from Service User Profile.
extension	String	A	O	O	See extension.from Service User Profile.
department	Object	A	O	O	See department.from Service User Profile.
language	String	A	O	O	See language.from Service User Profile. In POST if not provided, the settings “DEFAULT_LANGUAGE” will be used.
timeZone	String	A	O	O	See timeZone.from Service User Profile.
timeZoneDisplayName	String	O	N	N	See timeZoneDisplayName.from Service User Profile.
publicUserIdentity	String	A	O	O	See publicUserIdentity.from Service User Profile.
cliPhoneNumber	String	A	O	O	See cliPhoneNumber.from Service User Profile.
password	String	F	O	O	The password. In the POST if not provided it will be auto-generated

Service User Profile

Some services acts as a virtual user as they have properties usually associated to a profile such as a name, a phone number, a language, …

Except if stated otherwise in the API using it, the Required / O status is for the Add, in a Modify all is o .

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	R	O	Service Instance Name for a service with a user id.
cliFirstName	String	A	R	O	First Name for Calling Line Id Display.
cliLastName	String	A	R	O	Last Name for Calling Line Id Display.
phoneNumber	String	A	O	O	The public phone number to reach the service.
extension	String	A	O	O	The internal extension to reach the service.
department	Object	A	O	O	An object as defined as Group department key attributes.
language	String	A	O	O	The language used for this service, it usually impacts announcements. In POST if not provided, the settings “DEFAULT_LANGUAGE” will be used.
timeZone	String	A	O	O	The time zone of this service user.
timeZoneDisplayName	String	O	N	N	A proposed display name for the time zone of this service user.
aliases	Array	A	O	O	List of SIP URIs. See Aliases.
publicUserIdentity	String	A	O	O	The IMS public identity for this service, relevant in IMS context only.
cliPhoneNumber	String	A	O	O	The public phone number exposed by the service when calling out.

Note that since 1.10.3, if the AS answer contains a country code indication that country code will be used for the E164 normalization of the phoneNumber.

Route Point Instance

Name	Type	Methods			Description
		GET	POST	PUT
serviceUserId	String	A	C	F	Uniquely identifies a route point. For PUT the value is an URL parameter. See Service User Id for the ways it could be auto-generated.
serviceInstanceProfile	Object	A	R	O	Service Profile Information for a call center. See Call Center Service Instance Profile.
queueLength	Integer	A	O	O	The limit for the number of calls the system will keep in queue, waiting for an available agent.
noAnswerTimeoutRings	Boolean	A	O	O	The duration (in number of rings) before the cal is considered as in timeout.
overrideAgentWrapUpTime	Boolean	A	O	O	Toggle override agent Wrap-Up time functionality.
wrapUpSeconds	Integer	A	O	O	The Automatic Call Distribution (ACD) Wrap-Up time in seconds.
forceDeliveryOfCalls	Boolean	A	O	O	Toggle force delivery of calls functionality.
forceDeliveryWaitTimeSecondsSeconds	Integer	A	O	O	Force delivery wait time in seconds.
enableAutomaticStateChangeForAgents	Boolean	A	O	O	Toggle automatic state change for agents functionality.
agentStateAfterCall	String	A	O	O	Agent Automatic Call Distribution (ACD) State. States available for Wrap-Up agent state management.
agentUnavailableCode	String	C	O	O	Agent Unavailable Code value. In order to set it correctly: enableAutomaticStateChangeForAgents must be true, agentStateAfterCall must be “Unavailable”.
externalPreferredAudioCodec	String	A	O	O	Audio file codec.
internalPreferredAudioCodec	String	A	O	O	Audio file codec.
playRingingWhenOfferingCall	Boolean	A	O	O	Toggle play ringing when offering call functionality.
networkClassOfService	String	A	O	O	Network Class of Service name.

Aliases

Enter a list of valid SIP URI or an empty list to delete them all it.

Call Center List Item

Name	Type	Method	Description
		GET
serviceUserId	String	A	Uniquely identifies a call center.
name	String	A	Service Instance Name for a service with a user id.
phoneNumber	String	A	Phone number.
extension	String	A	The extension.
department	Object	A	Uniquely identifies a department system-wide. An object as defined as Group department key attributes.
active	Boolean	A	The status of the service.
type	String	A	Type of call center.
policy	String	A	Policy for distributing calls within a hunt group or call center.

Agent List Item

Name	Type	Methods			Description
		GET	PUT	POST
userId	String	A	R	R	Unique name for the agent assigned to a call center.
firstName	String	A	F	F	User’s first name.
lastName	String	A	F	F	User’s last name.
weight	Integer	A	F	F
phoneNumber	String	A	F	F	Phone number.
extension	String	A	F	F	The extension.
department	Object	A	F	F	ely identifies a department system-wide. An object as defined as Group department key attributes.
emailAddress	String	A	F	F	User’s email address.
skillLevel	String	A	F	F	User’s skill level. “O” or empty means no skill level configured (for example for Basic or Standard CC).

Agent User ID List Item

Name	Type	Method	Description
		PUT
userId	String	R	Unique name for the agent assigned to a call center.

Skilled Agent List Item

Name	Type	Method	Description
		PUT
agents	Array	R	The list of skilled agents to be assigned to a call center. See Agent User ID List Item.
skillLevel	String	R	User’s skill level.

Agent Currently Staffed Item

Name	Type	Method	Description
		GET
userId	String	A	Unique name for the agent assigned to a call center.
firstName	String	A	User’s first name.
lastName	String	A	User’s last name.
phoneNumber	String	A	Phone number.
extension	String	A	The extension.
department	Object	A	Uniquely identifies a department system-wide. An object as defined as Group department key attributes.
emailAddress	String	A	User’s email address.

Active Instance List Item

Name	Type	Method	Description
		PUT
serviceUserId	String	R	Unique name for the call center to modify.
active	Boolean	R	Status of the service.

Route Point List Item

Name	Type	Method	Description
		GET
serviceUserId	String	A	Uniquely identifies a route point.
name	String	A	Service Instance Name for a service with a user id.
phoneNumber	String	A	Phone number.
extension	String	A	The extension.
department	Object	A	Uniquely identifies a department system-wide. An object as defined as Group department key attributes.
active	Boolean	A	The status of the service.

Audio File List Item

• Object with key “name” and value an already existing audio file to set.

• “Unmodify” string value to leave unmodified the positional item.

• Null value to delete the positional item.

Name	Type	Methods		Description
		GET	PUT
name	Object	C	O	Name of the (already existing) audio file to set.
	String	C	O	“Unmodify” value to leave unmodified the positional item.
	Null	C	O	Null value to delete the positional item.
level	String	C	O	‘Group’ or “User’ depending who own the announcement. Default is ‘Group’

Announcements Config

Name	Type	Methods		Description
		GET	PUT
audioMessageSelection	String	A	R	The type of the announcement.
audioFileList	Array	C	O	List of the audio file. See Audio File List Item for values of the items

Estimated Wait Message Options

Name	Type	Methods		Description
		GET	PUT
enabled	Boolean	A	O	Toggle enable status.
operatingMode	String	A	O	The type of estimated wait message that is played.
playPositionHighVolume	Boolean	A	O	Toggle enable playPositionHighVolume functionality.
playTimeHighVolume	Boolean	A	O	Toggle enable playTimeHighVolume functionality.
maximumPositions	Integer	A	O	The number of position for which the estimated wait is played.
maximumWaitingMinutes	Integer	A	O	The number of minutes for which the estimated wait is played.
defaultCallHandlingMinutes	Integer | A | O			The default handling time per call (minutes).
playUpdatedEWM	Boolean	A	O	Toggle enable playUpdatedEWM functionality.
timeBetweenEWMUpdatesSeconds	Integer	A	O	The interval in seconds between each repetition of the estimated wait message played to queued users.

Audio File Upload

Name	Type	Method	Description
		PUT
description	String	R	Description for the audio file.
content	String	R	The file content in Base64, the server will try to transcode it into a supported format.

Service Management List Item

Name	Type	Methods			Description
		POST	DELETE	GET
name	String	R	R	A	The name of the service to be assigned or unassigned.
assigned	Boolean	F	F	A	The assignment status of the service.

Service License Management List Item

Name	Type	Methods		Description
		GET	PUT
name	String	A	R	The name of the service to be authorized or unauthorized.
allocated	Object	A	R	Allocation counters. See Service License Allocation Counters.
inUse	Integer	C	F	Amount of uses for the selected service. Present if relevant.
status	String	C	F	Identifies the update operation status. Valued from “failed”, “updated”. Present if relevant after an update.
description	String	C	F	Description of the service. Present if relevant and provided by the Network Element.

Service License Allocation Counters

Name	Type	Methods		Description
		GET	PUT
unlimited	Boolean	C	O	Set unlimited uses for the selected service. If not provided false will be used.
maximum	Integer	C	O	Maximum number of uses for the selected service. 0 means not authorized.
noInstance	Boolean	C	F	if true the service is just assigned/unassigned else it can have instances (from rel 1.4.1)

Call Capacity Instance

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
name	String	N	R	O	F	Unique name (new name for a PUT) for this instance. For GET and DELETE the value comes from the URL param. Is returned after a GET list instances.
isDefault	Boolean	A	R	R	F	Define if this instance is the default instance for newly created users.
maxCalls	Integer	A	R	R	F	Maximum number of simultaneous ongoing calls (global).
maxIncomingCalls	Integer	O	O	O	F	Maximum number of simultaneous ongoing incoming calls. In GET not present means no limitation, in PUT null means remove limitation.
maxOutgoingCalls	Integer	O	O	O	F	Maximum number of simultaneous ongoing outgoing calls. In GET not present means no limitation, in PUT null means remove limitation.
userIds	Array	N	O	O	F	See User IDs.
users	Array	A	F	F	F	List of users assigned to the service.

User IDs

A List of valid user IDs.

Group attributes

Name	Type	Methods			Description
		GET	POST	PUT
groupId	String	C	R	F	The unique id of the group if the network element allows/requires to specify it.
groupName	String	A	O	O	The name of the group if defined on the network element.
userLimit	Integer	A	R	O	The maximum number of users allowed in the group. (-1 if unlimited).
userCount	Integer	A	F	F	The current number of users.
defaultDomain	String	A	R	O	The default domain to be used when no domain is specified.
cliName	String	A	O	O	The Calling Line Id Name.
cliPhoneNumber	String	A	O	O	The Calling Line Id Phone Number. It must be a number allocated to the group.
locationDialingCode	String	A	O	O	This code can be used as prefix for inter-groups dialing inside an Enterprise.
timeZone	String	A	R	O	The time zone of this group.
timeZoneDisplayName	String	O	N	N	A proposed display name for the time zone of this group.
contactInformation	Object	O	O	O	The main contact information, see Contact Information attributes.
addressInformation	Object	O	O	O	The address information, see Contact Information attributes.
resellerId	String	O	O	O	The name of the Reseller owning this Group (if any).

Contact Information attributes

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	O	O	The name of the person of contact.
phoneNumber	String	A	O	O	The phone number of the person of contact.
emailAddress	String	A	O	O	The email address of the person of contact

Contact Information attributes

Name	Type	Methods			Description
		GET	POST	PUT
addressLine1	String	A	O	O	The street, number, box address.
addressLine2	String	A	O	O	The continuation of the address if it must be presented over 2 lines.
city	String	A	O	O	The city.
state	String	A	O	O	The state or province or equivalent notion.
stateDisplayName	String	A	O	O	A display name for the state if needed.
postalCode	String	A	O	O	The postal or zip code.
country	String	A	O	O	The country.

User attributes

Name	Type	Methods		Description
		GET	POST
userId	String	A	O	The unique user Id if the Main AS allows to specify it.
firstName	String	A	R	The user first name. (See First / Last name).
lastName	String	A	R	The user last name. (See First / Last name).
department	String	A	F	The department the user belongs to.
phoneNumber	String	A	O	The user phone number (See Phone Number).
outgoingPhoneNumber	String	F	O	The alternate phone number for outgoing calls (See Phone Number).
extension	String	A	O	The user extension. (See Extension).
language	String	F	R	The user language.
timeZone	String	F	O	The user timezone (if configured).
email	String	A	O	The user email address.
countryCode	String	F	O	The user country code, as defined in ISO.
nationalPrefix	String	F	O	The prefix used for national numbers.
visibleFirstName	String	F	O	The user first name visible on the phone.
visibleLastName	String	F	O	The user last name visible on the phone.
devices	Array	F	O	A list of objects representing the user access devices. (See Device attributes).
inTrunkGroup	Boolean	A	F	Indicate of the user is part of a trunk group and therefore has reduced services.
isAdmin	Boolean	A	O	Indicate of the user has admin rights on the Group.

User in List attributes

Name	Type	Methods		Description
		GET	POST
userId	String	A	R	The unique user Id if the Main AS allows to specify it.
firstName	String	A	R	The user first name. (See First / Last name).
lastName	String	A	R	The user last name. (See First / Last name).
department	Object	C	O	The department the user belongs to. (See Group department key attributes).
extension	String	A	O	The user extension. (See Extension).
phoneNumber	String	A	O	The user phone number (See Phone Number).
emailAddress	String	A	O	The user email address.
inTrunkGroup	Boolean	A	F	Indicate of the user is part of a trunk group and therefore has reduced services.
tenantId	String	C	F	The ID of the Tenant owning this User. Only in the result of the Search operations at System level.
groupId	String	C	F	The ID of the Group owning this User. Only in the result of the Search operations at System or Tenant level.
backendName	String	C	F	The name of the Backend, only provided for a multi-as user, in a system search and if configured to return it.
backendExternalName	String	C	F	The external name of the Backend, same constraints as backendName.

Device attributes

Name	Type	Method	Description
		POST
name	String	R	The identifier of the device.
level	String	O	The level where the the device is defined. (default is user).

Voice Portal Details

Name	Type	Methods		Description
		GET	PUT
name	String	A	R	The name of the service to be authorized or unauthorized.
allocated	Object	A	R	Allocation counters. See Service License Allocation Counters.
inUse	Integer	C	F	Amount of uses for the selected service. Present if relevant.
status	String	C	F	Identifies the update operation status. Valued from “failed”, “updated”. Present if relevant after an update.

Voice Portal Instance

Name	Type	Methods		Description
		GET	PUT
serviceUserId	String	A	F	The unique Id of the Voice Portal.
serviceUserProfile	Object	A	O	The Service User profile, see Service User Profile.
active	Boolean	A	O	Indicate if the service is active or not.
enableExtendedScope	Boolean	A	O
enableAllAuthentifications	Boolean	A	O	Allow a user to identify himself using not only its extension but also his phone number or his aliases.
useVoicePortalWizard	Boolean	A	O	Force the user to use the configuration wizard.
voicePortalExternalRoutingScope	String	A	O	Do the external routing based on global or local settings.
useExternalRouting	String	A	O	External routing enabled.
externalRoutingAddress	String	C	O	External address to route voice portal calls, not present if not set.
homeZoneName	String	C	C	Define a home zone for the user, not present if not set.
networkClassOfService	String	C	C	Network Class of Service, not present if not set.

Group Numbers attributes

Name	Type	Methods		Description
		GET	POST
numbers	Array	A	O	List of phone numbers. See Group Numbers list items. The GET returns a list of strings.
range	Object	F	O	Range of phone numbers. See Group Numbers Range attributes.
result	Object	C	F	After POST or DELETE. List of phone numbers with the result. See Group Numbers Result items
available_numbers	Array	C	F	List (of strings) of the available phone numbers.
assigned_numbers	Array	C	F	List of objects Group Assigend Numbers attributes.

Group Numbers list items

Name	Type	Methods		Description
		GET	POST
phoneNumber	String	A	R	The phone number.
status	Boolean	A	F	The resulting status of the operation, each API will indicate what status are possible.
message	String	O	F	An optional message providing more information about the status of the operation on the number
code	String	O	F	An error code if the operation has failed. See Error messages.
details	String	O	F	An error details if the operation has failed. See Error messages.

Group Numbers Result items

In this table the POST /DELETE has to be understood as returned values in case of POST/DELETE and not as input parameters.

Name	Type	Methods		Description
		POST	DELETE
phoneNumber	String	A	A	The phone number.
status	String	A	A	The resulting status of the operation, each API will indicate what status are possible.
message	String	O	O	An optional message providing more information about the status of the operation on the number
code	String	O	O	An error code if the operation has failed. See Error messages.
details	String	O	O	An error details if the operation has failed. See Error messages.
tenant_status	String	O	N	The operation could indicate if the nummber was ‘added’ or already ‘available’ at Tenant level

Group Numbers Range attributes

Name	Type	Methods		Description
		GET	POST
minPhoneNumber	String	A	R	The min range phone number.
maxPhoneNumber	String	A	R	The max range phone number.

Group Extensions Range attributes

Name	Type	Methods		Description
		GET	POST
minExtension	String	A	R	The min range extension.
maxExtension	String	A	R	The max range extension.

Group Assigend Numbers attributes

Name	Type	Method	Description
		GET
phoneNumber	String	A	The user phone number (See Phone Number).
userId	String	A	The unique user Id if the Main AS allows to specify it.
firstName	String	A	The user first name. (See First / Last name).
lastName	String	A	The user last name. (See First / Last name).
userType	String	A	The type of the user.
department	Object	A	An object as defined in Group department key attributes.
extension	String	A	The user extension. (See Extension).
emailAddress	String	A	The user email address.

Group Numbers POST Result

[“status”, “phoneNumber”]

Access Device attributes

Name	Type	Methods			Description
		GET	POST	PUT
deviceName	String	RA	R	F	The name of the access device. For GET, PUT and DELETE the value comes from the URL param.
deviceType	String	A	R	F	The type of the access device. (-1 if unlimited)
protocol	String	A	R	R	The access device protocol.
netAddress	String	A	O	O	The IP Address, hostname, or domain.
netPort	Integer	A	O	O	The TCP/IP Port number above the 1025 - 65535 range.
outboundProxyServerNetAddress	String	A	O	O	The IP Address, hostname, or domain.
stunServerNetAddress	String	A	O	O	The IP Address, hostname, or domain.
macAddress	String	A	O	O
serialNumber	String	A	O	O	The access device serial number.
description	String	A	O	O
numberOfPorts	Integer	A	F	F	Total number of ports supported by this device, -1 means unlimited.
numberOfAssignedPorts	Integer	A	F	F	Number of ports already assigned ot a user on this device.
availablePorts	Array	C	F	F	The list of the available port numbers. In case of unlimited port device will be not returned. Conditionally based on the configuration of the device type (need_port parameter).
status	String	A	F	F
physicalLocation	String	A	O	O	Physical geographic location of the device.
transportProtocol	String	A	O	O
useCustomUserNamePassword	Boolean	A	O	O
accessDeviceCredentials	Object	F	O	O	See Access Device Credendials.
userName	String	A	F	F
version	String	A	F	F

Access Device Credendials

Name	Type	Methods			Description
		GET	POST	PUT
userName	String	F	R	R	The username for the access device.
password	String	F	R	R	The password for the access device.

Access Device list item

Name	Type	Methods	Description
		GET
deviceName	String	A	See deviceName.from Access Device attributes.
deviceType	String	A	See deviceType.from Access Device attributes.
netAddress	String	A	See netAddress.from Access Device attributes.
macAddress	String	A	See macAddress.from Access Device attributes.
availablePorts	Array	C	See availablePorts.from Access Device attributes.
freePorts	Integer	A	Number of ports not yet in use on the device, 99999 means unlimited
status	String	A	See status.from Access Device attributes.
version	String	A	See version.from Access Device attributes.

User Profile Attributes

Name	Type	Methods			Description
		GET	POST	PUT
userId	String	R	O	R	User ID. For GET, PUT and DELETE the value comes from the URL param. In POST it can be omitted when an auto-generation rule is configured.
lastName	String	A	R	O	Last Name.
firstName	String	A	R	O	First Name.
cliLastName	String	A	O	O	First Name for Calling Line Id Display. If not provided, the last name will be used.
cliFirstName	String	A	O	O	Last Name for Calling Line Id Display. If not provided, the first name will be used.
department	Object	A	O	C	An object as defined in Group department key attributes.
phoneNumber	String	A	O	O	The public phone number to reach the service.
extension	String	A	O	O	The internal extension to reach the service.
password	String	F	O	F	The password. If not provided, a password will be auto-generated as for password reset.
oldPassword	String	F	F	O	The old password to be modified.
newPassword	String	F	F	C	The new password to be modified. Only if oldPassword.is specified.
language	String	A	O	O	The language used for this service, it usually impacts announcements. In POST if not provided, the settings “DEFAULT_LANGUAGE” will be used.
emailAddress	String	A	0	O	The user email address.
networkClassOfService	String	A	O	O	The user assigned network class of service.
timeZone	String	A	O	O	The time zone of this user.
timeZoneDisplayName	String	O	N	N	A proposed display name for the time zone of this user.
accessDeviceEndpoint	Object	A	O	O	An object as defined in Access Device Endpoint.
cliPhoneNumber	String	A	O	O	The public phone number exposed by the service when calling out.
title	String	A	O	O	The title exposed by the service.
pagerPhoneNumber	String	A	O	O	The pager phone number.
mobilePhoneNumber	String	A	O	O	The mobile phone number.
yahooId	String	A	O	O	The Yahoo ID.
addressLocation	String	A	O	O	The address location.
address	Object	O	O	O	An object as defined in Address Information attributes Present in GET only if not empty.

Access Device Endpoint

Name	Type	Methods			Description
		GET	POST	PUT
accessDevice	Object	R	R	R	An object as defined in Access Device.
contacts	Array	A	R	O	A list of contacts (strings).
linePort	String	A	R	O	The user’s SIP address (private identity).
lineNumber	Integer	A	R	O	Specify the line number. 0 in a GET answer means unknown and must not be sent in PUT data.

Access Device Endpoint Hotline

Name	Type	Methods			Description
		GET	POST	PUT
accessDevice	Object	A	R	R	An object as defined in Access Device.
linePort	String	A	R	R	The user’s SIP address (private identity).
privateIdentity	String	N	O	F	TODO
contacts	Array	C	O	C	A list containing 0 or 1 item.
pathHeader	String	C	O	C	Routing information to the device, one for each configured contact. Used when Path header support is enabled. Only available for Rel23.
staticRegistrationCapable	Boolean	A	F	F	TODO
useDomain	Boolean	A	F	F	The user’s line number, depending on the identity/device profile type you selected. Only used by devices with static line ordering.
lineNumber	Integer	C	C	C	Specify the line number. 0 in a GET answer means unknown and must not be sent in PUT data.
useHotline	Boolean	A	O	C	Specify if to use Hotline contact. Only available for Rel23.
hotlineContact	String	C	O	C	The hotline contact. Only available for Rel23.

Access Device

Name	Type	Methods			Description
		GET	POST	PUT
level	String	A	O	O	The level of the access device.
name	String	A	O	O	The name of the access device.

Announcement File Name

Name	Type	Methods		Description
		GET	PUT
name	String	A	R	The name of an existing announcement.
level	String	O	O	The level of the owner announcement: “Group” or “User”. Default is “User” for (service) user services and “Group” for group services.

Incoming Calling Plan Permissions

Name	Type	Methods		Description
		GET	PUT
allowFromWithinGroup	Boolean	A	O	Allows calls from within the group
allowFromOutsideGroup	String	A	O	Allows calls from outside the group. Values from list: [‘Allow’,’Disallow’, ‘Allow Only If Redirected From Another User’]
allowCollectCalls	Boolean	A	O	Allows collect calls
digitPatternPermission	Array	A	O	An array of object as defined by Incoming Calling Plan Digit Pattern Permissions

Incoming Calling Plan Department Permissions

Name	Type	Methods		Description
		GET	PUT
department	Object	A	O	An object as defined in Group department key attributes.
allowFromWithinGroup	Boolean	A	O	Allows calls from within the group
allowFromOutsideGroup	String	A	O	Allows calls from outside the group. Values from list: [‘Allow’,’Disallow’, ‘Allow Only If Redirected From Another User’]
allowCollectCalls	Boolean	A	O	Allows collect calls
digitPatternPermission	Array	A	O	An array of object as defined by Incoming Calling Plan Digit Pattern Permissions

Incoming Calling Plan Digit Pattern Permissions

Name	Type	Methods		Description
		GET	PUT
allow	Boolean	A	O	Allows or disallows calls from this pattern
digitPatternName	String	A	R	Digit pattern name as managed by API Calling Plan Digit Strings

Calling Plan Digit String

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
name	String	A	R	R	R	Name used to define the digit string - is also the ky used to identify thee digit string
digitPattern	String	A	R	O	F	Digit pattern associated to the digit string

Outgoing Calling Plan Permissions

Name	Type	Methods		Description
		GET	PUT
group	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
local	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
tollFree	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
toll	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
international	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
operatorAssisted	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
chargeableDirectoryAssisted	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
specialServicesI	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
specialServicesII	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
premiumServicesI	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
premiumServicesII	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
casual	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
urlDialing	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
unknown	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
digitPatternPermission	Array	A	O	An array of object as defined by Outgoing Calling Plan Digit Pattern Permissions. this param is enabled by a global setting Configuration Information for OCP

The extra values of the Enhanced mode are obviously only relevant for the Originating OCP as it would make no sense to request and authorization code to the calling party for redirected call.

Outgoing Calling Plan Digit Pattern Permissions

Name	Type	Methods		Description
		GET	PUT
permission	String	A	O	A value from list: [‘Allow’,’Disallow’]. Enhanced mode (originating): [‘AuthCodes’,’FirstTransferNumber’,’SecondTransferNumber’,’ThirdTransferNumber’].
digitPatternName	String	A	R	Digit pattern name as managed by API Calling Plan Digit Strings

Outgoing Calling Plan Department Permissions

Name	Type	Methods		Description
		GET	PUT
department	Object	A	O	An object as defined in Group department key attributes.
permissions	Object	A	O	An object as defined in Outgoing Calling Plan Permissions.

Phone List attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
name	String	A	R	O	R	The name of the phone list entry.
phoneNumber	String	A	R	O	F	The phone number of the phone list entry.

Service Summary attributes

Name	Type	Method	Description
		GET
name	String	A	The name of the service.
active	Boolean	A	The status of the service.

Speed Code attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
speedCode	String	A	R	R	R	The speed code.
phoneNumber	String	A	R	R	F	The phone number.
description	String	A	O	O	F	The description.

Announcement attributes

Name	Type	Methods		Description
		GET	DELETE
announcements	Array	A	R	A list of objects as defined in Announcement entry attributes.
totalFileSize	Integer	A	F	Sum of the size of all the announcements (in KB).
maxFileSize	Integer	A	F	Valid range for space allocation (in Megabytes) for files in the announcement repository.

Announcement entry attributes

Name	Type	Methods		Description
		GET	DELETE
name	Array	A	R	The announcement name.
mediaType	Integer	A	F	The announcement media type.
fileSize	Integer	A	F	The announcement file size (in KB).

Announcement instance attributes

Name	Type	Method	Description
		GET
description	String	A	The announcement description.
fileSize	Integer	A	The announcement file size (in KB).
lastUploaded	String	A	Last uploaded datetime.
usages	Array	A	A list of announcement usages as defined in Announcement Usages attributes.

Announcement Usages attributes

Name	Type	Method	Description
		GET
service	String	A
instance	Integer	A

Announcement create and modify attributes

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	R	O	The announcement filename. For PUT it allows to modify the name, the original name is in the url.
content	String	A	R	O	The media file content (encoded to base64 format) to be uploaded.
description	String	A	O	O	The media file description.
repositoryAnnouncement	String	N	O	O	The announcement name from the Default Announcement Catalog. If set this will override any content provided. If name and/or description are set, then will be used, otherwise the ones from the Default Announcement Catalog will be used.

Hunt Group Instance

Name	Type	Methods			Description
		GET	POST	PUT
serviceUserId	String	A	C	R	Uniquely identifies a user. For PUT the value is an URL parameter. See Service User Id for the ways it could be auto-generated.
serviceInstanceProfile	Object	A	R	O	Service Profile Information for a hunt group. See Service User Profile.
policy	String	A	O	O	Policy for distributing calls within a hunt group or call center.
huntAfterNoAnswer	Boolean	A	O	O
noAnswerNumberOfRings	Integer	A	O	O	Number of rings to wait for the currently hunted agent to answer before hunting to the next available agent.
forwardAfterTimeout	Boolean	A	O	O
forwardTimeoutSeconds	Integer	A	O	O	Time to wait for any agent to answer before forwarding the caller elsewhere.
forwardToPhoneNumber	String	A	C	C	An outgoing phone number or a number meant to be dialed. It is longer than a DN so that equal access digits or access code digits may be be included. It cannot be a SIP URL. For POST it’s mandatory when ‘forwardAfterTimeout’ is enabled. For PUT it’s mandatory when ‘forwardAfterTimeout’ is enabled and the forwardToPhoneNumber has not been setted previously.
agents	Array	A	O	O	The list of the assigned agents to the given hunt group. In PUT and POST it is an array of user ids (strings). In GET it is a list of objects (see Hunt Group Agents array) in order that the client can display information on agents without having to fetch the list of users of the Group to get the details
allowCallWaitingForAgents	Boolean	A	O	O
useSystemHuntGroupCLIDSetting	Boolean	A	O	O
includeHuntGroupNameInCLID	Boolean	A	O	O
enableNotReachableForwarding	Boolean	A	O	O
notReachableForwardToPhoneNumber	String	A	C	C	For POST it’s mandatory when ‘enableNotReachableForwarding’ is enabled. For PUT it’s mandatory when ‘enableNotReachableForwarding’ is enabled and the notReachableForwardToPhoneNumber has not been setted previously.
makeBusyWhenNotReachable	Boolean	A	O	O
allowMembersToControlGroupBusy	Boolean	A	O	O
enableGroupBusy	Boolean	A	O	O
applyGroupBusyWhenTerminatingToAgent	Boolean	A	O	O
networkClassOfService	String	A	O	O	Network Class of Service name.
active	Boolean	A	O	O	The status of the service.

Hunt Group Agents array

Name	Type	Methods		Description
		GET	PUT
userId	String	A	R	Uniquely identifies a user.
lastName	String	A	R	User’s last name.
firstName	String	A	R	User’s first name.
weight	String	A	R	User’s weighted distribution (the value is in percentage).
phoneNumber	String	A	R	User’s phone number.
extension	String	A	R	User’s extension.
department	Object	A	R	An object as defined as Group department key attributes.
emailAddress	String	A	R	User’s emailAddress.

Agents weighted distribution

Name	Type	Method	Description
		PUT
userId	String	R	Uniquely identifies a user.
weight	String	R	User’s weighted distribution (the value is in percentage).

Hunt Group List Item

Name	Type	Method	Description
		GET
serviceUserId	String	A	Uniquely identifies a user.
name	String	A	Service Instance Name for a service with a user id.
phoneNumber	String	A	Phone number.
extension	String	A	The extension.
department	Object	A	An object as defined as Group department key attributes.
active	Boolean	A	The status of the service.
policy	String	A	Policy for distributing calls within a hunt group or call center.

Available User List Item

Name	Type	Methods			Description
		GET	POST	PUT
userId	String	A	R	R	Unique name for the agent assigned to a call center.
firstName	String	A	F	F	User’s first name.
lastName	String	A	F	F	User’s last name.
phoneNumber	String	A	F	F	Phone number.
extension	String	A	F	F	The extension.
department	Object	C	F	F	An object as defined as Group department key attributes. Returned only if the user is part of a department.
emailAddress	String	A	F	F	User’s email address.

Phone Directory List attributes

Name	Type	Method	Description
		GET
name	String	A	The name.
emailAddress	String	A	The email address.
phoneNumber	String	A	The phone number.
mobilePhoneNumber	String	A
department	Object	C	An object as defined as Group department key attributes.
extension	String	A
groupId	String	A
userId	String	A
virtualOnNet	Boolean	A
firstName	String	C
lastName	String	C
pager	String	C
title	String	C
timeZone	String	C
location	String	C
addressLine1	String	C
addressLine2	String	C
city	String	C
state	String	C
zip	String	C
country	String	C

Tenant Phone Directory List attributes

Name	Type	Method	Description
		GET
name	String	A	The name.
emailAddress	String	A	The email address.
phoneNumber	String	A	The phone number.
mobilePhoneNumber	String	A
department	Object	C	An object as defined as Tenant department key attributes.
extension	String	A
groupId	String	A
userId	String	A
virtualOnNet	Boolean	A
firstName	String	C
lastName	String	C
pager	String	C
title	String	C
timeZone	String	C
location	String	C
addressLine1	String	C
addressLine2	String	C
city	String	C
state	String	C
zip	String	C
country	String	C

Group Mobile Numbers attributes

Name	Type	Methods		Description
		GET	POST
phoneNumbers	Array	A	O	List of phone numbers. See Group Numbers list items. The GET returns a list of strings.
result	Object	C	F	After POST. List of phone numbers with the status of the operation. See Group Numbers list items.
available_numbers	Array	C	F	List (of strings) of the available phone numbers.
assigned_numbers	Array	C	F	List of objects Group Assigned Mobile Numbers attributes.

Group Assigned Mobile Numbers attributes

Name	Type	Method	Description
		GET
phoneNumber	String	A	The user phone number (See Phone Number).
userId	String	A	The unique user Id if the Main AS allows to specify it.
firstName	String	A	The user first name. (See First / Last name).
lastName	String	A	The user last name. (See First / Last name).
department	Object	A	An object as defined as Group department key attributes.
extension	String	A	The user extension. (See Extension).

Trunk Device Endpoint

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	R	O	Trunk Group name.
linePort	String	A	R	O	Identifies a device endpoint in standalone mode. Must be a valid SIP URI.
contacts	Array	A	O	O	A list of contacts (strings).

Trunk Endpoint

Name	Type	Methods			Description
		GET	POST	PUT
trunkGroupDeviceEndpoint	Object	A	O	O	An object as defined in Trunk Device Endpoint.
enterpriseTrunkName	String	C	O	O	Enterprise Trunk name. Uniquely identifies an Enterprise Trunk in an enterprise or group.
alternateTrunkIdentity	String	C	O	O	Alternate Trunk Identity.
alternateTrunkIdentityDomain	String	C	O	O	Domain of the Alternate Trunk Identity.
physicalLocation	String	C	O	O	Physical Location.

Device in List attributes

Name	Type	Method	Description
		GET
tenantId	String	A	The unique id of the tenant of this device.
isEnterprise	Boolean	A	Indicate if the Tenant is of type Enterprise.
groupId	String	C	The unique id of the group of this device. If the device is not at group level, the groupId is not returned.
deviceName	String	A	See deviceName.from Access Device attributes.
deviceType	String	A	See deviceType.from Access Device attributes.
netAddress	String	A	See netAddress.from Access Device attributes.
macAddress	String	A	See macAddress.from Access Device attributes.
status	String	A	See status.from Access Device attributes.
backendName	String	C	The name of the Backend, only provided for a multi-as user, in a system search and if configured to return it.
backendExternalName	String	C	The external name of the Backend, same constraints as backendName.

Device file attributes

Name	Type	Methods		Description
		GET	PUT
fileSource	String	A	R	The configuration mode. Value in: Default, Manual, Custom.
configurationFileName	String	A	F	The name of the configuration file.
accessUrl	String	A	F	The url to access the file.
repositoryUrl	String	A	F	The url of the repository.
templateUrl	String	A	F	The url of the template file.
extendedCaptureEnabled	Boolean	A	O	If true, the extended capture is enabled.
extendedCaptureURL	String	C	F	TODO. Only available in AS data mode.

Device file in list attributes

Name	Type	Method	Description
		GET
fileFormat	String	A	The name and format of the file.
isAuthenticated	Boolean	A	TODO
accessUrl	String	A	The url to access the file.
repositoryUrl	String	A	The url of the repository.
templateUrl	String	A	The url of the template file.

User connected to a Device attributes

Name	Type	Method		Description
		GET	PUT
lastName	String	A	O	The user’s last name.
firstName	String	A	O	The user’s first name.
phoneNumber	String	A	O	The user’s phone number. (See Phone Number).
userId	String	A	R	The user’s unique ID.
userType	String	A	O	The user’s type.
extension	String	A	O	The user’s extension.
department	String	C	O	The department the user belongs to. An object as defined as Group department key attributes.
emailAddress	String	A	O	The user’s email address.
linePort	String	A	R	The device line port.
endpointType	String	A	O	The device endpoint type.
order	Integer	C	R	The order/ine/port of the user on the phone. Only if supported by that type of phone.
primary	Boolean	A	O	The primary (main) device of the user or not.

Numbers in list attributes

Name	Type	Method	Description
		GET
tenantId	String	A	The ID of the Tenant.
phoneNumber	String	A	The phone number.
isEnterprise	Boolean	A	Indicate if the Tenant is an Enterprise or a Service Provider.
backendName	String	C	The name of the Backend, only provided for a multi-as user, in a system search and if configured to return it.
backendExternalName	String	C	The external name of the Backend, same constraints as backendName.

Number usage in list attributes

Name	Type	Method	Description
		GET
tenantId	String	A	The ID of the Tenant.
phoneNumbers	Integer	A	The number of phoneNumbers assigned to this Tenant.
assignedToGroups	Integer	A	The number of phoneNumbers assigned to Groups.
percentageAssigned	Integer	A	The percentage of the phoneNumbers assigned to Groups.
isEnterprise	Boolean	A	Indicate if the Tenant is an Enterprise or a Service Provider.
activatedOnGroups	Integer	A	Number activation status.
backendName	String	C	The name of the Backend, only provided for a multi-as user, in a system search and if configured to return it.
backendExternalName	String	C	The external name of the Backend, same constraints as backendName.

Number usage instance attributes

Name	Type	Method	Description
		GET
tenantId	String	A	The ID of the Tenant.
groupId	String	A	The ID of the Group.
userId	String	A	The ID of the User.
userType	String	A	The type of the User.
isGroupCallingLineId	Boolean	A	TODO.
active	Boolean	A	True if DN is active.

Phonelist CSV Results

Name	Type	Description
line	Integer/String	The line corresponding to the line of the csv file. In case of deletion, “-” is reported.
name	String	The Name.
phone_number	String	The Phone Number.
status	String	The status: “Success”. “Error”.
message	String	The message: “Entry added”, “Entry modified”, “Entry not modified”, “Entry deleted”.

Group & Tenant network class of service in list attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
name	String	A	R	F	R	The name of the network class of service.
description	String	A	F	F	F	The description of the network class of service.
default	Boolean	A	O	F	F	If true, this is the active network class of service. Only one NCOS at a time can be set as default.
assignToAllUsers	Boolean	N	O	O	F	If true, the NCOS instance will be assigned to all users. Only one NCOS at a time can be set to true.
assignToAllGroups	Boolean	N	O	O	F	If true, the NCOS instance will be assigned to all groups. Only one NCOS at a time can be set to true. Only available at tenant level.

Group department in list attributes

Name	Type	Method	Description
		GET
departmentName	String	A	The name of the department.
enterpriseDepartment	Boolean	A	If true, it is and enterprise department.
fullPathName	String	A	The full path name of the department, containing the name of the parent department.
cliName	String	C	Department calling line name.
cliPhoneNumber	String	C	Department calling line phone number.

Group department attributes

Name	Type	Method			Description
		GET	POST	PUT
departmentName	String	N	M	O	The name of the department.
parentDepartment	Object	O	O	O	The parent department.
cliName	String	O	O	O	Department calling line name.
cliPhoneNumber	String	O	O	O	Department calling line phone number.

Group department key attributes

Name	Type	Method			Description
		GET	POST	PUT
tenantId	String	A	R	O	The ID of the Tenant which this department belongs. Will be taken from url if not provided.
groupId	String	A	R	O	The ID of the Group which this department belongs. Will be taken from url if not provided.
departmentName	String	A	R	R	The name of the department.
fullPathName	String	C	F	F	The complete path name of the department.

Tenant department key attributes

Name	Type	Method	Description
		GET
tenantId	String	A	The ID of the Tenant which this department belongs. Will be taken from url if not provided.
departmentName	String	A	The name of the department.
fullPathName	String	C	The complete path name of the department.

Group department available parent list attributes

Name	Type	Method	Description
		GET
tenant_id	String	A	The ID of the Tenant which this department belongs.
group_id	String	A	The ID of the Group which this department belongs.
departmentName	String	A	The name of the department.
fullPathName	String	A	The full path name of the department, containing the name of the parent department.

Group communication barring profile list attributes

Name	Type	Methods		Description
		GET	PUT
profileName	String	A	R	Communication Barring Profile.

Group communication barring authorization code list attributes

Name	Type	Methods			Description
		GET	POST	DELETE
code	String	A	R	R	Communication Barring Authorization Code. Must contain only digits.
description	String	C	O	F	Communication Barring Authorization Code description.

Group outgoing calling plan authorization code list attributes

Name	Type	Methods			Description
		GET	POST	DELETE
code	String	A	R	R	Outgoing Calling Plan Authorization Code. Must contain only digits.
description	String	C	O	F	Outgoing Calling Plan Authorization Code description.

Group outgoing calling plan authorization code list Departments

Name	Type	Method	Description
		GET
department	Object	A	An object as defined as Group department key attributes.
authCodes	Array	A	A list of objects as defined as Group outgoing calling plan authorization code list attributes.

Group account authorization code list attributes

Name	Type	Methods			Description
		GET	POST	DELETE
code	String	A	R	R	Account Authorization Code. Must contain only digits.
description	String	C	O		Account Authorization Code description.

Group account authorization code list attributes

Name	Type	Methods		Description
		GET	PUT
userId	String	A	R	Unique name for the user.
lastName	String	C	F	User’s last name.
firstName	String	C	F	User’s first name.
hiraganaLastName	String	C	F	TODO.
hiraganaFirstName	String	C	F	TODO.
phoneNumber	String	C	F	User’s phone number.
extension	String	C	F	The user extension. (See Extension).
department	Object	C	F	The department the user belongs to. An object as defined as Group department key attributes.
emailAddress	String	C	F	User’s email address.

Group virtual on net user in get list attributes

Name	Type	Method	Description
		GET
lastName	String	A	User’s last name.
firstName	String	A	User’s first name.
phoneNumber	String	A	User’s phone number.
extension	String	A	User’s extension.
callType	String	A	Virtual On Net call type name.

Group virtual on net user in post list attributes

Name	Type	Method	Description
		POST
lastName	String	R	User’s last name.
firstName	String	R	User’s first name.
cliLastName	String	R	User’s calling line id last name.
cliFirstName	String	R	User’s calling line id first name.
phoneNumber	String	R	User’s phone number.
extension	String	R	User’s extension.
callType	String	O	Virtual On Net call type name. If not provided, a default value will be set from settings (if present) The list of allowed callTypes can be retrieved using the API Display system’s call types.

Group virtual on net user range in post attributes

Name	Type	Method	Description
		POST
lastName	String	R	User’s last name.
firstName	String	R	User’s first name.
cliLastName	String	R	User’s last name.
cliFirstName	String	R	User’s first name.
dnRange	String	R	An object as defined as Group Numbers Range attributes.
extensionRange	String	R	An object as defined as Group Extensions Range attributes.
callType	String	O	Virtual On Net call type name. If not provided, a default value will be set from settings (if present) The list of allowed callTypes can be retrieved using the API Display system’s call types.

Group feature access code attributes

Name	Type	Method	Description
		GET
name	String	A	Feature Access Code Name.
code	String	O	Feature Access Code.
alternateCode	String	O	Feature Access Code.

Group Session Admission Control Group in list attributes

Name	Type	Methods		Description
		GET	DELETE
name	String	A	A	The name of the SAC group.
default	Boolean	A	N	Specify whether this is the default SAC group.
maxSessions	Integer	A	N	The maximum number of concurrent sessions enter the maximum number of concurrent sessions allowed for the SAC group.
maxOrigSessions	Integer	O	N	The maximum number of concurrent user originating sessions
maxTermSessions	Integer	O	N	The maximum number of concurrent user terminating sessions

Group Session Admission Control Group attributes

Name	Type	Methods			Description
		GET	POST	PUT
name	String	N	R	O	The name of the SAC group.
maxSessions	Integer	A	R	O	The maximum number of concurrent sessions allowed for the SAC group. The number cannot exceed the maximum number of concurrent subscriber sessions allowed for the group as specified on the group’s capacity control.
maxOrigSessions	Integer	O	O	O	The maximum number of concurrent user originating sessions.
maxTermSessions	Integer	O	O	O	The maximum number of concurrent user terminating sessions.
reservedSessions	Integer	A	R	O	The maximum number of reserved sessions for the SAC group. To avoid situations where other SAC groups use up all the session resources. Value 0 means that the reservation mechanism is disabled.
reservedOrigSessions	Integer	O	O	O	The maximum number of reserved user originating sessions.
reservedTermSessions	Integer	O	O	O	The maximum number of reserved user terminating sessions.
default	Boolean	A	R	O	Specify whether this is the default SAC group.
countIntraSACGroupSessions	Boolean	A	R	O	To include the intra-SAC group sessions in the count of the total number of sessions for the SAC group.
devices	Array	A	O	O	An array of devices. See Access Device.
blockEmergencyAndRepairCallsDueToSACLimits	Boolean	A	R	O	To block emergency and repair calls when the call limit is reached for this SAC group.

Group call center unavailable code attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
code	String	A	R	R	R	The name of the code.
active	Boolean	A	R	O	F	Specify if the code is active or not.
description	String	C	O	O	F	The description of the code.

Group call center unavailable code in settings list attributes

Name	Type	Method	Description
		PUT
code	String	R	The name of the code.
active	Boolean	R	Specify if the code is active or not.

Group meet me conferencing ports attributes

Name	Type	Methods		Description
		GET	PUT
unlimited	Boolean	A	O	If true, the number of allocated ports is unlimited. If false, quantity must be specified.
quantity	Integer	C	O	The limited number of allocated ports.

Group call center agent threshold profile list attributes

Name	Type	Method	Description
		GET
default	Boolean	A	Specify if this profile is set as default.
name	String	A	Specify if the code is active or not.
description	String	C	Specify if the code is active or not.

Agent threshold available agents item

Name	Type	Method	Description
		GET
userId	String	A	Unique name for the agent.
firstName	String	A	User’s first name.
lastName	String	A	User’s last name.
phoneNumber	String	C	Phone number.
extension	String	C	The extension.
department	Object	C	Uniquely identifies a department system-wide. An object as defined as Group department key attributes.
emailAddress	String	C	User’s email address.
agentThresholdProfile	Integer	A	The threshold profile that is assigned to the agent.

Group call center statistics range attributes

Name	Type	Method	Description
		GET
start	DateTime	R	The start date and time of the statistics.
end	DateTime	C	The end date and time of the statistics.

Group call center queue statistics attributes

Name	Type	Method	Description
		GET
numberOfBusyOverflows	Integer	A	The number of calls received after the queue limit was exceeded.
numberOfCallsAnswered	Integer	A	The number of calls answered.
numberOfCallsAbandoned	Integer	A	The number of calls for which the caller hung up before a response.
numberOfCallsTransferred	Integer	A	The number of calls transferred.
numberOfCallsTimedout	Integer	A	The number of calls unanswered.
averageNumberOfAgentsTalking	Decimal	A	The average number of agents in the talking state.
averageNumberOfAgentsStaffed	Decimal	A	The average number of agents staffed.
averageWaitSeconds	Integer	A	The average number of seconds that callers wait for an available agent.
averageAbandonmentSeconds	Integer	A	The average number of seconds that callers wait for an agent before hanging up.

User display names attributes

Name	Type	Method	Description
		GET
lastName	String	A	User’s last name.
firstName	String	A	User’s first name.
hiraganaLastName	String	C	Hiragana last name.
hiraganaFirstName	String	C	Hiragana first name.

communication barring attributes

Name	Type	Methods		Description
		GET	POST
useGroupSetting	Boolean	A	R	If useGroupSetting is set to false, a profile name must be present.
profileName	String	C	O	Profile name

Call center agent statistics attributes

Name	Type	Method	Description
		GET
numberOfCallsHandled	Integer	A	The number of calls handled by the agent.
numberOfCallsUnanswered	Integer	A	The number of calls not answered by the agent.
averageCallSeconds	Integer	A	The average number of seconds that an agent spends on calls.
totalTalkSeconds	Integer	A	The number of seconds that the agent was busy handling calls.
totalStaffedSeconds	Integer	A	The number of seconds that the agent has joined the call center instance.

Group call center agent statistics attributes

Name	Type	Method	Description
		GET
agentUserId	String	A	The agent user id.
agentDisplayNames	Object	A	The agent display names. See User display names attributes
available	Boolean	A	Specify if agent statistics are available or not.
statistics	Object	A	The agent statistics. See Call center agent statistics attributes.

Group call center priority attributes

Name	Type	Methods		Description
		GET	PUT
userId	String	A	R	Unique userId for the call center.
name	String	A	F	The call center name.
priority	Number	A	R	The call center priority. When the setting ‘CC_ROUTING_PRIORITY_VALIDATION’ is True, the priority must be an integer value. Otherwise the priority can be either an integer or a float value with one decimal position.

Group number activation status attributes

Name	Type	Methods		Description
		GET	PUT
phoneNumber	String	A	R	The phone number.
activated	Boolean	A	R	Specify if the phone number is activated or not.

Group number activation status attributes

Name	Type	Method	Description
		PUT
activated	Boolean	R	Specify if the phone numbers in range must be activated or not.
minPhoneNumber	String	R	The min range phone number.
maxPhoneNumber	String	R	The max range phone number.

Conference Host Instance

Name	Type	Methods			Description
		GET	POST	PUT
userId	String	A	R	R	Unique name for the user.
firstName	String	A	F	F	User’s first name.
lastName	String	A	F	F	User’s last name.
phoneNumber	String	A	F	F	Phone number.
extension	String	A	F	F	The extension.
department	Object	A	F	F	An object as defined as Group department key attributes.
emailAddress	String	A	F	F	User’s email address.

Conference duration

Name	Type	Methods			Description
		GET	POST	PUT
hours	Integer	A	R	O	An integer representing hours within the range 0 to 23.
minutes	Integer	A	R	O	An integer representing minutes, may be one of these values: {0, 15, 30, 45}

Meet-Me Conferencing Bridge Instance

Name	Type	Methods			Description
		GET	POST	PUT
bridgeId	String	A	C	C	Uniquely identifies a bridge. See Service User Id for the ways it could be auto-generated.
serviceInstanceProfile	Object	A	R	O	Service Profile Information for a call center. See Service User Profile.
allocatedPorts	Object	A	A	O	Number of conference ports allocated to the bridge. Can either be unlimited or limited, see Group meet me conferencing ports attributes.
networkClassOfService	String	C	O	O	The Network Class of Service Name to assign to this conference bridge.
securityPinLength	Integer	A	R	O	Number of digits for the security pin that the participants must provide to join the conference. Must within the range 4 to 12.
allowIndividualOutDial	Boolean	A	A	O	Allows out-dialing to individual participants for conferences defined on this bridge.
operatorNumber	Integer	C	O	O	The phone number or SIP URI where calls to the operator during a conference are transferred.
conferenceHosts	Array	A	O	O	Assigned users as hosts on this bridge. An array of objects as Conference Host Instance.
playWarningPrompt	Boolean	A	R	O	When this option is defined, a warning announcement is played before the scheduled end of the conference. Minutes are set with ‘conferenceEndWarningPromptMinutes’.
conferenceEndWarningPromptMinutes	Integer	A	R	O	Set the minutes before the end of the conference when to play a warning announcement. Must within the range 0 to 23.
enableMaxConferenceDuration	Boolean	A	R	O	Allow a maximum duration for the conferences of this bridge.
maxConferenceDurationMinutes	Object	A	R	O	Set the maximum duration for the conferences of this bridge, in minutes. An object as Conference duration.
maxScheduledConferenceDurationMinutes	Object	A	R	O	Set the maximum duration for the scheduled conferences of this bridge, in minutes. An object as Conference duration.
active	Boolean	A	O	O	Specify if the conference bridge is active.

Meet-Me Conferencing Bridge Instance in list

Name	Type	Methods			Description
		GET	POST	PUT
bridgeId	String	A	R	R	Unique name for the conference bridge.
name	String	A	F	F	The name of the conference bridge.
phoneNumber	String	A	F	F	Phone number.
extension	String	A	F	F	The extension.
department	Object	A	F	F	An object as defined as Group department key attributes.
allocatedPorts	Object	A	F	F	Number of conference ports allocated to the bridge. Can either be unlimited or limited, see Group meet me conferencing ports attributes.
active	String	A	F	F	Specify if the conference bridge is active.

Call center disposition code attributes

Name	Type	Methods			Description
		GET	POST	PUT
code	String	F	R	F	The name of the code. For GET and PUT it is an url parameter.
active	Boolean	A	O	O	Specify if the code is active or not. Default true.
description	String	A	O	O	The description of the code.

Call center disposition code attributes when in list

Name	Type	Methods	Description
		GET
code	String	A	The name of the code. For put it is an url parameter.
active	Boolean	A	Specify if the code is active or not.
description	String	C	The description of the code.
level	String	C	The level of the code (“CallCenter”, “Group”, “Tenant”).

Group call center default disposition code attributes

Name	Type	Methods		Description
		GET	PUT
code	String	A	R	The name of the code.
level	String	A	R	The level of the code. A value from list: [‘Tenant’|’Group’|’CallCenter’].

Group call center DNIS instance

Name	Type	Methods			Description
		GET	POST	PUT
name	String	N	R	O	The unique name that identifies the DNIS.
phoneNumber	String	A	O	O	The DNIS phone number.
extension	String	A	O	O	The DNIS extension.
useCustomCLIDSettings	Boolean	A	R	O	Specify if to use custom CLID Settings.
cliPhoneNumber	String	C	O	O	The calling line id phone number.
cliLastName	String	C	C	C	The calling line id last name. Is required if ‘useCustomCLIDSettings’ is true.
cliFirstName	String	C	C	C	The calling line id first name. Is required if ‘useCustomCLIDSettings’ is true.
useCustomDnisAnnouncementSettings	Boolean	C	R	O	Specify if to use custom announcement Settings.
priority	Integer	C	R	O	The DNIS priority. A value in range 0 to 3, with 0 Highest priority and 3 Lowest priority.
allowOutgoingACDCall	Boolean	C	R	O	Allows the agent to use the DNIS number to make calls.

Group call center DNIS List item attributes

Name	Type	Method	Description
		GET
name	String	A	See ‘name’ from Group call center DNIS instance.
phoneNumber	Object	A	See ‘phoneNumber’ from Group call center DNIS instance.
extension	Boolean	A	See ‘extension’ from Group call center DNIS instance.
priority	Object	A	See ‘priority’ from Group call center DNIS instance.
primary	Object	A	Indicates if it is the primary DNIS of the call center.

Agent DNIS in list Item

Name	Type	Method	Description
		GET
userId	String	A	Unique name for the agent.
firstName	String	A	Agent’s first name.
lastName	String	A	Agent’s last name.
phoneNumber	String	A	Phone number.
extension	String	A	The extension.
department	Object	A	Uniquely identifies a department system-wide. An object as defined as Group department key attributes.
emailAddress	String	A	Agent’s email address.

Group Custom Ringback Audio File

Name	Type	Methods		Description
		GET	PUT
name	String	A	R	The announcement name.
mediaType	String	A	O	The announcement media type. If not provided, the default media type will be used.

Group number activation status attributes

Name	Type	Methods			Description
		GET	POST	PUT
name	String	N	R	O	The unique name that identifies the call park group. Used in the put requests modifies the current name. Is not returned in the get instance response, only in the get list one.
recallTo	String	A	R	O	Determines where the parked call is sent when the recall timer expires. A value from list: [‘parkingUserOnly’|’parkingUserThenAlternateUser’|’alternateUserOnly’] *parkingUserOnly: to alert only the user who parked the call. *parkingUserThenAlternateUser: to first recall the user who parked the call and the alternate user if the parking user does not answer the recall. With this selection the ‘recallAlternateUserId’ must be provided. *alternateUserOnly: to alert only the alternate user. With this selection the ‘recallAlternateUserId’ must be provided.
recallAlternateUserId	String	C	C	C	The user Id of the alternate recall user (hunt group). It is nillable only if ‘recallTo’ is set to ‘Parking User Only’.
users	Array	A	O	O	The assigned users in the order they will try to be parked on. The get response is an array of objects as defined as User common object. For put and post requests only the ‘userId’ is requested for each object. For put is a replacement list.

Available alternate recall user

Name	Type	Method	Description
		GET
userId	String	A	Unique name for the user.
firstName	String	A	User’s first name.
lastName	String	A	User’s last name.

Group call center default disposition code attributes

Name	Type	Methods		Description
		GET	PUT
action	String	A	C	The routing policy processing action to execute. Call Center Standard: a value from list [‘None’|’Busy’|’Transfer’]. Call Center Premium: a value from list [‘None’|’Busy’|’Transfer’|’Night Service’|’Ringing’|’Announcement’].
transferPhoneNumber	String	C	C	The transfer phone number, it is mandatory if action is set to ‘Transfer’.

Immediate Trunking Connectivity Numbers Range attributes

Name	Type	Methods			Description
		GET	POST	DELETE
minPhoneNumber	String	A	R	R	The min range phone number.
maxPhoneNumber	String	A	R	F	The max range phone number.
groupId	String	A	F	F	The unique id of the group.
userId	String	A	F	F	The unique id of the user.
lastName	String	A	F	F	The last name of the user.
firstName	String	A	F	F	The first name of the user.
phoneNumber	String	A	F	F	The phoneNumber name of the user.
extension	String	A	F | F | The extension of the user.
emailAddress	String	A	F | F | The email address for the user.
enterpriseTrunk	String	A	F	F	TO DO
active	Boolean	A	F	F	Specify if the range is active or not.
extensionLength	String	C	F	F	Specify the length of the extension. Introduced with patch from rel 23.

Immediate Trunking Connectivity Available Numbers Range attributes

Name	Type	Method	Description
		GET
minPhoneNumber	String	A	The min range phone number.
maxPhoneNumber	String	A	The max range phone number.
active	Boolean	A	Specify if the range is active or not.
extensionLength	String	C	Specify the length of the extension. Introduced with patch from rel 23.

Immediate Trunking Connectivity Prefixes attributes

Name	Type	Methods			Description
		GET	POST	DELETE
prefix	String	A	R	R	The prefix number.
active	Boolean	A	N	N	Specify if the range is active or not.
groupId	String	A	F	F	The unique id of the group.
userId	String	A	F	F	The unique id of the user.
lastName	String	A	F	F	The last name of the user.
firstName	String	A	F	F	The first name of the user.
phoneNumber	String	A	F	F	The phoneNumber name of the user.
extension	String	A	F | F | The extension of the user.
emailAddress	String	A	F | F | The email address for the user.
enterpriseTrunk	String	A	F	F	TO DO
extensionRangeStart	String	C	F	F	Specify the starting range of the extension. Introduced with patch from rel 23.
extensionRangeEnd	String	C	F	F	Specify the starting range of the extension. Introduced with patch from rel 23.

Immediate Trunking Connectivity Available Prefixes attributes

Name	Type	Method	Description
		GET
prefix	String	A	The prefix number.
active	Boolean	A	Specify if the range is active or not.
extensionRangeStart	String	C	Specify the starting range of the extension. Introduced with patch from rel 23.
extensionRangeEnd	String	C	Specify the starting range of the extension. Introduced with patch from rel 23.

Group instance

Name	Type	Method	Description
		GET
groupId	String	A	The unique id of the group.
tenantId	String	A	The unique id of the tenant that owns the group.

Flexible Seating Host in list attributes

Name	Type	Method	Description
		GET
serviceUserId	String	A	Uniquely identifies a flexible seating host.
name	String	A	The flexible seating host name.
cliLastName	String	C	The calling line id flexible seating host last name.
cliFirstName	String	C	The calling line id flexible seating host first name.
phoneNumber	String	A	The flexible seating host phone number.
extension	String	A	The flexible seating host extension.
department	object	A	The assigned department. An object as defined as Group department key attributes.
language	String	C	The flexible seating host language.
timeZone	String	C	The flexible seating host timeZone.
timeZoneDisplayName	String	C	The flexible seating host timeZone display name.
defaultAlias	String	C	The flexible seating host default alias.
aliases	array	C	The flexible seating host aliases. An array of strings identifying aliases.
publicUserIdentity	String	C	The flexible seating host public user identity.
cliPhoneNumber	String	C	The calling line id flexible seating host phone number.
password	String	C	The flexible seating host password.
endpoint	object	C	The flexible seating host endpoint. An object as defined as Access Device Endpoint for Flexible Seating.
networkClassOfService	String	C	The flexible seating host network class of service.
active	String	A	Specifies if the flexible seating host is active.
guestInfo	String	C	The guest info. An object as defined as Flexible Seating Guest Info. It is only returned when guest_info is sent within the request as true.
policiesInfo	String	C	The policies info. An object as defined as Flexible Seating Policies Info. It is only returned when policies_info is sent within the request as true.

Flexible Seating Host attributes

Name	Type	Methods			Description
		GET	POST	PUT
serviceUserId	String	C	O	F	Uniquely identifies a flexible seating host.
name	String	C	O	O	The flexible seating host name.
cliLastName	String	C	O	O	The calling line id flexible seating host last name.
cliFirstName	String	C	O	O	The calling line id flexible seating host first name.
phoneNumber	String	C	O	O	The flexible seating host phone number.
extension	String	C	O	O	The flexible seating host extension.
department	object	C	O	O	The assigned department. An object as defined as Group department key attributes.
language	String	C	O	O	The flexible seating host language.
timeZone	String	C	O	O	The flexible seating host timeZone.
aliases	array	C	F	O	The flexible seating host aliases. An array of strings identifying aliases.
publicUserIdentity	String	C	F	O	The flexible seating host public user identity.
cliPhoneNumber	String	C	O	O	The calling line id flexible seating host phone number.
password	String	C	O	O	The flexible seating host password.
endpoint	object	C	O	O	The flexible seating host endpoint. An object as defined as Access Device Endpoint for Flexible Seating.
networkClassOfService	String	C	O	O	The flexible seating host network class of service.
active	String	C	O	O	Specifies if the flexible seating host is active.
guestInfo	String	C	F	O	The guest info. An object as defined as Flexible Seating Guest Info.
policiesInfo	String	C	F	O	The policies info. An object as defined as Flexible Seating Policies Info.

Flexible Seating Guest Info

Name	Type	Methods		Description
		GET	PUT
enforceAssociationLimit	Boolean	A	C	Specify if to define an association limit that is defined with associationLimitHours.
associationLimitHours	Integer	A	C	The hours limit for the guest association.
accessLevel	String	A	C	The access level of a flexible seating GUEST.
lastName	String	C	F	The guest last name.
firstName	String	C	F	The guest first name.
phoneNumber	String	C	F	The guest phone number.
extension	String	C	F	The guest extension.
locationDialingCode	String	C	F	The guest location dialing code.
associationDateTime	String	C	F	The guest association date time.
removeGuestAssociation	Boolean	N	C	Specify if to remove the guest association.

Flexible Seating Policies Info

Name	Type	Methods		Description
		GET	PUT
allowEmergencyCalls	Boolean	A	C	Specify if to allow emergency calls.
allowCallsToVoicePortal	Integer	A	C	Specify if to allow calls to the voice portal.

Access Device Endpoint for Flexible Seating

Name	Type	Methods			Description
		GET	POST	PUT
accessDevice	Object	A	R	R	An object as defined in Access Device. In “advanced mode”: it is not returned within the GET and it is forbidden within the PUT.
contacts	Array	C	F	F	An array of contacts.
deviceType	String	A	C	F	In the POST it is mandatory if no accessDevice is provided. Else it is ignored.
staticRegistrationCapable	Boolean	A	F	F	Specifies if the device is capable of static registration.
useDomain	Boolean	A	F	F	The user’s line number, depending on the identity/device profile type you selected. Only used by devices with static line ordering.
linePort	String	C	O	C	The device line port. In “advanced mode”: it is forbidden when there is already a host assigned, it is optional when no host is assigned.
lineNumber	Integer	C	O	C	The device line number.
staticLineOrdering	String	C	O	C	The device static line ordering.

Group route point DNIS instance

Name	Type	Methods			Description
		GET	POST	PUT
name	String	N	R	O	The unique name that identifies the DNIS.
phoneNumber	String	A	O	O	The DNIS phone number.
extension	String	A	O	O	The DNIS extension.
useCustomCLIDSettings	Boolean	A	R	O	Specify if to use custom CLID Settings.
cliPhoneNumber	String	C	O	O	The calling line id phone number.
cliLastName	String	C	C	C	The calling line id last name. Is required if ‘useCustomCLIDSettings’ is true.
cliFirstName	String	C	C	C	The calling line id first name. Is required if ‘useCustomCLIDSettings’ is true.
useCustomDnisAnnouncementSettings	Boolean	C	R	O	Specify if to use custom announcement Settings.
allowOutgoingACDCall	Boolean	C	R	O	Allows the agent to use the DNIS number to make calls.

Group route point DNIS List item attributes

Name	Type	Method	Description
		GET
name	String	A	See ‘name’ from Group route point DNIS instance.
phoneNumber	Object	A	See ‘phoneNumber’ from Group route point DNIS instance.
extension	Boolean	A	See ‘extension’ from Group route point DNIS instance.