Luware Nimbus (Preview)

Connector to use with Luware Nimbus Solution.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Luware Helpdesk
URL	https://helpdesk.luware.cloud/
Email	nimbus.support@luware.com

Connector Metadata
Publisher	Luware AG
Website	https://luware.com/
Privacy Policy	https://luware.com/en/privacy-policy/
Categories	Communication;Collaboration

The Luware Nimbus Connector allows for integration between Nimbus and 3rd party software such as CRMs or ticketing systems. It lets you listen to task and scheduler entry events happening in Luware Nimbus. You can create tasks, enrich existing tasks with caller information data, add routing parameters or trigger an event in your 3rd party system. Additionally you can manage address books, schedule outbound calls or add external tasks.

Some use cases are:

• Show contact details in Nimbus for an inbound call.
• Persist choice of language from IVR in Nimbus to a CRM.
• Create an after-call work item after the call in a CRM.
• Create a call-back task for a missed call in a CRM.
• Create a Nimbus outbound call based on a campaign in the CRM.
• Route a call according to customer preferences.
• Show caller preferences for an inbound call.
• Create tickets in a 3rd party system.
• Create a list of missed calls in a 3rd party system.
• Open the customer's record when an agent takes the call.

Please find more information and lots of help on Luware’s knowledge base: https://help.luware.com/nimbus/?contentKey=powerautomate

Prerequisites

• A Microsoft PowerApps or PowerAutomate plan with "Premium" tier
• An Azure tenant
• At least one Luware Nimbus Service provisioned
• A role in Luware Nimbus allowing the usage of the Luware Nimbus connector (https://help.luware.com/nimbus/?contentKey=PARBAC)

How to get credentials

Since Nimbus APIs are secured by Azure Active Directory (AAD) / Microsoft Entra ID, we first need to set up a few things in Azure AD / Entra ID so that the connector can securely access Luware Nimbus. After that is completed, you can create and test the connector.

Set up an Azure AD / Entra ID application for your connector

You first need to register your connector as an application in Azure AD / Entra ID. This will allow the connector to identify itself to Azure AD so that it can ask for permissions to access Luware Nimbus API on behalf of the end user. You can read more about this here: https://docs.microsoft.com/en-us/azure/active-directory/develop/authentication-scenarios and follow the steps below:

1. Create an Azure AD / Entra ID application This Azure AD / Entra ID application will be used to identify the connector to Luware Nimbus. This can be done using Azure Portal (https://portal.azure.com), by following the steps here(https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app). Once created, note down the value of Application (Client) ID. You will need this later.

2. Configure or Update your Azure AD / Entra ID application to access the Luware Nimbus API. This step will ensure that your application can successfully retrieve an access token to invoke Luware Nimbus on behalf of your users. To do this, follow the steps here: https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-configure-app-access-web-apis.

   • For redirect URI, use “https://global.consent.azure-apim.net/redirect”
   • For the credentials, use a client secret (and not certificates). Remember to take note of the secret, you will need this later and it is shown only once.
   • For API permissions, make sure “User.Read” (delegated) are added.

At this point, we now have a valid Azure AD / Entra ID application that can be used with your O365 Account to get permissions from end users and access Luware Nimbus.

Get started with your connector

1. Select the "When a task changes state" trigger on the Luware Nimbus triggers.
2. Configure your Nimbus Service on which you want to listen to incoming calls.
3. Select the Event "System accepted" (Triggered when the "Accept Conversation" activity in the Workflow is reached).
4. Implement the lookup of the caller information based on the Caller Telephone Number e.g. in your CRM or for testing purposes in an Excel Sheet hosted on Sharepoint.
5. Use the action "Update Task" to set the customer information like Firstname/Lastname, Address, City, Country, etc. on the task.

Refer to our use case section on the knowledge base: https://help.luware.com/nimbus/?contentKey=pauclist

Known issues and limitations

• Losing permissions (RBAC) in Luware Nimbus will disable triggers in power automate without transparent information for the end user. Flows will just not be triggered anymore.
• Luware doesn't have influence on the execution time of flows, so results can arrive back in Nimbus with a delay. Workflows depending on the completion of the flow should be built keeping this limitation in mind.

Common errors and remedies

HTTP error code:

• 400: The request you've sent to the Luware Nimbus API contains not valid parameters or they can't be applied. Examples: All passed preferred users are invalid, therefore preferred users are not set OR You try to delete an External Task when it's already assigned to a user.
• 401: The provided authentication token can't be parsed or is invalid. Check the correct setup of the Azure AD / Entra ID application registration and that you've provided the correct credentials for your O365 Account.
• 403: Your account lacks the necessary permissions in Nimbus to perform the action configured in your flow. Please refer to the Knowledge Base and reach out to your administrator in case you need additional roles/rights.
• 404: The passed identifier(s) can't be matched to any entity in the backend.

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Location	string	The location your tenant is located in.	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add a contact to an address book	Adds a new contact to a specific address book. The ExternalId is used as reference in further requests.
Add a new external task	Add a new external task
Empty an address book	Remove all contacts in the specified address book.
Get all scheduler entries	Returns all scheduler entries for the service specified.
Get contact(s) from an address book	Returns contacts from an address book.
Remove a scheduler entry	Remove a scheduler entry from the system. Only possible, while the scheduler entry is not yet in progress.
Remove an external task	Remove an external task
Remove contact(s) from an address books	Remove one or many contacts from an address book.
Schedule a new outbound call	Schedule a new outbound call (scheduler entry).
Update a contact in an address book	Updates a single contact in the specified address book.
Update a scheduler entry	Change settings for an already created scheduler entry.
Update task	Update customer information, context parameter and/or preferred user settings for a task in progress.

Add a contact to an address book

Operation ID:

AddContact

Adds a new contact to a specific address book. The ExternalId is used as reference in further requests.

Parameters

Name	Key	Required	Type	Description
Addressbook	AddressBook	True	string	The addressbook to add the contact to.
Contact External ID	externalId	True	string	ID of the contact given by the external system.
Contact First Name	firstName		string	First name of the contact.
Contact Last Name	lastName		string	Last name of the contact.
Contact Display Name	displayName		string	Display name of the contact.
Contact Initials	initials		string	Initials of the contact.
Contact Company	company		string	Company of the contact.
Contact Department	department		string	Department of the contact.
Contact Job Title	jobTitle		string	Job title of the contact.
Contact User Principal Name	userPrincipalName		string	User principal name of the contact.
Contact IM Addresses	imAddresses		array of string	List of IM addresses.
Contact Email Addresses	emailAddresses		array of string	List of email addresses.
Contact Business Phones	businessPhones		array of string	List of business phones.
Contact Mobile Phones	mobilePhones		array of string	List of mobile phones.
Contact Home Phones	homePhones		array of string	List of home phones.
Address Street	street		string	Street and number of the address.
Address City	city		string	City of the address.
Address Country	country		string	Country of the address.
Address State	state		string	State of the address.
Address Postcode	postalCode		string	Postcode of the address.
Name	name	True	string	Designation of the custom field.
Value	value		string	Value of the custom field.

Returns

Body

ContactReadDto

Add a new external task

Operation ID:

AddExternalTask

Add a new external task

Parameters

Name	Key	Required	Type	Description
Service UPN	serviceUpn	True	string	UPN of the service.
Customer Identifier	customerIdentifier		string	Optional unique reporting identifier, anonymous when empty.
Customer First Name	firstName		string	First name of the customer.
Customer Last Name	lastName		string	Last name of the customer.
Customer Display Name	displayName		string	Display name of the customer.
Customer Company	company		string	Company of the customer.
Customer Job Title	jobTitle		string	Job title of the customer.
Customer Department	department		string	Department of the customer.
Customer Street Address	streetAddress		string	Street address of the customer.
Customer Postcode	postCode		string	Postcode of the customer.
Customer City	city		string	City of the customer.
Customer State	state		string	State of the customer.
Customer Country	country		string	Country of the customer.
Customer Primary Telephone Number	primaryTelNumber		string	Primary telephone number of the customer.
Name	name	True	string	Designation of the telephone number.
Value	value		string	Value of the telephone number.
Customer UPN	UPN		string	UPN of the customer.
Customer IM Address	imAddress		string	IM Address of the customer.
Customer Email	email		string	Email of the customer.
Name	name	True	string	Designation of the custom field.
Value	value		string	Value of the custom field.
Name	name	True	string	Name of the custom context parameter.
Value	value		string	Value of the custom context parameter.
Distribution Priority	distributionPriority		string	Priority with which the task should be handled in Nimbus once it's due.
UPN	upn	True	string	The UPN of the preferred user.
Priority	priority		integer	The priority. 1 high to 99 low.

Returns

Body

ExternalTaskWriteResult

Empty an address book

Operation ID:

ClearContacts

Remove all contacts in the specified address book.

Parameters

Name	Key	Required	Type	Description
Addressbook	AddressBook	True	string	The addressbook to empty

Get all scheduler entries

Operation ID:

GetSchedulerEntries

Returns all scheduler entries for the service specified.

Parameters

Name	Key	Required	Type	Description
Service UPN	serviceUpn	True	string	UPN of the service for which the scheduler entries should be returned.

Returns

List of all scheduled tasks for the specified service

Scheduled Tasks

array of SchedulerEntryEventData

Get contact(s) from an address book

Operation ID:

GetContacts

Returns contacts from an address book.

Parameters

Name	Key	Required	Type	Description
Addressbook	AddressBook	True	string	The address book to get the contact(s) from.
ExternalId	externalIds		array	External IDs of the contacts to fetch. Optional: If none provided, all contacts will be returned.

Returns

The returned contacts.

Contacts

array of ContactReadDto

Remove a scheduler entry

Operation ID:

DeleteSchedulerEntry

Remove a scheduler entry from the system. Only possible, while the scheduler entry is not yet in progress.

Parameters

Name	Key	Required	Type	Description
Scheduler Entry ID	SchedulerEntryID	True	string	ID of the scheduler entry to be removed.

Remove an external task

Operation ID:

RemoveExternalTask

Remove an external task

Parameters

Name	Key	Required	Type	Description
External Task Id	externalTaskId	True	string	ID of the External Task being removed

Remove contact(s) from an address books

Operation ID:

RemoveContacts

Remove one or many contacts from an address book.

Parameters

Name	Key	Required	Type	Description
Addressbook	AddressBook	True	string	The address book to remove the contact from.
externalIds	externalIds	True	array of string

Schedule a new outbound call

Operation ID:

CreateSchedulerEntry

Schedule a new outbound call (scheduler entry).

Parameters

Name	Key	Required	Type	Description
Reference ID	ReferenceId		string	The ID for reference passed by the third-party system.
Destination	destination	True	string	Destination of the scheduler entries with direction "Outbound".
Distribution Priority	distributionPriority		string	Priority with which the task should be handled in Nimbus.
Due Date Time (UTC)	dueDateTimeUtc	True	date-time	Due date and time in UTC: Example: '2020-03-23T11:00:00Z'.
Service UPN	serviceUpn	True	string	UPN of the service.
Maximum Attempts	maxAttempts		integer	Maximum Attempts to reach the Destination.
Attempt Timeout in Seconds	attemptTimeoutInSeconds		integer	Defines how long Nimbus tries to reach the Destination before the attempt will be stopped.
Maximum Queue Time in Seconds	maxQueueTimeInSeconds		integer	Defines how long Nimbus tries to solve the task until the task is considered �Limit Reached�.
RONA Timeout in Seconds	ronaTimeoutInSeconds		integer	Defines how long Nimbus tries to reach the user until the task is considered RONA and a new user will be looked for.
Name	name	True	string	Name of the custom context parameter.
Value	value		string	Value of the custom context parameter.
Customer First Name	firstName		string	First name of the customer.
Customer Last Name	lastName		string	Last name of the customer.
Customer Display Name	displayName		string	Display name of the customer.
Customer Company	company		string	Company of the customer.
Customer Job Title	jobTitle		string	Job title of the customer.
Customer Department	department		string	Department of the customer.
Customer Street Address	streetAddress		string	Street address of the customer.
Customer Postcode	postCode		string	Postcode of the customer.
Customer City	city		string	City of the customer.
Customer State	state		string	State of the customer.
Customer Country	country		string	Country of the customer.
Customer Primary Telephone Number	primaryTelNumber		string	Primary telephone number of the customer.
Name	name	True	string	Designation of the telephone number.
Value	value		string	Value of the telephone number.
Customer UPN	UPN		string	UPN of the customer.
Customer IM Address	imAddress		string	IM Address of the customer.
Customer Email	email		string	Email of the customer.
Name	name	True	string	Designation of the custom field.
Value	value		string	Value of the custom field.

Returns

Body

SchedulerEntryEventData

Update a contact in an address book

Operation ID:

UpdateContact

Updates a single contact in the specified address book.

Parameters

Name	Key	Required	Type	Description
Addressbook	AddressBook	True	string	The addressbook to update the contact in.
Contact External ID	externalId	True	string	ID of the contact given by the external system.
Contact First Name	firstName		string	First name of the contact.
Contact Last Name	lastName		string	Last name of the contact.
Contact Display Name	displayName		string	Display name of the contact.
Contact Initials	initials		string	Initials of the contact.
Contact Company	company		string	Company of the contact.
Contact Department	department		string	Department of the contact.
Contact Job Title	jobTitle		string	Job title of the contact.
Contact User Principal Name	userPrincipalName		string	User principal name of the contact.
Contact IM Addresses	imAddresses		array of string	List of IM addresses.
Contact Email Addresses	emailAddresses		array of string	List of email addresses.
Contact Business Phones	businessPhones		array of string	List of business phones.
Contact Mobile Phones	mobilePhones		array of string	List of mobile phones.
Contact Home Phones	homePhones		array of string	List of home phones.
Address Street	street		string	Street and number of the address.
Address City	city		string	City of the address.
Address Country	country		string	Country of the address.
Address State	state		string	State of the address.
Address Postcode	postalCode		string	Postcode of the address.
Name	name	True	string	Designation of the custom field.
Value	value		string	Value of the custom field.

Returns

Body

ContactReadDto

Update a scheduler entry

Operation ID:

UpdateSchedulerEntry

Change settings for an already created scheduler entry.

Parameters

Name	Key	Required	Type	Description
Scheduler Entry ID	SchedulerEntryID	True	string	ID of the scheduler entry to be updated.
Reference ID	ReferenceId		string	The ID for reference passed by the third-party system.
Destination	destination	True	string	Destination of the scheduler entries with direction "Outbound".
Distribution Priority	distributionPriority		string	Priority with which the task should be handled in Nimbus.
Due Date Time (UTC)	dueDateTimeUtc	True	date-time	Due date and time in UTC: Example: '2020-03-23T11:00:00Z'.
Service UPN	serviceUpn	True	string	UPN of the service.
Maximum Attempts	maxAttempts		integer	Maximum Attempts to reach the Destination.
Attempt Timeout in Seconds	attemptTimeoutInSeconds		integer	Defines how long Nimbus tries to reach the Destination before the attempt will be stopped.
Maximum Queue Time in Seconds	maxQueueTimeInSeconds		integer	Defines how long Nimbus tries to solve the task until the task is considered �Limit Reached�.
RONA Timeout in Seconds	ronaTimeoutInSeconds		integer	Defines how long Nimbus tries to reach the user until the task is considered RONA and a new user will be looked for.
Name	name	True	string	Name of the custom context parameter.
Value	value		string	Value of the custom context parameter.
Customer First Name	firstName		string	First name of the customer.
Customer Last Name	lastName		string	Last name of the customer.
Customer Display Name	displayName		string	Display name of the customer.
Customer Company	company		string	Company of the customer.
Customer Job Title	jobTitle		string	Job title of the customer.
Customer Department	department		string	Department of the customer.
Customer Street Address	streetAddress		string	Street address of the customer.
Customer Postcode	postCode		string	Postcode of the customer.
Customer City	city		string	City of the customer.
Customer State	state		string	State of the customer.
Customer Country	country		string	Country of the customer.
Customer Primary Telephone Number	primaryTelNumber		string	Primary telephone number of the customer.
Name	name	True	string	Designation of the telephone number.
Value	value		string	Value of the telephone number.
Customer UPN	UPN		string	UPN of the customer.
Customer IM Address	imAddress		string	IM Address of the customer.
Customer Email	email		string	Email of the customer.
Name	name	True	string	Designation of the custom field.
Value	value		string	Value of the custom field.

Returns

Body

SchedulerEntryEventData

Update task

Operation ID:

UpdateTask

Update customer information, context parameter and/or preferred user settings for a task in progress.

Parameters

Name	Key	Required	Type	Description
Task ID	taskId	True	string	The Nimbus specific ID of the task.
Customer First Name	firstName		string	First name of the customer.
Customer Last Name	lastName		string	Last name of the customer.
Customer Display Name	displayName		string	Display name of the customer.
Customer Company	company		string	Company of the customer.
Customer Job Title	jobTitle		string	Job title of the customer.
Customer Department	department		string	Department of the customer.
Customer Street Address	streetAddress		string	Street address of the customer.
Customer Postcode	postCode		string	Postcode of the customer.
Customer City	city		string	City of the customer.
Customer State	state		string	State of the customer.
Customer Country	country		string	Country of the customer.
Customer Primary Telephone Number	primaryTelNumber		string	Primary telephone number of the customer.
Name	name	True	string	Designation of the telephone number.
Value	value		string	Value of the telephone number.
Customer UPN	UPN		string	UPN of the customer.
Customer IM Address	imAddress		string	IM Address of the customer.
Customer Email	email		string	Email of the customer.
Name	name	True	string	Designation of the custom field.
Value	value		string	Value of the custom field.
Name	name	True	string	Name of the custom context parameter.
Value	value		string	Value of the custom context parameter.
UPN	upn	True	string	The UPN of the preferred user.
Priority	priority		integer	The priority. 1 high to 99 low.

Triggers

When a scheduler entry changes state	Raised whenever a scheduler entry matching the filter criteria changes its state.
When a task changes state	Raised whenever a task matching the filter criteria changes its state.

When a scheduler entry changes state

Operation ID:

RegisterSchedulerEntryTrigger

Raised whenever a scheduler entry matching the filter criteria changes its state.

Parameters

Name	Key	Required	Type	Description
Services	services	True	array of string	UPNs of the services, for which events for the tasks should be fetched.
Scheduler Entry Events	schedulerEntryEvents	True	array of string	Events of the scheduler entry, for which this trigger should be raised.

Returns

Body

SchedulerEntryEventData

When a task changes state

Operation ID:

RegisterTaskWebHook

Raised whenever a task matching the filter criteria changes its state.

Parameters

Name	Key	Required	Type	Description
Services	services	True	array of string	UPNs of the services, for which events for the tasks should be fetched.
Task Events	taskEvents	True	array of string	Events of the tasks, for which this trigger should be raised.
Modalities	modalities		array of string	Specify the initial modalities of the tasks.
Directions	directions		array of string	Specify the directions of the tasks.

Returns

Body

TaskEventData

Definitions

TaskEventData

Name	Path	Type	Description
Task ID	taskId	string	The Nimbus specific ID of the task.
Call Chain ID	callChainId	string	The Call Chain ID from Microsoft of the task.
Event	event	string	The event which occurred within Nimbus for the task.
Direction	direction	string	Direction of the task in progress in Nimbus (Inbound/Outbound/None).
Modality	modality	string	Initial modality of the task in Nimbus.
Created	created	string	Timestamp, when the task has been created.
Terminated	terminated	string	Timestamp, when the task has been terminated.
ID of last connected user	lastConnectedUserId	string	Object ID (AAD) of the last connected user of the task.
UPN of last connected user	LastConnectedUserUPN	string	UPN of the last connected user of the task.
Email of last connected user	LastConnectedUserEmail	string	Email of the last connected user of the task.
Microsoft Caller ID	microsoftCallerId	string	Object ID (AAD) of the caller.
Reference ID	referenceId	string	The ID for reference passed by the third-party system.
Caller ID	callerId	string	Internal ID for the caller in Nimbus. Object ID (AAD) if the caller is known.
Caller Telephone Number	callerTelNumber	string	Phone number (E.164) of the caller. Set only for tasks with modality=Audio.
Caller UPN	callerUPN	string	UPN of the customer.
Microsoft Destination ID	microsoftDestinationId	string	Object ID (AAD) of the callee in an outbound task.
Destination ID	destinationId	string	Internal ID of the destination (Outbound) in Nimbus. Object ID (AAD) if the caller is known.
Destination Telephone Number	destinationTelNumber	string	Phone number (E.164) of the destination (Outbound).
Destination UPN	destinationUPN	string	UPN of the destination (Outbound).
ACS ID	acsId	string	Azure Communication ID of the caller.
Is Anonymous	isAnonymous	boolean	Flag set to true, when caller is anonymous.
Customer Identifier	customerIdentifier	string	Identifier for the customer in all task types.
Initial Message	initialMessage	string	First message the IM customer.
Service ID	serviceId	string	Internal ID of the Nimbus service.
Service Name	serviceName	string	Name of the Nimbus service.
Service Description	serviceDescription	string	Description of the Nimbus service (inherited from Microsoft Teams).
Service Display Name	serviceDisplayName	string	Display name of the Nimbus service.
Service UPN	serviceUPN	string	UPN of the Nimbus service.
Service Telephone Number	serviceTelNumber	string	Telephone number (E.164) of the Nimbus service.
Outbound Attempts	outboundAttempt	integer	Number of attempts to reach the outbound destination.
Updated Parameter Name	updatedParameterName	string	Name of the last parameter which was updated.
Updated Parameter Value	updatedParameterValue	string	Value of the last parameter which was updated.
Task Information	taskInformation	TaskInformation	Contains information about the customer, custom context parameter and preferred users.

TaskInformation

Contains information about the customer, custom context parameter and preferred users.

Name	Path	Type	Description
customer	customer	Customer	Object containing all information of the customer.
Custom Context Parameters	customContextParameters	array of CustomContextParameter	List of custom context parameters (Key-Value).
Preferred Users	preferredUsers	array of PreferredUser	List of preferred Users for the tasks (UPN-Priority).

Customer

Object containing all information of the customer.

Name	Path	Type	Description
Customer First Name	firstName	string	First name of the customer.
Customer Last Name	lastName	string	Last name of the customer.
Customer Display Name	displayName	string	Display name of the customer.
Customer Company	company	string	Company of the customer.
Customer Job Title	jobTitle	string	Job title of the customer.
Customer Department	department	string	Department of the customer.
Customer Street Address	streetAddress	string	Street address of the customer.
Customer Postcode	postCode	string	Postcode of the customer.
Customer City	city	string	City of the customer.
Customer State	state	string	State of the customer.
Customer Country	country	string	Country of the customer.
Customer Primary Telephone Number	primaryTelNumber	string	Primary telephone number of the customer.
Telephone Numbers	telNumbers	array of TelNumber	List of additional telephone numbers of the Customer.
Customer UPN	UPN	string	UPN of the customer.
Customer IM Address	imAddress	string	IM Address of the customer.
Customer Email	email	string	Email of the customer.
Custom Fields	customFields	array of CustomField	List of custom fields of the customer.

TelNumber

Name	Path	Type	Description
Name	name	string	Designation of the telephone number.
Value	value	string	Value of the telephone number.

CustomField

Name	Path	Type	Description
Name	name	string	Designation of the custom field.
Value	value	string	Value of the custom field.

CustomContextParameter

Name	Path	Type	Description
Name	name	string	Name of the custom context parameter.
Value	value	string	Value of the custom context parameter.

PreferredUser

Name	Path	Type	Description
UPN	upn	string	The UPN of the preferred user.
Priority	priority	integer	The priority. 1 high to 99 low.

ContactReadDto

Name	Path	Type	Description
Contact External ID	externalId	string	ID of the contact given by the external system.
Contact First Name	firstName	string	First name of the contact.
Contact Last Name	lastName	string	Last name of the contact.
Contact Display Name	displayName	string	Display name of the contact.
Contact Initials	initials	string	Initials of the contact.
Contact Company	company	string	Company of the contact.
Contact Department	department	string	Department of the contact.
Contact Job Title	jobTitle	string	Job title of the contact.
Contact User Principal Name	userPrincipalName	string	User principal name of the contact.
Contact IM Addresses	imAddresses	array of string	List of IM addresses.
Contact Email Addresses	emailAddresses	array of string	List of email addresses.
Contact Business Phones	businessPhones	array of string	List of business phones.
Contact Mobile Phones	mobilePhones	array of string	List of mobile phones.
Contact Home Phones	homePhones	array of string	List of home phones.
addresses	addresses	array of Address	List of addresses.
customFields	customFields	array of CustomField	List of custom fields of the contact.

Address

Name	Path	Type	Description
Address Street	street	string	Street and number of the address.
Address City	city	string	City of the address.
Address Country	country	string	Country of the address.
Address State	state	string	State of the address.
Address Postcode	postalCode	string	Postcode of the address.

SchedulerEntryEventData

Name	Path	Type	Description
Scheduler Entry ID	schedulerEntryId	string	The Nimbus specific ID of the scheduler entry.
Event	event	string	The event which occurred within Nimbus for the scheduled task.
Direction	direction	string	Direction of the task in progress in Nimbus (Inbound/Outbound/None).
Modality	modality	string	Initial modality of the task in Nimbus.
Reference ID	ReferenceId	string	The ID for reference passed by the third-party system.
Unified Conversation ID	unifiedConversationId	string	Unified Conversation ID.
Completion Reason	completionReason	string	Outcome of the scheduler entry when terminated.
Destination	destination	string	Destination of the scheduler entries with direction "Outbound".
Distribution Priority	distributionPriority	string	Priority with which the task should be handled in Nimbus.
Due Date Time (UTC)	dueDateTimeUtc	date-time	Due date and time in UTC: Example: '2020-03-23T11:00:00Z'.
Service UPN	serviceUpn	string	UPN of the service for which the entry is scheduled.
Maximum Attempts	maxAttempts	integer	Maximum Attempts to reach the Destination.
Attempt Timeout in Seconds	attemptTimeoutInSeconds	integer	Defines how long Nimbus tries to reach the Destination before the attempt will be stopped.
Maximum Queue Time in Seconds	maxQueueTimeInSeconds	integer	Defines how long Nimbus tries to solve the task until the task is considered �Limit Reached�.
RONA Timeout in Seconds	ronaTimeoutInSeconds	integer	Defines how long Nimbus tries to reach the user until the task is considered RONA and a new user will be looked for.
Custom Context Parameters	customCallContextParameters	array of CustomContextParameter	List of custom context parameter (Key-Value).
customer	customer	Customer	Object containing all information of the customer.

ExternalTaskWriteResult

Name	Path	Type	Description
External Task ID	id	string	The ID of the added external task.
Modality	modality	Modality	The modality of the task.
Created	created	string	Timestamp, when the external task has been created.
Type	type	string	The type of the external task.
Is Anonymous	isAnonymous	boolean	Flag set to true, when caller is anonymous.
Service ID	serviceId	string	Internal ID of the Nimbus service.
Service Name	serviceName	string	Name of the Nimbus service.
Service Description	serviceDescription	string	Description of the Nimbus service (inherited from Microsoft Teams).
Service Display Name	serviceDisplayName	string	The display name of the service.
Service UPN	serviceUPN	string	The UPN of the service.
Service Tel Number	serviceTelNumber	string	The telephone number of the service.
Preferred Users	preferredUsers	array of PreferredUser	List of preferred users for the tasks (UPN-Priority).

Modality

The modality of the task.

The modality of the task.

Modality

string