.NET client documentation

This documentation is for developers interested in using the GOV.UK Notify .NET client to send emails (including documents), text messages or letters. GOV.UK Notify supports .NET framework 4.6.2 and .NET Core 2.0.

We recommend that you use this client library rather than use the GOV.UK Notify API directly, as there is no documentation for using the API in this way.

Set up the client

Prerequisites

This documentation assumes you are using Microsoft Visual Studio [external link] with the NuGet Package Manager [external link].

Refer to the client changelog for the version number and the latest updates.

Install the client

The GOV.UK Notify client deploys to Bintray [external link].

You can install the GOV.UK Notify client package using either the command line or Microsoft Visual Studio.

! Warning The latest version (2.5.0) does not work properly unless your code is asynchronous. Until this problem is fixed you should install the previous version (2.4.0).

Use the command line

Go to your project directory and run the following in the command line to install the client package:

nuget sources Add -Name NotifyBintray -Source https://api.bintray.com/nuget/gov-uk-notify/nuget
nuget install Notify

Use Microsoft Visual Studio

Use the NuGet Package Manager [external link] to install the notifications-net-client client package in Visual Studio.

You can use either the console [external link] or the UI [external link].

Console

Run the following in the NuGet package manager console to install the client package:

nuget install Notify -Source https://api.bintray.com/nuget/gov-uk-notify/nuget

UI

Add the https://api.bintray.com/nuget/gov-uk-notify/nuget package source to your project.
Use the Package Manager UI to search for and install the client package [external link].

Create a new instance of the client

Add this code to your application:

using Notify.Client;
using Notify.Models;
using Notify.Models.Responses;

var client = new NotificationClient(apiKey);

To get an API key, sign in to GOV.UK Notify and go to the API integration page. Refer to the API keys section of this documentation for more information.

If you use a proxy, you must set the proxy configuration in the web.config file. Refer to the Microsoft documentation on proxy configuration for more information.

using Notify.Client;
using Notify.Models;
using Notify.Models.Responses;
using System.Net.Http;

var httpClientWithProxy = new HttpClientWrapper(new HttpClient(...));
var client = new NotificationClient(httpClientWithProxy, apiKey);

Send a message

You can use GOV.UK Notify to send text messages, emails and letters.

Send a text message

Method

SmsNotificationResponse response = client.SendSms(
  mobileNumber: "+447900900123",
  templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a",
  );

Arguments

mobileNumber (required)

The phone number of the recipient of the text message. This can be a UK or international number.

string mobileNumber: "+447900900123";

templateId (required)

Sign in to GOV.UK Notify and go to the Templates page to find the template ID.

string templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a";

personalisation (optional)

If a template has placeholder fields for personalised information such as name or reference number, you need to provide their values in a Dictionary. For example:

Dictionary<String, dynamic> personalisation = new Dictionary<String, dynamic>
{
    {"first_name", "Amala"},
    {"application_date", "2018-01-01"}
};

You can leave out this argument if a template does not have any placeholder fields for personalised information.

reference (optional)

A unique identifier you can create if you need to. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. For example:

string reference: "STRING";

You can leave out this argument if you do not have a reference.

smsSenderId (optional)

A unique identifier of the sender of the text message notification. You can find this information in the Text Message sender settings.

Sign in to your GOV.UK Notify account.
Go to Settings.
If you need to change to another service, select Switch service in the top right corner of the screen and select the correct one.
Go to the Text Messages section and select Manage on the Text Message sender row.

You can then either:

copy the sender ID that you want to use and paste it into the method
select Change to change the default sender that the service uses, and select Save

For example:

string smsSenderId: "8e222534-7f05-4972-86e3-17c5d9f894e2";

You can leave out this argument if your service only has one text message sender, or if you want to use the default sender.

Response

If the request to the client is successful, the client returns an SmsNotificationResponse:

public String id;
public String reference;
public String uri;
public Template template;
public SmsResponseContent;

public class Template {
    public String id;
    public String uri;
    public Int32 version;
}
public class SmsResponseContent{
    public string body;
    public string fromNumber;
}

If you use the test API key, all your messages come back with a delivered status.

All messages sent using the team and whitelist or live keys appear on your dashboard.

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code.

error.code	error.message	How to fix
`400`	`[{` `"error": "BadRequestError",` `"message": "Can't send to this recipient using a team-only API key"` `]}`	Use the correct type of API key
`400`	`[{` `"error": "BadRequestError",` `"message": "Can't send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"` `}]`	Your service cannot send this notification in trial mode
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information
`429`	`[{` `"error": "RateLimitError",` `"message": "Exceeded rate limit for key type TEAM/TEST/LIVE of 3000 requests per 60 seconds"` `}]`	Refer to API rate limits for more information
`429`	`[{` `"error": "TooManyRequestsError",` `"message": "Exceeded send limits (LIMIT NUMBER) for today"` `}]`	Refer to service limits for the limit number
`500`	`[{` `"error": "Exception",` `"message": "Internal server error"` `}]`	Notify was unable to process the request, resend your notification

Send an email

Method

EmailNotificationResponse response = client.SendEmail(emailAddress, templateId, personalisation, reference, emailReplyToId);

client.SendEmail(
    emailAddress: "sender@something.com",
    templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a"
);

Arguments

emailAddress (required)

The email address of the recipient. For example:

string emailAddress: "sender@something.com";

templateId (required)

Sign in to GOV.UK Notify and go to the Templates page to find the template ID. For example:

string templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a";

personalisation (optional)

If a template has placeholder fields for personalised information such as name or reference number, you need to provide their values in a Dictionary. For example:

Dictionary<String, dynamic> personalisation: new Dictionary<String, dynamic>
{
    { "first_name", "Amala"
      "application_date", "2018-01-01"
    }
};

You can leave out this argument if a template does not have any placeholder fields for personalised information.

reference (optional)

A unique identifier you can create if you need to. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. For example:

string reference: "STRING";

You can leave out this argument if you do not have a reference.

emailReplyToId (optional)

This is an email reply-to address you can set to receive replies from your users. Your service cannot go live until you set up at least one of these email addresses.

Sign in to your GOV.UK Notify account.
Go to Settings.
If you need to change to another service, select Switch service in the top right corner of the screen and select the correct one.
Go to the Email section and select Manage on the Email reply to addresses row.
Select Change to specify the email address to receive replies, and select Save.

For example:

string emailReplyToId: "8e222534-7f05-4972-86e3-17c5d9f894e2";

You can leave out this argument if your service only has one email reply-to address, or you want to use the default email address.

Response

If the request to the client is successful, the client returns an EmailNotificationResponse:

public String id;
public String reference;
public String uri;
public Template template;
public EmailResponseContent content;

public class Template{
    public String id;
    public String uri;
    public Int32 version;
}
public class EmailResponseContent{
  public String fromEmail;
  public String body;
  public String subject;
}

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code.

error.status_code	error.message	How to fix
`400`	`[{` `"error": "BadRequestError",` `"message": "Can't send to this recipient using a team-only API key"` `]}`	Use the correct type of API key
`400`	`[{` `"error": "BadRequestError",` `"message": "Can't send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"` `}]`	Your service cannot send this notification in trial mode
`400`	`[{` `"error": "BadRequestError",` `"message": "Unsupported document type '{}'. Supported types are: {}"` `}]`	The attached document must be a PDF file
`400`	`[{` `"error": "BadRequestError",` `"message": "Document didn't pass the virus scan"` `}]`	The attached document must be virus free
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct type of API key
`429`	`[{` `"error": "RateLimitError",` `"message": "Exceeded rate limit for key type TEAM/TEST/LIVE of 3000 requests per 60 seconds"` `}]`	Refer to API rate limits for more information
`429`	`[{` `"error": "TooManyRequestsError",` `"message": "Exceeded send limits (LIMIT NUMBER) for today"` `}]`	Refer to service limits for the limit number
`500`	`[{` `"error": "Exception",` `"message": "Internal server error"` `}]`	Notify was unable to process the request, resend your notification.
N/A	`System.ArgumentException("Document is larger than 2MB")`	Document size was too large, upload a smaller file

Send a file by email

Send files without the need for email attachments.

This is an invitation-only feature. Contact the GOV.UK Notify team to enable this function for your service.

To send a file by email, add a placeholder field to the template and then upload a file. The placeholder field will contain a secure link to download the file.

Add a placeholder field to the template

Sign in to GOV.UK Notify.
Go to the Templates page and select the relevant email template.
Add a placeholder field to the email template using double brackets. For example:

"Download your file at: ((link_to_document))"

Upload the file

The file you upload must be a PDF file smaller than 2MB.

Convert the PDF to a byte[].
Pass the byte[] to the personalisation argument.
Call the sendEmail method.

For example:

byte[] documentContents = File.ReadAllBytes("<document file path>");

Dictionary<String, dynamic> personalisation = new Dictionary<String, dynamic>
{
    { "name", "Foo" },
    { "link_to_document", NotificationClient.PrepareUpload(documentContents)}
};

Error codes

If the request is not successful, the client returns an HTTPError containing the relevant error code.

error.status_code	error.message	How to fix
`400`	`[{` `"error": "BadRequestError",` `"message": "Can't send to this recipient using a team-only API key"` `]}`	Use the correct type of API key
`400`	`[{` `"error": "BadRequestError",` `"message": "Can't send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"` `}]`	Your service cannot send this notification in trial mode
`400`	`[{` `"error": "BadRequestError",` `"message": "Unsupported document type '{}'. Supported types are: {}"` `}]`	The document you upload must be a PDF file
`400`	`[{` `"error": "BadRequestError",` `"message": "Document didn't pass the virus scan"` `}]`	The document you upload must be virus free
`400`	`[{` `"error": "BadRequestError",` `"message": "Service is not allowed to send documents"` `}]`	Contact the GOV.UK Notify team
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct type of API key
`429`	`[{` `"error": "RateLimitError",` `"message": "Exceeded rate limit for key type TEAM/TEST/LIVE of 3000 requests per 60 seconds"` `}]`	Refer to API rate limits for more information
`429`	`[{` `"error": "TooManyRequestsError",` `"message": "Exceeded send limits (LIMIT NUMBER) for today"` `}]`	Refer to service limits for the limit number
`500`	`[{` `"error": "Exception",` `"message": "Internal server error"` `}]`	Notify was unable to process the request, resend your notification.
`N\A`	`Document is larger than 2MB`	Document size was too large, upload a smaller file

Send a letter

When your service first signs up to GOV.UK Notify, you’ll start in trial mode. You can only send letters in live mode. You must ask GOV.UK Notify to make your service live.

Sign in to GOV.UK Notify.
Select Using Notify.
Select Requesting to go live.

Method

Dictionary<String, dynamic> personalisation = new Dictionary<String, dynamic>
{
    { "address_line_1", "The Occupier" },  # required
    { "address_line_2", "123 High Street" }, # required
    { "address_line_3", "London" },
    { "postcode", "SW14 6BF" } # required
      ... # any other optional address lines, or personalisation fields found in your template
};

LetterNotificationResponse response = client.SendLetter(templateId, personalisation, reference);

Arguments

templateId (required)

Sign in to GOV.UK Notify and go to the Templates page to find the template ID. For example:

string templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a";

personalisation (required)

The personalisation argument always contains the following required parameters for the letter recipient's address:

address_line_1
address_line_2
postcode

Any other placeholder fields included in the letter template also count as required parameters. You need to provide their values in a Dictionary. For example:

personalisation: {
  "address_line_1": "The Occupier",
  "address_line_2": "123 High Street",
  "postcode": "SW14 6BF",
  "name": "John Smith",
  "application_id": "4134325"
}

reference (optional)

A unique identifier you can create if you need to. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. For example:

string reference: "STRING";

You can leave out this argument if you do not have a reference.

personalisation (optional)

The following parameters in the letter recipient's address are optional:

Dictionary<String, dynamic> personalisation: new Dictionary<String, dynamic>
{
{ "address_line_3", "The Ridings" }
{ "address_line_4", "23 Foo Road" },
{ "address_line_5", "Bar Town" },
{ "address_line_6", "London" },
};

Response

If the request to the client is successful, the client returns a LetterNotificationResponse:

public String id;
public String reference;
public String uri;
public Template template;
public string postage;
public LetterResponseContent content;

public class Template
{
    public String id;
    public String uri;
    public Int32 version;
}
public class LetterResponseContent{
    public string body;
    public string subject;
}

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code.

error.code	error.message	How to fix
`400`	`[{` `"error": "BadRequestError",` `"message": "Cannot send letters with a team api key"` `]}`	Use the correct type of API key
`400`	`[{` `"error": "BadRequestError",` `"message": "Cannot send letters when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"` `}]`	Your service cannot send this notification in trial mode
`400`	`[{` `"error": "ValidationError",` `"message": "personalisation address_line_1 is a required property"` `}]`	Ensure that your template has a field for the first line of the address, refer to personalisation for more information
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information
`429`	`[{` `"error": "RateLimitError",` `"message": "Exceeded rate limit for key type TEAM/TEST/LIVE of 3000 requests per 60 seconds"` `}]`	Refer to API rate limits for more information
`429`	`[{` `"error": "TooManyRequestsError",` `"message": "Exceeded send limits (LIMIT NUMBER) for today"` `}]`	Refer to service limits for the limit number
`500`	`[{` `"error": "Exception",` `"message": "Internal server error"` `}]`	Notify was unable to process the request, resend your notification

Send a precompiled letter

Method

LetterNotificationsResponse response = client.SendPrecompiledLetter(
    clientReference,
    pdfContents,
    postage
    );

Arguments

clientReference (required)

A unique identifier you create. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address.

pdfContents (required for the SendPrecompiledLetter method)

The precompiled letter must be a PDF file which meets the GOV.UK Notify PDF letter specification. The method sends the contents of the file to GOV.UK Notify.

byte[] pdfContents = File.ReadAllBytes("<PDF file path>");

postage (optional)

You can choose first or second class postage for your precompiled letter. Set the value to first for first class, or second for second class. If you do not pass in this argument, the postage will default to second class.

Response

If the request to the client is successful, the client returns a LetterNotificationResponse with the id, reference and postage:

public String id;
public String reference;
public String postage;
public String uri;  // null for this response
public Template template;  // null for this response
public LetterResponseContent content;  // null for this response

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException containing the relevant error code:

httpResult	Message	How to fix
`400`	`[{` `"error": "BadRequestError",` `"message": "Cannot send letters with a team api key"` `]}`	Use the correct type of API key
`400`	`[{` `"error": "BadRequestError",` `"message": "Cannot send letters when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"` `}]`	Your service cannot send this notification in trial mode
`400`	`[{` `"error": "ValidationError",` `"message": "personalisation address_line_1 is a required property"` `}]`	Send a valid PDF file
`400`	`[{` `"error": "ValidationError",` `"message": "reference is a required property"` `}]`	Add a `reference` argument to the method call
`400`	`[{` `"error": "ValidationError",` `"message": "postage invalid. It must be either first or second."` `}]`	Change the value of `postage` argument in the method call to either 'first' or 'second'
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information
`429`	`[{` `"error": "RateLimitError",` `"message": "Exceeded rate limit for key type TEAM/TEST/LIVE of 3000 requests per 60 seconds"` `}]`	Refer to API rate limits for more information
`429`	`[{` `"error": "TooManyRequestsError",` `"message": "Exceeded send limits (LIMIT NUMBER) for today"` `}]`	Refer to service limits for the limit number
N/A	`"message":"precompiledPDF must be a valid PDF file"`	Send a valid PDF file
N/A	`"message":"reference cannot be null or empty"`	Populate the reference parameter
N/A	`"message":"precompiledPDF cannot be null or empty"`	Send a PDF file with data in it

Get message status

Message status depends on the type of message you have sent.

You can only get the status of messages that are 7 days old or newer.

Status - text and email

Status	Information
Created	GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.
Sending	GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient. GOV.UK Notify is waiting for delivery information.
Delivered	The message was successfully delivered.
Failed	This covers all failure statuses: - `permanent-failure` - "The provider could not deliver the message because the email address or phone number was wrong. You should remove these email addresses or phone numbers from your database. You’ll still be charged for text messages to numbers that do not exist." - `temporary-failure` - "The provider could not deliver the message after trying for 72 hours. This can happen when the recipient's inbox is full or their phone is off. You can try to send the message again. You’ll still be charged for text messages to phones that are not accepting messages." - `technical-failure` - "Your message was not sent because there was a problem between Notify and the provider. You’ll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure."

Status - text only

Status	Information
Pending	GOV.UK Notify is waiting for more delivery information. GOV.UK Notify received a callback from the provider but the recipient's device has not yet responded. Another callback from the provider determines the final status of the notification.
Sent / Sent internationally	The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information. The GOV.UK Notify client API returns this status as `sent`. The GOV.UK Notify client app returns this status as `Sent internationally`.

Status - letter

Status	information
Failed	The only failure status that applies to letters is `technical-failure`. GOV.UK Notify had an unexpected error while sending to our printing provider.
Accepted	GOV.UK Notify has sent the letter to the provider to be printed.
Received	The provider has printed and dispatched the letter.

Status - precompiled letter

Status	information
Pending virus check	GOV.UK Notify has not completed a virus scan of the precompiled letter file.
Virus scan failed	GOV.UK Notify found a potential virus in the precompiled letter file.
Validation failed	Content in the precompiled letter file is outside the printable area. See the GOV.UK Notify PDF letter specification for more information.

Get the status of one message

You can only get the status of messages that are 7 days old or newer.

Method

Notification notification = client.GetNotificationById(notificationId);

Arguments

notificationId (required)

The ID of the notification. You can find the notification ID in the response to the original notification method call.

You can also find it in your GOV.UK Notify Dashboard.

Sign in to GOV.UK Notify and select Dashboard.
Select either emails sent, text messages sent or letters sent.
Select the relevant notification.
Copy the notification ID from the end of the page URL, for example https://www.notifications.service.gov.uk/services/af90d4cb-ae88-4a7c-a197-5c30c7db423b/notification/ID.

Response

If the request to the client is successful, the client returns a Notification.

public String id;
public String completedAt;
public String createdAt;
public String emailAddress;
public String body;
public String subject;
public String line1;
public String line2;
public String line3;
public String line4;
public String line5;
public String line6;
public String phoneNumber;
public String postcode;
public String postage;
public String reference;
public String sentAt;
public String status;
public Template template;
public String type;
public string createdByName;

public class Template
{
    public String id;
    public String uri;
    public Int32 version;
}

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code:

error.status_code	error.message	How to fix
`400`	`[{` `"error": "ValidationError",` `"message": "id is not a valid UUID"` `}]`	Check the notification ID
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information
`404`	`[{` `"error": "NoResultFound",` `"message": "No result found"` `}]`	Check the notification ID

Get the status of multiple messages

This API call returns the status of multiple messages. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the olderThanId argument.

You can only get messages that are 7 days old or newer.

Method

NotificationList notifications = client.GetNotifications(templateType, status, reference, olderThanId);

Arguments

You can leave out these arguments to ignore these filters.

templateType (optional)

You can filter by:

email
sms
letter

status (optional)

status	description	text	email	letter	Precompiled letter
created	GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.	Yes	Yes
sending	GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient. GOV.UK Notify is waiting for delivery information.	Yes	Yes
delivered	The message was successfully delivered	Yes	Yes
sent / sent internationally	The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information.	Yes
pending	GOV.UK Notify is waiting for more delivery information. GOV.UK Notify received a callback from the provider but the recipient's device has not yet responded. Another callback from the provider determines the final status of the notification.	Yes
failed	This returns all failure statuses: - permanent-failure - temporary-failure - technical-failure	Yes	Yes
permanent-failure	The provider could not deliver the message because the email address or phone number was wrong. You should remove these email addresses or phone numbers from your database. You’ll still be charged for text messages to numbers that do not exist.	Yes	Yes
temporary-failure	The provider could not deliver the message after trying for 72 hours. This can happen when the recipient's inbox is full or their phone is off. You can try to send the message again. You’ll still be charged for text messages to phones that are not accepting messages.	Yes	Yes
technical-failure	Email / Text: Your message was not sent because there was a problem between Notify and the provider. You’ll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure. Letter: Notify had an unexpected error while sending to our printing provider. You can leave out this argument to ignore this filter.	Yes	Yes
accepted	GOV.UK Notify has sent the letter to the provider to be printed.			Yes
received	The provider has printed and dispatched the letter.			Yes
pending-virus-check	GOV.UK Notify is scanning the precompiled letter file for viruses.				Yes
virus-scan-failed	GOV.UK Notify found a potential virus in the precompiled letter file.				Yes
validation-failed	Content in the precompiled letter file is outside the printable area.				Yes

reference (optional)

A unique identifier you can create if you need to. This reference identifies a single unique notification or a batch of notifications. It must not contain any personal information such as name or postal address. For example:

string reference = "STRING";

olderThanId (optional)

Input the ID of a notification into this argument to return the next 250 received notifications older than the given ID. For example:

string olderThanId: "e194efd1-c34d-49c9-9915-e4267e01e92e";

If you leave out this argument, the client returns the most recent 250 notifications.

The client only returns notifications that are 7 days old or newer. If the notification specified in this argument is older than 7 days, the client returns an empty response.

Response

If the request to the client is successful, the client returns a Notify.Exceptions.NotifyClientException.

public List<Notification> notifications;
public Link links;

public class Link {
	public String current;
	public String next;
}

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code:

error.status_code	error.message	How to fix
`400`	`[{` `"error": "ValidationError",` `"message": "bad status is not one of [created, sending, delivered, pending, failed, technical-failure, temporary-failure, permanent-failure]"` `}]`	Contact the GOV.UK Notify team
`400`	`[{` `"error": "ValidationError",` `"message": "Apple is not one of [sms, email, letter]"` `}]`	Contact the GOV.UK Notify team
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information

Get a template

Get a template by ID

Method

This returns the latest version of the template.

TemplateResponse response = client.GetTemplateById(
    "templateId"
);

Arguments

templateId (required)

The ID of the template. Sign in to GOV.UK Notify and go to the Templates page to find this. For example:

string templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a";

Response

If the request to the client is successful, the client returns a TemplateResponse.

public String id;
public String name;
public String type;
public DateTime created_at;
public DateTime? updated_at;
public String created_by;
public int version;
public String body;
public String subject; // null if an sms message

Error codes

If the request is not successful, the client returns an HTTPError and an error code:

error.code	error.message	How to fix
`400`	`[{` `"error": "ValidationError",` `"message": "id is not a valid UUID"` `}]`	Check the notification ID
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information
`404`	`[{` `"error": "NoResultFound",` `"message": "No Result Found"` `}]`	Check your template ID

Get a template by ID and version

Method

TemplateResponse response = client.GetTemplateByIdAndVersion(
    "templateId",
    1   // integer required for version number
);

Arguments

templateId (required)

The ID of the template. Sign in to GOV.UK Notify and go to the Templates page to find this. For example:

string templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a";

version (required)

The version number of the template.

Response

If the request to the client is successful, the client returns a TemplateResponse.

public String id;
public String name;
public String type;
public DateTime created_at;
public DateTime? updated_at;
public String created_by;
public int version;
public String body;
public String subject; // null if an sms message

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code:

error.code	error.message	How to fix
`400`	`[{` `"error": "ValidationError",` `"message": "id is not a valid UUID"` `}]`	Check the notification ID
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information
`404`	`[{` `"error": "NoResultFound",` `"message": "No Result Found"` `}]`	Check your template ID and version

Get all templates

Method

This returns the latest version of all templates.

TemplateList response = client.GetAllTemplates(
    "sms" | "email" | "letter" // optional
);

Arguments

templateType (optional)

If left out, the method returns all templates. Otherwise you can filter by:

email
sms
letter

Response

If the request to the client is successful, the client returns a TemplateList.

List<TemplateResponse> templates;

If no templates exist for a template type or there no templates for a service, the client returns a TemplateList with an empty templates list element:

List<TemplateResponse> templates; // empty list of templates

Generate a preview template

Method

This generates a preview version of a template.

TemplatePreviewResponse response = client.GenerateTemplatePreview(
    templateId,
    personalisation
);

The parameters in the personalisation argument must match the placeholder fields in the actual template. The API notification client ignores any extra fields in the method.

Arguments

templateId (required)

The ID of the template. Sign in to GOV.UK Notify and go to the Templates page. For example:

string templateId: "f33517ff-2a88-4f6e-b855-c550268ce08a";

personalisation (required)

If a template has placeholder fields for personalised information such as name or reference number, you need to provide their values in a Dictionary. For example:

Dictionary<String, dynamic> personalisation = new Dictionary<String, dynamic>
{
    { "name", "someone" }
};

You can leave out this argument if a template does not have any placeholder fields for personalised information.

Response

If the request to the client is successful, you receive a TemplatePreviewResponse response.

public String id;
public String type;
public int version;
public String body;
public String subject; // null if a sms message

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code:

error.status_code	error.message	Notes
`400`	`[{` `"error": "BadRequestError",` `"message": "Missing personalisation: [PERSONALISATION FIELD]"` `}]`	Check that the personalisation arguments in the method match the placeholder fields in the template
`400`	`[{` `"error": "NoResultFound",` `"message": "No result found"` `}]`	Check the template ID
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information

Get received text messages

This API call returns one page of up to 250 received text messages. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the olderThanId argument.

You can only get the status of messages that are 7 days old or newer.

You can also set up callbacks for received text messages.

Enable received text messages

Contact the GOV.UK Notify team on the support page or through the Slack channel to enable receiving text messages for your service.

Get a page of received text messages

Method

ReceivedTextListResponse response = client.GetReceivedTexts(olderThanId);

Arguments

olderThanId (optional)

Input the ID of a notification into this argument to return the next 250 received notifications older than the given ID. For example:

olderThanId: "740e5834-3a29-46b4-9a6f-16142fde533a"

If you leave out the olderThanId argument, the client returns the most recent 250 notifications.

The client only returns notifications that are 7 days old or newer. If the notification specified in this argument is older than 7 days, the client returns an empty ReceivedTextListResponse response.

Response

If the request to the client is successful, the client returns a ReceivedTextListResponse that returns all received text messages.

public List<ReceivedText> receivedTextList;
public Link links;

public class Link {
	       public String current;
	       public String next;
}

public String id;
public String userNumber;
public String createdAt;
public String serviceId;
public String notifyNumber;
public String content;

If the notification specified in the olderThanId argument is older than 7 days, the client returns an empty ReceivedTextListResponse response.

Error codes

If the request is not successful, the client returns a Notify.Exceptions.NotifyClientException and an error code.

error.code	error.message	How to fix
`403`	`[{` `"error": "AuthError",` `"message": "Error: Your system clock must be accurate to within 30 seconds"` `}]`	Check your system clock
`403`	`[{` `"error": "AuthError",` `"message": "Invalid token: signature, api token not found"` `}]`	Use the correct API key. Refer to API keys for more information

Files

DOCUMENTATION.md

Latest commit

History

DOCUMENTATION.md

File metadata and controls

.NET client documentation

Set up the client

Prerequisites

Install the client

Use the command line

Use Microsoft Visual Studio

Console

UI

Create a new instance of the client

Send a message

Send a text message

Method

Arguments

mobileNumber (required)

templateId (required)

personalisation (optional)

reference (optional)

smsSenderId (optional)

Response

Error codes

Send an email

Method

Arguments

emailAddress (required)

templateId (required)

personalisation (optional)

reference (optional)

emailReplyToId (optional)

Response

Error codes

Send a file by email

Add a placeholder field to the template

Upload the file

Error codes

Send a letter

Method

Arguments

templateId (required)

personalisation (required)

reference (optional)

personalisation (optional)

Response

Error codes

Send a precompiled letter

Method

Arguments

clientReference (required)

pdfContents (required for the SendPrecompiledLetter method)

postage (optional)

Response

Error codes

Get message status

Status - text and email

Status - text only

Status - letter

Status - precompiled letter

Get the status of one message

Method

Arguments

notificationId (required)

Response

Error codes

Get the status of multiple messages

Method

Arguments

templateType (optional)

status (optional)

reference (optional)

olderThanId (optional)

Response

Error codes

Get a template

Get a template by ID

Method