IMIconnect Developer Hub

Welcome to the IMIconnect developer hub. You'll find all the resources to help you get started with IMIconnect quickly. We are here to support you if you get stuck. Let's jump right in!

Get Started

Voice: Call URL

This node is used to call an external application by passing contextual information to fetch specific data as response. You can define the URL wait time for response after which the flow/call may end. It supports input validation such as allowed values, if a value outside the allowed set is received as a response, user can branch out the flow to handle exceptions.

For example, you can call a CRM application to get the profile information of a customer and validate the customer based on the response from CRM data.

The number of exit events available and the appearance will depend on the configuration options for this node.

The options of call URL are:

Node Options
Description

CALL URL SETTINGS

This option is be used to configure a URL in this node.

TIMER SETTINGS

Timer options helps you configure the time-out upon which the control is passed to the selected node.

NODE EVENTS

Node options helps you configure the events that you want to trigger on this node.

CALL URL SETTINGS


The call URL settings screen allows you to configure a URL in this node.

Parameter
Description

Jingle File

Select the file to be played during the voice flow. To select a file, follow these steps:

  1. Click the Settings icon.

  2. Select User Assets.

  3. Select language as Static and en from the drop-down.

  4. Locate the voice file that was uploaded and select the radio button of the voice file.

  5. To close this screen, click x available on the top right corner.

You will notice the voice file is configured in the Jingle File field.

URL

This option helps you to play the music from a URL. To enter a URL, follow these steps:

  1. Select the static variable from the drop-down.

  2. Enter the URL in the text field.

  3. Enter Response Code.

  4. Enter Voice Tag.

  5. Click + icon to add additional fields.

TIMER SETTINGS


The timer settings screen allows you to configure the time-out upon which the control is passed to the selected node.

Type
Description

call

This option helps you terminate the flow from this node. To enter the time in seconds, follow these steps:

  1. Select call from the Type drop-down.

  2. Select static variable from the Value (in secs) drop-down.

  3. Enter the value in seconds.

  4. Click + icon to add other fields.

menu

This option helps you terminate a menu after the specified seconds. To enter time in seconds, follow these steps:

  1. Select menu from the Type drop-down.

  2. Select static variable from the Value (in secs) drop-down.

  3. Enter the value in seconds.

NODE EVENTS


The node events screen allows you to configure the events that you want to trigger on this node.

Event Name
Description

onhttperror

This event is triggered if an error occurs.

oninvalidchoice

This event is triggered if an invalid choice is made (an undefined choice).

Properties / Params configuration

Properties

Property
Description

Label

The name of the node represented as a string.
A node can be renamed by changing the contents of the Label field.

Params

Parameter
Description

The Session Data shortcut leads to the Session Data / Custom Logs configuration.

Session Data can set one or more Session Params upon entering or leaving the node.

Custom Logs can record one or more Session Params upon entering or leaving the node. This is useful for debugging purposes.

Voice: Call URL


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.