APIs are great interfaces to integrate different applications. An API exposes the functionality and features to the external applications. Luma provides an inbound API that allows external applications to interact with Luma, which can be used for scenarios such as notifying the bot users after completion of a service or request.
...
| Name | Value | Endpoint Example |
|---|---|---|
| Default URL | {{ENDPOINT}}/public/notifylumauser/message | https://lumastaging.serviceaide.com/vsa https://luma2.serviceaide.com/vsa https://luma3.serviceaide.com/vsa |
...
- Contacts: Include the login ID of the users to whom the inbound message needs to be sent. You can send the message to multiple recipients by separating the login IDs using comma (for example, sam@gmail.com, judy@gmail.com).
- Roles: Include the role code of the users to whom the inbound message needs to be sent. The following user roles and their respective codes are available:
- 0 - 1 (to be used to send the message to all the Luma users)1 (to be used to send the message to Administrator)
- 2 - 2 (to be used to send the message to Developer)
- 3 - 3 (to be used to send the message to Analyst)
- 4 - 4 (to be used to send the message to Self-service user)5
- 5 (to be used to send the message to Guest user)
Info title Note To send message to all the Luma users, include "0'' in the contacts and leave the roles blank.
- Template ID: Include the template ID which needs to be used while sending the message to the users. To know the template ID in the Skills Builder, on the Settings page, click Notification Templates tab. Search for the notification template ID from the list and include it.
- Response Type: Specify the response type to be sent to the users - text, image or card.
- Message: Include the message which needs to be sent to the users. If a variable message is used in the Skills Builder notification template, the message included in the REST API is displayed in the user's chat window. Similarly, if the message is provided in the Skills Builder notification template, then it overrides any message details included in the REST API, and displays the Skills Builder message to the users.
...