# VoiceSage Task Templates This feature is available from Keyfax version 4.4.7+ and requires a subscription to VoiceSage and be configured in the XML configuration file within your Keyfax installation. Please contact Omfax Support for details on how to achieve this. VoiceSage Tasks allows Keyfax to send Voicesage SMS and Rich Media Messages (RMMs) at any point during a Keyfax script. RMMs are enhanced SMS messages that allow you to send richer content like images, videos and links direct to user's mobile devices. ### VoiceSage Base Task Template Selecting 'VoiceSage RMM' from the Base Task Template list described [here](https://docs.keyfax.biz/product-suite/admin/advanced/base-task-templates), will display a template to capture all the required details for a new task template:

### Properties **Description** – describing the Task's role/purpose **To** – recipient phone number **RMM Template Id** - the ID of the RMM template from within VoiceSage **SMS Template Id** - the ID of the SMS template from within VoiceSage Bookmarks (Databoxes), including Expressions can be used/added to the RMM, SMS and To fields. {% hint style="info" %} **TIP** To add Databoxes to the template fields you will need to **drag and drop** from the Bookmark Selection menu into the field. {% endhint %} ### Mappings Mappings can be applied to map VoiceSage fields to Keyfax Bookmarks (Databoxes). Fields that are added to the Keyfax Task Template but not used in the VoiceSage SMS or RMM will be ignored.

**VoiceSage Custom Field Name** - the name of the Custom Field from within VoiceSage **Custom Field Value** - the corresponding Keyfax Bookmark (Databox) that will be mapped to, from VoiceSage, to be used within the Task The example below shows the Custom Field names of "**KeyfaxTenantName**" and "**RepairDetails**" being used within the VoiceSage SMS.

To create a new Custom Field in VoiceSage you must be logged in as the [VoiceSage API user](#voicesage-api-permissions). 1. Click "**SETTINGS**" and select "**Account Settings"** 2. Select "**Custom Fields**" 3. Select "**ADD CUSTOM FIELD**".

Enter the Custom Field name to be created and click "**SAVE**". The field will now be available to use within the VoiceSage template(s).

### Creating a new Task Template Create a new Task and select the Base Template required. Enter the ID of the VoiceSage RMM Template and SMS Template is the corresponding fields as highlighted below. {% hint style="info" %} **NOTE:** Enter a zero in the RMM ID field if you only need to send an SMS. {% endhint %}

RMM and SMS Template ID's are obtained from the VoiceSage interface

Add the corresponding Keyfax Bookmarks/Databoxes as required.

Add the Task to the required step in the script.

Upon completion of the script and selecting "Process tasks", a preview of the task is presented. As we can see the two Custom Fields have been updated with the name and recorded text from Keyfax. Clicking "Send RMM" will add the SMS to the [Communications Queue](/product-suite/admin/advanced/communications-queues.md) to be sent.

The resulting SMS message will be sent to the recipients mobile with a link to the RMM (if included):

Clicking on the link within the SMS will display the RMM:

### How to configure VoiceSage * The customer should confirm which Keyfax environment(s) will be used to test the VoiceSage integration. * The customer should confirm which Keyfax environment(s) will be used to develop & test Keyfax Scripts to include the necessary VoiceSage tasks. If this will be completed outside of Live (for example within a Dev, Test or UAT environment) then Live scripts should be first copied into the desired environment and a change freeze should be imposed in Live whilst changes are being developed within the desired environment. Upon a successful UAT phase the database containing the latest script developments would be copied back into Live upon an agreed date and the change freeze in Live lifted. * After successful testing other lower environments should be updated with the latest database containing the latest script developments (for example updating Dev or Test if changes are applied directly into UAT) * The customer will need to supply a VoiceSage API Key and Sender ID. An example of this is shown below\... ``` ``` ### **VoiceSage API Permissions** If you wish to use a VoiceSage template, it MUST be created when logged in as the VoiceSage API user or shared with the VoiceSage user who has the VoiceSage API permissions. The customer will need to talk to VoiceSage themselves to find out who the API user is. All templates which are to be used / sent will have to be shared with this API user first via the VoiceSage dashboard before they can be used / sent. Please contact [Omfax Support](/links/support.md) for assistance. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.keyfax.biz/product-suite/admin/advanced/base-task-templates/voicesage-task-templates.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.