Common Objects

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

Call Center DNIS List Item

Name	Type	Method	Description
		GET
serviceUserId	String	A
name	String	A

Call Center Instance

Name	Type	Method		Description
		GET	PUT
phoneNumber	String	A	R	Directory Number in E164 Format.
extension	String	A		Minimum length 2.
type	String	A		Value from “Basic”, “Standard”, “Premium”.
priority	String	A
routingPolicy	String	A		Only for Premium Call Centers. Value from “Priority”, “Skill”.
skillLevel	String	C	C	Only for Premium Skill based Call Centers. Range 1 - 20.

Call Center List Item

Name	Type	Method		Description
		GET	PUT
serviceUserId	String	A	R

Device attributes

Name	Type	Method	Description
		POST
level	String	O	Value from System, Service Provider, Group.

Criteria attributes

Name	Type	Methods				Description
		GET	PUT	POST	DELETE
name	String	A	R	R	R	The name of the criteria. Length >= 1.
newName	String	F	O	F	F	The new name of the criteria. Length >= 1.
active	Boolean	A	O	O	F	The status of the criteria
callsFrom	String	A	O	O	F	Specify which calls will be forwarded to your forwarding number.
fromDnCriteria	Object	A	O	R	F	An object as defined as Criteria From DN attributes
doNotPerformAction	Boolean	A	O	O	F	TODO
private	Boolean	A	O	O	F	TODO
timeSchedule	Object	A	O	O	F	A schedule object as defined as Schedule attributes.
holidaySchedule	Object	A	O	O	F	A schedule object as defined as Schedule attributes.
forwardToPhoneNumber	String	A	O	O	F	The forwarding number or SIP-URI, if is a SIP-URI must not contain “sip:” prefix. Length >= 1.
forwardToNumberSelection	String	A	O	O	F	Specify the type of forwarding for the call. One of {‘Forward To Default Number’|’Forward To Specified Number’|’Do not forward’}.

Schedule attributes

Name	Type	Methods		Description
		GET	PUT
level	String	A	O	The level of the schedule, one of {‘Service Provider’|’Group’|’User’}
name	String	A	R	The name of the schedule. Length >= 1

Criteria From DN attributes

Name	Type	Methods		Description
		GET	PUT
selection	String	A	R	Selection criteria for a DN. One of {‘Any’|’Specified Only’}
includeAnonymousCallers	Boolean	A	R	If set, all calls from private numbers forwarded directly
includeUnavailableCallers	Boolean	A	R	If set, all calls from unavailable numbers forwarded
phoneNumbers	Array	A	R	A list of DN. Max 12 entries (see Phone Number)

Location attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
id	integer	A	R	R	R	The unique ID of the location.
phoneNumber	string	A	R	R	O	The phone number (if configured, empty or absent otherwise) (See Phone Number).
numberOfRings	integer	A	O	O	O	The number of rings for the destination. Possible values are 0, 2-20.
answerConfirmationRequired	boolean	A	O	O	O	If set, the answering party must enter a confirmation digit to complete the call.

Phone List attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
name	String	A	R	O	R	The name of the phone list entry. Length in range 1 - 50. Characters not allowed: \, /.
phoneNumber	String	A	R	O	F	The phone number of the phone list entry. Length in range 1 - 30.

Trunk Device Endpoint

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	R	O	Trunk Group name. Uniquely identifies a Trunk Group within a business (or family) group. length >= 1.
linePort	String	A	R	O	length >= 1.
contacts	Array	A	O	O	maximum 5 items.

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. length >= 1.
alternateTrunkIdentity	String	C	O	O	Alternate Trunk Identity. length >= 1.