Luware Knowledge

Nimbus Portal Nimbus Admin Release Notes Service Status
Home Nimbus Use Cases Administration Use Cases

Use Case - Chaining of Assistant Requests

Create and assign a service call template in order to handle customer calls via PSTN to a service or an agent directly.

In this use case, we handle customer calls via PSTN to a service or an agent directly. As a first step Assistant can request information from a CRM-API based on the caller's identification. This would then return the dossier ID of that identified customer. In the subsequent request Assistant can use the response and open up the default browser to immediately show the valuable formation to the agent.

In this Use Case we're going to tackle the following:

  • Grab additional information from a CRM-System.
  • Use the response in a follow-up request to be shown in the default browser.

PRECONDITIONS

You require tenant administrator rights to to create, update and delete Assistant Service Call Templates.

  • Enterprise Routing Contact Center Enterprise Routing or Contact Center licensed services may make use of service call templates.
  • Service Call Templates are configured and assigned to the service itself via Extension Service Settings. → Details will be explained in step 1 below.
 

Show Icon Legend

💡 = A hint to signal learnings, improvements or useful information in context. 🔍 = Info points out essential notes or related page in context.
☝ = Notifies you about fallacies and tricky parts that help avoid problems. 🤔 = Asks and answers common questions and troubleshooting points.
❌ = Warns you of actions with irreversible / data-destructive consequence. ✅ = Intructs you to perform a certain (prerequired) action to complete a related step.
 
 

Creation of a Service Call Template

  1. Login as Admin to the Nimbus backend.
  2. Go to Configuration > Nimbus Assistant > Service Call Templates
  3. Create a new Template.   
  4. Fill out all the required fields like Name and Organization Unit, where this Template will be available (💡 should be placed on the same OU as your service or higher level).
  5. Choose the Trigger event upon which the action should get triggered (On Ringing / On Accepted)
  6. Additionally toggle the desired Origins (e.g. PSTN  / External teams calls)
  7. Click the "Create" button to generate the new template.

Creation of Actions

✅ After the creation of the template the actions inside need to be created too. These are the "steps" that are executed in order once your template is triggered.

  1. Open your newly created template.
  2. Locate the "Actions" area. Click Create and select a Web Request as Trigger 
  3. In the tabs, fill out details as follows:
Tab
 Tasks

General

  1. Fill out the required fields
  2. Choose the required HTTP Method (GET)

Headers

  • Optional
  • You can define key value pairs to pass along in the header. This depends on your CRM's API.  
    💡 You can pass along Nimbus Custom Parameters and System Fields.

Authorization

  • Optional
  • Depends on your CRM and which credentials are needed,

 

Response

  • Make to enable "Wait for response".  
    ☝ Otherwise the response may be empty and the next step fails.

 

4. ✅ Copy the Trigger-ID from the General tab to your clipboard. You will be needing it for next step. 
5. Generate another Web Request Action. (same as Step 2 above). 
6. This time, select "Open in default browser" → The view changes as follows: 

  1. The base URL of your CRM needs to be provided
  2. Combine the URL with the Trigger-ID copied earlier.  
    💡 By doing so we can link to the response of the preceding request
  3. Wrap the URL request parameter with curled brackets {{<Trigger ID>.body.dossierID}}  
    💡 This is an internal format, which is required in order to properly parse it and retrieve the value of the preceding request

Example:

https://internal-crm-url.com/{{8a1a467e-c4ba-44e9-b4f0-5b8fe3a3b236.body.dossierId}}

 

7. Click Save & Apply.

Assigning the template to a service

  1. Go to the Service Settings of the service where the template shall be used.
  2. Go to Extensions tab > Assistant section.
  3. Select your template and assign it as a Service Call Template.  
  4. Click Save & Apply. → During the next service call, the template will now trigger its defined actions.

🔍 Related to these steps above, you can also create Direct Call Templates and assign them to users via their Assistant User Settings. → See Use Case - Setting up Assistant.

Tips and Troubleshooting

Tip Description
Things to keep in mind
  • {{622df4fc-fcf8-423b-b8b8-f0d3ea8f567.body}} - can always be used no matter what response content type is provided
  • Anything within the body can only be parsed when it's a proper JSON (e.g. {{622df4fc-fcf8-423b-b8b8-f0d3ea8f567e.body.data.status}} 

☝ Depending on the API some adjustment of the wait-duration should be considered. If the timer elapses before receiving a response, the parsing will not be successful

 
Simple JSON Example

Example response from a request with the Trigger-ID (e.g. 622df4fc-fcf8-423b-b8b8-f0d3ea8f567e):

   JSON 
							    { "meta": null,
								 "data": {
								   "id": 25,
								   "name": "Max Muster",
								   "email": "max.muster@muster-ag.com",
								   "gender": "male",
								   "status": "inactive"
							   }
							}

Accessing the property status can be achieved in the following way

CODE
									{{622df4fc-fcf8-423b-b8b8-f0d3ea8f567e.body.data.status}}
Array JSON

Example response from a request with the Trigger-ID (e.g. 622df4fc-fcf8-423b-b8b8-f0d3ea8f567e) :

JSON
							[{  "meta": null,
							   "data": {
								   "id": 25,
								   "name": "Max Muster1",
								   "email": "max.muster1@muster-ag.com",
								   "gender": "male",
								   "status": "inactive"
							   }
							}, 
							{   "meta": null,
							   "data": {
								   "id": 26,
								   "name": "Max Muster2",
								   "email": "max.muster2@muster-ag.com",
								   "gender": "male",
								   "status": "inactive"
							   }
							}]

Accessing the property status of the first array can be achieved in the following way

CODE
									{{622df4fc-fcf8-423b-b8b8-f0d3ea8f567e.body[0].data.status}}
Use Case - Enabling Additional Authorization for Interact

In this use case, we're going to describe how you can set up an access token to b...

Use Case - Exposing an API via Microsoft Entra ID

In this use case, we handle the scenario where you want to communicate with Assis...

Use Case - Setting Up Assistant

PRECONDITIONS You require tenant administrator rights to create and update tenant...

Use Case - Setting Up Instant Messaging

In this use case, we're going to tackle the following topics: Necessary Administr...

Table of Contents