Common Objects

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

Address 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.

Call Center DNIS List Item

Name	Type	Method	Description
		GET
serviceUserId	String	A
name	String	A

Call Center DNIS Instance

Name	Type	Methods		Description
		GET	PUT
serviceUserId	String	A	R	The service user id of the call center.
name	String	A	R	The unique name of the DNIS.

Call Center Instance

The presence of the attributes may vary depending on the type of call enter and of the features enabled.

Name	Type	Method		Description
		GET	PUT
serviceUserId	String	A	R	The Call Center unique ID.
phoneNumber	String	A		The Phone number.
extension	String	A		The Extension.
available	Boolean	A	O	The status of the call center.
logOffAllowed	Boolean	A		Toggle the logOffAllowed functionality.
name	String	C		The Call Center name. Only in case of enrichCcInfo=true.
type	String	A		The Call Center type.
priority	String	A		The Priority.
routingType	String	C		The Routing Type
skillLevel	String	C	O, C	The Call Center skill level.

Call Center List Item

Name	Type	Method		Description
		GET	PUT
serviceUserId	String	A	R	The Call Center unique ID.
name	String	C	The Call Center name. Only in case of enrichCcInfo=true.

User Voice Messaging

User Voice Messaging Basic attributes

Name	Type	Methods		Description
		GET	PUT
active	Boolean	A	O	The status of the service.
processing	String	A	O
voiceMessageDeliveryEmailAddress	String	A	O
usePhoneMessageWaitingIndicator	Boolean	A	O
sendVoiceMessageNotifyEmail	Boolean	A	O
voiceMessageNotifyEmailAddress	String	A	O
sendCarbonCopyVoiceMessage	Boolean	A	O
voiceMessageCarbonCopyEmailAddress	String	A	C
transcribe	Boolean	C	O	Enable Voice Mail transcription that will be sent to the addresses defined in transcribeEmailAddresses, needs transcribe feature assigned.
transcribeEmailAddresses	Arrray	C	O	List of email addresses where the transcription of the email will be sent.
transferOnZeroToPhoneNumber	Boolean	A	O
transferPhoneNumber	String	A	O
alwaysRedirectToVoiceMail	Boolean	A	O
busyRedirectToVoiceMail	Boolean	A	O
noAnswerRedirectToVoiceMail	Boolean	A	O
outOfPrimaryZoneRedirectToVoiceMail	Boolean	A	O

User Voice Messaging Advanced attributes

Name	Type	Methods		Description
		GET	PUT
mailServerSelection	String	O	O	The type of the mail server. Default Group.
groupMailServerEmailAddress	String	C	OC	The Group mail server address.
groupMailServerUserId	String	C	OC	The Group mail server user id.
groupMailServerPassword	String	C	OC	The Group mail server password.
mailboxLimit	String Integer	C	OC	The Group mailbox limit. String value from “useGroupSetting”.
personalMailServerNetAddress	String	C	OC	The Personal mail server address.
personalMailServerProtocol	String	C	OC	The Personal mail server protocol.
personalMailServerRealDeleteForImap	Boolean	C	OC	The Personal mail server real delete for IMAP.
personalMailServerEmailAddress	String	C	OC	The Personal mail server address.
personalMailServerUserId	String	C	OC	The Personal mail server user id.
personalMailServerPassword	String	C	OC	The Personal mail server password.

User Voice Messaging Announcements attributes

Name	Type	Methods		Description
		GET	PUT
disableMessageDeposit	Boolean	A	O
disableMessageDepositAction	String	A	O
greetingOnlyForwardDestination	String	A	O	Phone Number or SIP URI that can be used to dial.
busyAnnouncementSelection	Boolean	A	O
busyPersonalAudioFile	Object/String	A	O	An object as defined in Announcement File Name or an empty string to unassign the announcement.
noAnswerNumberOfRings	Integer	A	O
extendedAwayEnabled	Boolean	A	O
extendedAwayDisableMessageDeposit	Boolean	A	O
extendedAwayAudioFile	Object/String	A	O	An object as defined in Announcement File Name or an empty string to unassign the announcement.
noAnswerAnnouncementSelection	String	A	O
noAnswerPersonalAudioFile	Object/String	A	O	An object as defined in Announcement File Name or an empty string to unassign the announcement.
noAnswerAlternateGreeting01	Object	A	O	An object as defined in Voice Messaging Alternate No Answer Greeting.
noAnswerAlternateGreeting02	Object	A	O	An object as defined in Voice Messaging Alternate No Answer Greeting.
noAnswerAlternateGreeting03	Object	A	O	An object as defined in Voice Messaging Alternate No Answer Greeting.

Voice Messaging Alternate No Answer Greeting

Name	Type	Methods		Description
		GET	PUT
name	String	A	R
audioFile	Object	A	R	An object as defined in Announcement File Name.

Call Forwarding attributes

Name	Type	Methods		Description
		GET	PUT
active	Boolean	A	O	The status of the service.
destination	String	A	O	The destination.
ringSplashActive	Boolean	A	O
numberOfRings	Integer	A	O

Services Summary attributes

Name	Type	Method	Description
		GET
userServices	Array	A	A list of objects as defined in Service Summary attributes. Returned if relevant.
groupService	Array	A	A list of objects as defined in Service Summary attributes. Returned if relevant.

Services Assignment Status attributes

Name	Type	Method	Description
		GET
userServices	Array	O	A list of objects as defined in Service Assignment Status attributes. Returned if relevant.
groupService	Array	O	A list of objects as defined in Service Assignment Status attributes. Returned if relevant.

Service Assignment Status attributes

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

Phone List attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
name	String	A	R	O	R	See name from Phone List attributes.
phoneNumber	String	A	R	O	F	See phoneNumber from Phone List attributes.

Criteria in List attributes

Name	Type	Method	Description
		GET
name	String	A	The name of the criteria
active	Boolean	A	The status of the criteria
callsFrom	String	A	Text representation of fromDnCriteria
fromDnCriteria	Object	A	An object as defined as Criteria From DN attributes
doNotPerformAction	Boolean	C	Used to define a period of time/people that will be excluded from the main criteria For example one is “reject all calls during lunch time” and second one is “never if my boss”. Not relevant for forwarding service as forwardToNumberSelection is used instead.
timeScheduleObj	Object	O	A schedule object as defined as Schedule attributes.
timeSchedule	String	O	The schedule name with, at the end, between parenthesis the level if not the default one
holidaySchedule	Object	O	A schedule object as defined as Schedule attributes.
holidayScheduleObj	String	O	The schedule name with, at the end, between parenthesis the level if not the default one

Criteria attributes

Name	Type	Methods				Description
		GET	PUT	POST	DELETE
name	String	A	R	R	R	The name of the criteria
newName	String	F	O	F	F	The new name of the criteria. Only update
active	Boolean	A	O	O	F	The status of the criteria
fromDnCriteria	Object	A	O	R	F	An object as defined as Criteria From DN attributes
doNotPerformAction	Boolean	C	O	O	F	Used to define a period of time/people that will be excluded from the main criteria For example one is “reject all calls during lunch time” and second one is “never if my boss”. Not relevant for forwarding service as forwardToNumberSelection is used instead.
timeSchedule	Object	O	O	O	F	A schedule object as defined as Schedule attributes. In a PUT, Null to remove.
holidaySchedule	Object	O	O	O	F	A schedule object as defined as Schedule attributes. In a PUT, Null to remove.

Criteria attributes for Call Forwarding Selective

The criteria is the combination of the generic criteria (Criteria attributes or Criteria in List attributes) and specific attributes for this service.

Name	Type	Methods				Description
		GET	PUT	POST	DELETE
forwardToPhoneNumber	String	C	O	O	F	The specific forwarding number you want to use for this entry.
forwardToNumberSelection	String	A	O	O	F	Specify the type of forwarding for the call, Allowed values: “Forward To Specified Number”, “Forward To Default Number” and “Do not forward”

Criteria attributes for Custom Ring Back

The criteria is the combination of the generic criteria (Criteria attributes or Criteria in List attributes) and specific attributes for this service.

Name	Type	Methods				Description
		GET	PUT	POST	DELETE
audioSelection	String	A	O	O	F	Specify the source of the custom ring back for normal calls.
audioFile	Object	A	O	O	F	An object as defined in Announcement File Name. With default level ‘User’.
callWaitingAudioSelection	String	A	O	O	F	Specify the source of the custom ring back for the calls handled by the call waiting feature.
callWaitingAudioFile	Object	A	O	O	F	An object as defined in Announcement File Name. With default level ‘User’.

Criteria attributes for Executive and Executive Assistant

The criteria is the combination of the generic criteria (Criteria attributes) and specific attributes for this service.

Name	Type	Methods				Description
		GET	PUT	POST	DELETE
filter	Boolean	A	O	O	F	True to route calls to executive assistants, false Otherwise.

Schedule attributes

Name	Type	Methods			Description
		GET	PUT	POST
level	String	A	O	R	The level of the schedule. If not provided, a default value from API level. Allowed values are Tenant, Group and User
name	String	A	R	R	The name of the schedule.

Criteria From DN attributes

Indicate which calls will activate the criteria.

Name	Type	Methods			Description
		GET	PUT	POST
selection	String	A	O	R	Indicate which numbers will activate the criteria : “Any” (all numbers, the other parameters are ignored) or “Specified Only” (the other attributes are taken into account). In case of Selective Call Rejection service an additional value is possible “Forwarded”. In case of Priority Alerting the value “Any” is replaced by “Any External”.
includeAnonymousCallers	Boolean	A	O	R	If set, all calls from private numbers will activate the criteria.
includeUnavailableCallers	Boolean	A	O	R	If set, all calls from unavailable numbers will activate the criteria.
phoneNumbers	Array	A	C	C	A list of DN (see Phone Number). The old list will be overwrited. An empty list will delete data. List can’t be empty if ‘selection’ value is set to ‘Specified Only’. Only in PUT: if ‘selection’ field is set to ‘Specified Only’ and if the actual criteria instance already has a phoneNumbers list set, then the ‘phoneNumbers’ field list can be not present (the list will not be overwrited).

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
answerConfirmationRequired	boolean	A	O	O	O	If set, the answering party must enter a confirmation digit to complete the call.

Registrations attributes

Name	Type	Method	Description
		GET
deviceLevel	String	A	The level of the device
deviceName	String	A	The unique name of the device.
order	String	A	TODO
URI	String	A	TODO
expiration	String	O	The expiration date of the registration, if one is defined.
linePort	String	A	The line port associated to the registration.
endpointType	String	A	The indication if it is a Primary device or a secondary device (Shared Call Appearance).
publicNetAddress	String	A	The public net address of the device.
publicPort	String	A	TODO
PrivateNetAddress	String	A	The private net address of the device.
PrivatePort	String	A	TODO
UserAgent	String	A	The SIP User Agent registered by the device.
LockoutStarted	String	A	TODO
LockoutExpires	String	A	TODO
LockoutCount	String	A	TODO

Criteria in list

Name	Type	Method	Description
		GET
active	Boolean	A	The status of the criteria.
name	String	A	The name of the criteria.
timeSchedule	String	A	The name of the schedule.
timeScheduleObj	Object	O	A schedule object as defined as Schedule attributes.
holidaySchedule	String	A	The name of the schedule.
holidayScheduleObj	String	O	The schedule name with, at the end, between parenthesis the level if not the default one
callsFrom	String	A	Text representation of fromDnCriteria
doNotPerformAction	Boolean	A	A boolean flag to indicate to not preform the priority alerting.
fromDnCriteria	Object	A	An object as defined as Criteria From DN attributes
callToNumbers	Array	C	An array of objects as defined as Call To Number attributes. Only returned from Rel21. In Rel22 only returned in AS data mode.

Call To Number attributes

Name	Type	Methods			Description
		GET	PUT	POST
type	String	A	R	R	The value comes from list: {‘Primary’|’Alternate1’|’Alternate2’|’Alternate3’|’Alternate4’|’Alternate5’|’Alternate6’|’Alternate7’|’Alternate8’|’Alternate9’|’Alternate10’|’BroadWorks Mobility’}.
number	String	C	C	C	The value of the phone number for the corresponding type, when the number is available. i.e. Alternate 1 may have extension, but no number.
extension	String	C	C	C	The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. For Mobility Calls To Type, this is always blank.

User Device Extra Endpoint Attributes

Name	Type	Method	Description
		GET
deviceName	String	A	The name of the device.
deviceType	String	A	The type of the device.
deviceOwner	String	A	The user owner of the device.
deviceUsage	String	A	The type of the device: value from “APP”, “PHONE”.
_description	String	A	The description “extra-own-device-” followed by a number indicates the number of the extra device. NOTE: for internal user only. An other format can be configured via the settings PATTERN_USER_EXTRA_OWN_DEVICE but only 1 is supported in a deployement
extra_phone_id	Integer	A	The etxra_phone_id (extracted for the data generatred from it).
linePort	String	A	The line port associated to this device.

User Device Extra Line Attributes

Name	Type	Method	Description
		GET
userId	String	A	The userId of the user who has duplicated his line on this phone.
linePort	String	A	The linePort of this extra line.
firstName	String	A	The first name of the user who has duplicated his line on this phone.
lastName	String	A	The last name of the user who has duplicated his line on this phone.
phoneNumber	String	O	The phone number of the user who has duplicated his line on this phone.
department	Object	O	The department of the user who has duplicated his line on this phone.
order	Integer	A	The order of the extra line.

User Device Add Extra Line Result Attributes

Name	Type	Description
userId	String	The userId of the user who’s line has been replicated on this phone.
status	String	The status of the add line operation : one of “SUCCESS” or “FAILED”.
data	Object	In case of success, the same data as in the result of Create an Additional Phone for a User.
reason	String	In faire of failure, the reason of the failure.
error	Object	In faire of failure, the error object such as in a regular API answer.

Announcement File Name

Name	Type	Methods		Description
		GET	PUT
name	String	A	R	The name of an existing announcement. You may use keyword DELETE to suppress an existing announcement.
mediaType	String	A	O	The media type of the announcement.

Supervised Agent

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
userId	string	A	R	R	R	The user id of the supervised agent.
lastName	string	A	F	F	F	The last name of the supervised agent.
firstName	string	A	F	F	F	The first name of the supervised agent.
phoneNumber	string	C	F	F	F	The phone number (if configured, empty or absent otherwise).
extension	string	C	F	F	F	The extension (if configured, empty or absent otherwise).
department	string	C	F	F	F	The department of the supervised agent. (if configured, empty or absent otherwise) (See Group department key attributes).
emailAddress	string	C	F	F	F	The email address of the supervised agent (if configured, empty or absent otherwise).
impId	string	C	F	F	F	The imp id of the supervised agent (if configured, empty or absent otherwise).
locationCode	string	C	F	F	F	The location code of the supervised agent (if configured, empty or absent otherwise).

Meet-Me Conferencing Bridge Instance in list

Name	Type	Method	Description
		GET
bridgeId	String	A	Unique name for the conference bridge.
name	String	A	The name of the conference bridge.
phoneNumber	String	A	Phone number.
extension	String	A	The extension.
allocatedPorts	Object	A	Number of conference ports allocated to the bridge. Can either be unlimited or limited, see Group meet me conferencing ports attributes.
active	String	A	Specify if the conference bridge is active.

Schedule recurrence attributes

Name	Type	Methods			Description
		GET	PUT	POST
recurInterval	Integer	C	C	C	Specify the frequency of occurrence in days.

Schedule recurrence attributes

Name	Type	Methods			Description
		GET	PUT	POST
recurInterval	Integer	C	C	C	Specify the frequency of occurrence in weeks.
Sunday	Boolean	A	R	R	Specify the day or days of the week on which the conference should run.
Monday	Boolean	A	R	R	Specify the day or days of the week on which the conference should run.
Tuesday	Boolean	A	R	R	Specify the day or days of the week on which the conference should run.
Wednesday	Boolean	A	R	R	Specify the day or days of the week on which the conference should run.
Thursday	Boolean	A	R	R	Specify the day or days of the week on which the conference should run.
Friday	Boolean	A	R	R	Specify the day or days of the week on which the conference should run.
Saturday	Boolean	A	R	R	Specify the day or days of the week on which the conference should run.

Recur monthly by day attributes

Name	Type	Methods			Description
		GET	PUT	POST
recurInterval	Integer	C	C	C	Specify the frequency of occurrence in months.
dayOfMonth	Integer	A	R	R	Specify to schedule the conference on a specific day of the month, for example the 27th. Must be a number within the range 1 to 31.

Recur monthly by week attributes

Name	Type	Methods			Description
		GET	PUT	POST
recurInterval	Integer	C	C	C	Specify the frequency of occurrence in months.
dayOfWeekInMonth	String	A	R	R	Specify to schedule the conference on a specific day of the week within the month, for example the Second Monday of the month. Select here the week in month, a value from list: {‘First’|’Second’|’Third’|’Fourth’|’Last’}.
dayOfWeek	String	A	R	R	Specify to schedule the conference on a specific day of the week within the month, for example the Second Monday of the month. Select here the day in the week, a value from list: {‘Sunday’|’Monday’|’Tuesday’|’Wednesday’|’Thursday’|’Friday’|’Saturday’}.

Recur yearly by day attributes

Name	Type	Methods			Description
		GET	PUT	POST
recurInterval	Integer	C	C	C	Specify the frequency of occurrence in years.
dayOfMonth	Integer	A	R	R	Specify to schedule the conference on a specific day of the year. Define here the day in the month: a number within the range 1 to 31.
month	String	A	R	R	Specify to schedule the conference on a specific day of the year. Define here the month. A value from list: {‘January’|’February’|’March’|’April’|’May’|’June’|’July’|’August’|’September’|’October’|’November’|’December’}.

Recur yearly by week attributes

Name	Type	Methods			Description
		GET	PUT	POST
recurInterval	Integer	C	C	C	Specify the frequency of occurrence in years.
dayOfWeek	Integer	A	R	R	Specify to schedule the conference on a specific day of the week and month, for example the first Sunday of January. Select here the day of week, a value from list: {‘Sunday’|’Monday’|’Tuesday’|’Wednesday’|’Thursday’|’Friday’|’Saturday’}.
dayOfWeekInMonth	Integer	A	R	R	Specify to schedule the conference on a specific day of the week and month, for example the first Sunday of January. Select here the week in the month, a value from list: {‘First’|’Second’|’Third’|’Fourth’|’Last’}.
month	Integer	A	R	R	Specify to schedule the conference on a specific day of the week and month, for example the first Sunday of January. Select here month in the year, a value from list: {‘January’|’February’|’March’|’April’|’May’|’June’|’July’|’August’|’September’|’October’|’November’|’December’}.

Schedule recurrence attributes

Name	Type	Methods			Description
		GET	PUT	POST
recurDaily	Object	A	C	R	Daily recurrence and specify the frequency of occurrence in days. Mutually exclusive with: {‘recurWeekly’, ‘recurMonthlyByDay’, ‘recurMonthlyByWeek’, ‘recurYearlyByDay’, ‘recurYearlyByWeek’}
recurWeekly	Object	C	C	C	Weekly recurrence and specify the frequency of occurrence in weeks, and the day or days of the week on which the conference should run. Mutually exclusive with: {‘recurDaily’, ‘recurMonthlyByDay’, ‘recurMonthlyByWeek’, ‘recurYearlyByDay’, ‘recurYearlyByWeek’}
recurMonthlyByDay	Object	C	C	C	Monthly recurrence and specify to schedule the conference on a specific day of the month. Mutually exclusive with: {‘recurDaily’, ‘recurWeekly’, ‘recurMonthlyByWeek’, ‘recurYearlyByDay’, ‘recurYearlyByWeek’}
recurMonthlyByWeek	Object	C	C	C	Monthly recurrence and specify to schedule the conference on a specific day of the week within the month. Mutually exclusive with: {‘recurDaily’, ‘recurWeekly’, ‘recurMonthlyByDay’, ‘recurYearlyByDay’, ‘recurYearlyByWeek’}
recurYearlyByDay	Object	C	C	C	Yearly recurrence and specify to schedule the conference on a specific day of the year. Mutually exclusive with: {‘recurDaily’, ‘recurWeekly’, ‘recurMonthlyByDay’, ‘recurMonthlyByWeek’, ‘recurYearlyByWeek’}
recurYearlyByWeek	Object	C	C	C	Yearly recurrence and specify to schedule the conference on a specific day of the week and month. Mutually exclusive with: {‘recurDaily’, ‘recurWeekly’, ‘recurMonthlyByDay’, ‘recurMonthlyByWeek’, ‘recurYearlyByDay’}
recurForEver	Boolean	C	C	C	Specify if the conference should recur continuously or not. Mutually exclusive with: {‘recurEndDate’, ‘recurEndOccurrence’}
recurEndDate	Date	C	C	C	Specify to end the conference on a specific date. Format “%Y-%m-%d”, example: “2025-09-09”. Mutually exclusive with: {‘recurForEver’, ‘recurEndOccurrence’}
recurEndOccurrence	Integer	C	C	C	Specify to end the conference after specified number of occurrences. Mutually exclusive with: {‘recurForEver’, ‘recurEndDate’}

Meet-Me Conferencing Conference schedule reservationLess

Name	Type	Methods			Description
		GET	PUT	POST
startTime	DateTime	A	C	R	The conference start date and time. Format rfc3339, example: “2024-08-01T11:00:00.000+02:00”.
endTime	DateTime	C	C	C	The conference end date and time. Format rfc3339, example: “2024-08-01T11:00:00.000+02:00”. If not provided, the conference will not have an end date.

Meet-Me Conferencing Conference schedule one time

Name	Type	Methods			Description
		GET	PUT	POST
startTime	DateTime	A	C	R	The conference start date and time.
duration	Object	C	C	C	The conference duration. See Conference duration.

Meet-Me Conferencing Conference schedule recurring

Name	Type	Methods			Description
		GET	PUT	POST
startTime	DateTime	A	C	R	The conference start date and time. Format rfc3339, example: “2024-08-01T11:00:00.000+02:00”.
duration	Object	C	C	C	The conference duration. See Conference duration.
recurrence	Object	C	C	R	Specify the recurrence pattern. See Schedule recurrence attributes.

Meet-Me Conferencing Conference Schedule

Name	Type	Methods			Description
		GET	PUT	POST
scheduleReservationless	Object	C	C	C	Set the conference type to ‘Reservationless’. See Meet-Me Conferencing Conference schedule reservationLess. Mutually exclusive with: {‘scheduleOneTime’, ‘scheduleRecurring’}.
scheduleOneTime	Object	C	C	C	Set the conference type to ‘One Time’. See Meet-Me Conferencing Conference schedule one time. Mutually exclusive with: {‘scheduleReservationless’, ‘scheduleRecurring’}.
scheduleRecurring	Object	C	C	C	Set the conference type to ‘Recurring [‘Daily’|’Weekly’|’Monthly’|’Yearly’]’. See Meet-Me Conferencing Conference schedule recurring. Mutually exclusive with: {‘scheduleReservationless’, ‘scheduleOneTime’}.

Meet-Me Conferencing Conference Instance in list

Name	Type	Method	Description
		GET
bridgeId	String	A	Unique Id for the conference bridge.
conferenceId	String	A	Unique Id for the conference.
title	String	A	The conference title.
bridgeName	String	A	The bridge name.
status	String	A	The conference status. Can be ‘active’, ‘inactive’ or ‘expired’.
type	String	A	Specify the conference type. Can be ‘Reservationless’, ‘One Time’, ‘Recurring Daily’, ‘Recurring Weekly’, ‘Recurring Monthly’ or ‘Recurring Yearly’.
startTime	DateTime	A	Start Time is in the format “yyyy-MM-dd’T’HH:mm:ss:SSSZ”. Example: 2010-10-01T09:30:00:000-0400.
lastName	String	A	The user last name.
firstName	String	A	The user first name.
hostId	String	A	The Id of the conference host.

Meet-Me Conferencing Conference Instance

Name	Type	Methods			Description
		GET	PUT	POST
title	String	A	C	R	The conference title.
estimatedParticipants	Integer	C	C	C	The number of participants the conference may have. Can’t be higher than the maximum number of ports available on the bridge on which this conference is hosted.
restrictParticipants	Boolean	C	C	R	Specify if to set a maximum number of participants to the conference.
maxParticipants	Integer	C	C	R	If ‘restrictParticipants’ is true, specify the maximum number of participants the conference can have. Can’t be higher than the maximum number of ports available on the bridge on which this conference is hosted.
accountCode	String	C	C	C	The account code to use for the conference.
muteAllAttendeesOnEntry	Boolean	A	C	R	If this option is enabled, all attendees will be muted on entry. For conferences with more than 147 attendees: attendees are muted on entry.
endConferenceOnModeratorExit	Boolean	A	C	R	If this option is enabled, the conference will be ended when host departs.
moderatorRequired	Boolean	A	C	R	If this option is enabled, the moderator is required to start the conference.
requireSecurityPin	Boolean	A	C	R	Specify if to enable the security pin to access the conference.
securityPin	String	C	F	F	The security pin to provide if ‘requireSecurityPin’ is enabled. Conditionally returned: only if the security pin is required for this conference.
allowUniqueIdentifier	Boolean	A	C	R	Allow unique identifier.
attendeeNotification	String	A	C	R	Specify how to notify the conference attendees when other attendees join or leave the conference. The value is one of: ‘Play Tone’, ‘Play Recorded Name’, ‘No Notification’. For conferences with more than 147 attendees: the entry/exit tones and name announcements are disabled.
conferenceSchedule	Object	A	C	R	Specify the type of conference you want to create. Select One Time, Recurring, or Reservationless. See Meet-Me Conferencing Conference Schedule.
moderatorPin	String	A	F	F	The moderator pin code.
hostTimeZone	String	A	F	F	The time zone of the host.

Conference greeting announcement

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

Conference delete recording item

Name	Type	Method	Description
		DELETE
bridgeId	String	R	The bridge id.
conferenceId	String	R	The conference id.
startTime	DateTime	R	The conference start time. Format rfc3339, example: “2020-08-01T11:00:00.000+02:00”.

Conference Delegate item

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

User common object

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.
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.

Devices To Ring

Name	Type	Methods			Description
		GET	PUT	POST
mode	String	A	O	R	Specifies the alerting policy mode. A value from list: [‘Fixed’,’Mobile’,’Both’}. Fixed: to ring fixed devices for calls to this mobile number, check also one or more of the following options to specify which devices to ring: ‘includeSharedCallAppearance’, ‘includeAnywhere’. Mobile: to ring mobile devices for calls to this mobile number and add one or more alerted mobile numbers. Both: to ring both fixed and mobile devices. Inherit above behaviours.
includeSharedCallAppearance	Boolean	A	O	R	Specifies if to ring the Shared Call Appearance devices.
includeAnywhere	Boolean	A	O	R	Specifies if to ring the Anywhere devices.
includeExecutiveAssistant	Boolean	A	O	R	Specifies if to ring the Executive Assistant devices.
mobilesNumbers	Array	A	O	O	A list of the alerted mobile numbers. An array of items as defined as User alerted mobile number. Replacement list for PUT request.

User identity mobile number

Name	Type	Method	Description
		GET
mobileNumber	String	A	Mobile number.
description	String	A	The description of the mobile number.
countryCode	String	A	The country code of the number.
nationalPrefix	String	A	The prefix used for national numbers.
primary	String	A	Specify if it is the primary mobile number.
enableAlerting	String	A	Specify if the mobile number is enabled for alerting.

User alerted mobile number

Name	Type	Method			Description
		GET	PUT	POST
mobileNumber	String	A	R	R	Mobile number to be alerted.
countryCode	String	A	F	F	The country code of the number.
nationalPrefix	String	A	F	F	The prefix used for national numbers.

Flexible seating available host attributes

Name	Type	Method	Description
		GET
serviceUserId	String	A	The host user id.
lastName	String	A	The host last name.
firstName	String	A	The host first name.
phoneNumber	String	A	The host phone number.
extension	String	A	The host extension.
department	Object	A	The host department. An object as defined as Group department key attributes.
emailAddress	String	A	The host email address.
associationLimitHours	Integer	A	Specifies the host association limit in hours.
enableAssociationLimit	Boolean	A	Specifies if the host has an association time limit, time limit is defined in hostAssociationLimitHours.

Advanced Flexible seating available host 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.

Call Anchoring

Name	Type	Methods			Description
		GET	PUT	POST
enableCallAnchoring	Boolean	A	O	R	Specifies if to enable call anchoring.
timeSchedule	Object	C	O	O	Excluded Time Schedule. A schedule object as defined as Schedule attributes.
holidaySchedule	Object	C	O	O	Excluded Holiday Schedule. A schedule object as defined as Schedule attributes.

Feature Access Code

Name	Type	Method		Description
		GET	PUT
name	String	A	R	Feature Access Code Name
code	String	A	F	Feature Access Code
alternateCode	String	C	F	Alternative Feature Access Code.
enabled	Boolean	A	O	Specify if Feature Access Code is enabled or not