How do I send text messages via GOV.UK Notify?

As a local authority, you are able to use the GOV.UK Notify service to send text messages. This document outlines the configuration settings for the integration of SMS (short message service) between the My Council Services platform, and the GOV.UK Notify service.

This uses the standard Notify APIs, and the MCS Enterprise Service Bus (ESB) functionality to achieve integration. At present, the integration does not support multiple GOV.UK Notify service accounts.

for more information see https://www.notifications.service.gov.uk 

I. GOV.UK Notify - Account Details

You will need to set up a relevant account with your GOV.UK Notify service, and log in to the system. Once signed up and logged in to the service for your Organisation, you will need to configure the following:

01. Template

You will need to generate a Template for the integration, which will be used to send the SMS message. You will need just one Template for your system.

From the main log-on screen, select “Templates”, and then “Add New Template”. Select “Text”, and then enter details are required.

You can personalise this message how you wish, as all options are available on this page.  You will need to include in the template the personalisation tag ((content)) in the Message to populate the Content from the SMS template.  Any text sent as part of an SMS from the MCS platform will be present in the body of the message when sent. 

Once “Saved”, copy the template ID to your clipboard, as this will be required further on.

02. Generate an API key.

You will need to generate an API key for the integration. You will need just one API key for your system.

From the log-in screen, click on “API Integration”. Select “API Keys”, and then “Create an API Key”.

Enter an API Key, and choose its Type. Select “Copy API Key to clipboard”, as this will be required further on.

II. SMS Account Settings

You will need to configure an SMS account in your system in order to send SMS messages to the GOV.UK Notify service.

Go to Administration -> Mail -> Accounts -> SMS

Select “GOV.UK Notify” for your SMS service, and enter both the API Key and the Template ID from the previous steps.

III. Testing SMS Service

To test the service from MCS, go into Service Desk. Select a relevant Service Request to test, and select “Send -> SMS” on the right.

From here, enter the SMS content as required.

The SMS will be sent to the number specified, and will appear with the GOV.UK Notify service name, with the content of the SMS.