Who can use this feature?
All users
Qwil Messenger enables users to interact with our app user interface to integrate and automate the use of the channel via URL deep links.
Essentially, a user can navigate to a specific part or function of the app via a properly constructed URL. Currently, we support the following deep link URL actions for Qwil users:
- Start a new chat
- Navigate to an existing chat, or message within a specific chat.
- Export a PDF transcript of a chat.
- Export chat attachments.
Note: This is a web-only feature.
Security and Usage Considerations:
To use a deep link successfully, the following considerations apply.
- The browser session launched using the URL shortcut is responsible for managing the authentication and permission level access of the user to perform the actions associated with the URL deep link.
- If a user has remembered their credentials via a browser cookie, the user following a deep link will not have to enter any security credentials and the action of the URL link will be performed seamlessly when the link is followed from another application.
- If authentication is required, the link will still work after the details have been entered.
- If a user has authentication access to the app but not the permission levels required to follow the link, then an error in the application itself will be displayed to the user that attempts to follow the link.
How to start a new chat with deep links:
Specific parameters can be used to construct a deep link to start a new chat. New chats must have at least one participant. Optionally, they can have additional participants, a specific chat title and a first message to be automatically sent.
Here is a list of the parameters that can be used to construct a deep link to start a new chat:
To start a new chat, a URL needs to be constructed that complies with the following parameters and formatting conventions:
https://web.qwil.io/web/organisations/[ORGANISATION_UUID]/u/0/chats/create? [IDENTIFIERS(n)=value]&[TITLE=value]&[MESSAGE=value]
Example 1
Create a new chat with Beatrice Wilhelm whose external identifier is C-289878 as a participant.
https://web.qwil.io/web/organisations/00360470-ef19-40e2-be01- c058293dc29b/u/0/chats/create?identifiers[0]=C-289878
Example 2
Create a new chat with Beatrice Wilhelm and whose external identifier is C-289878 as well as Raj Patel whose external identifier is C-289881 as participants.
https://web.qwil.io/web/organisations/00360470-ef19-40e2-be01- c058293dc29b/u/0/chats/create?identifiers[0]=C-289878&identifiers[1]=C-289881
Example 3
Create the same chat as above in example 2 but add a bespoke title of “Qwil Demo”.
https://web.qwil.io/web/organisations/00360470-ef19-40e2-be01- c058293dc29b/u/0/chats/create?identifiers[0]=C-289878&identifiers[1]=C289881&title=Qwil Demo
Example 4
Create the same chat as above in example 3 but add automatically send message text “Hi There”.
https://web.qwil.io/web/organisations/00360470-ef19-40e2-be01- c058293dc29b/u/0/chats/create?identifiers[0]=C-289878&identifiers[1]=C289881&title=Qwil Demo&message=Hi There
How to Export from a chat with deep links:
The two parameters required to export chat attachments and PDF transcript are:
- [ORGANISATION_UUID] - The unique UUID specific to the Qwil organisation within which the chat exists. Can be found in the URL once logged into the Qwil organisation on web.
- [CHAT] - The unique UUID specific to the chat, can be found in the URL after "Chats/"
To export a chat PDF, a URL needs to be constructed that complies with the following parameters and formatting conventions:
https://web.qwil.io/web/organisations/[ORGANISATION_UUID]/0/chats/[CHAT]/pdf
And to export chat attachments:
https://web.qwil.io/web/organisations/[ORGANISATION_UUID]/0/chats/[CHAT]/zip
Example 1
Download a chat transcript with Beatrice Wilhelm, with chat uuid: 00420cfc-0ab6-4dbc-98ed-7cc98e827059,
https://web.qwil.io/web/organisations/00360470-ef19-40e2-be01- c058293dc29b/0/chats/00420cfc-0ab6-4dbc-98ed-7cc98e827059/pdf
Example 2
Export chat transcripts for the same chat with Beatrice Wilhelm:
https://web.qwil.io/web/organisations/00360470-ef19-40e2-be01- c058293dc29b/0/chats/00420cfc-0ab6-4dbc-98ed-7cc98e827059/zip