Skip to main content
Table of contents

PHP client documentation

This documentation is for developers interested in using the GOV.UK Notify PHP client to send emails, text messages or letters.

Set up the client

The Notify PHP Client is based on a PSR-7 HTTP model [external link]. To install it, you must select your preferred HTTP client. You can follow these instructions to use Guzzle v6 and v5 and cURL [external links].

Guzzle v6

  1. Use Composer [external link] to install the GOV.UK Notify PHP client. Run the following in the command line:

    composer require php-http/guzzle6-adapter alphagov/notifications-php-client
    

    You can now use the autoloader [external link] to download the GOV.UK Notify PHP client.

  2. Add the following code to your application to create a new instance of the client:

    $notifyClient = new \Alphagov\Notifications\Client([
        'apiKey' => '{your api key}',
        'httpClient' => new \Http\Adapter\Guzzle6\Client
    ]);
    

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

Guzzle v5

  1. Use Composer [external link] to install the GOV.UK Notify PHP client. Run the following in the command line:

    composer require php-http/guzzle5-adapter php-http/message alphagov/notifications-php-client
    

    You can now use the autoloader [external link] to download the GOV.UK Notify PHP client.

  2. Add the following code to your application to create a new instance of the client:

    $notifyClient = new \Alphagov\Notifications\Client([
        'apiKey'        => '{your api key}',
        'httpClient'    => new \Http\Adapter\Guzzle5\Client(
            new \GuzzleHttp\Client,
            new \Http\Message\MessageFactory\GuzzleMessageFactory
        ),
    ]);
    
  3. Run $notifyClient to access the GOV.UK Notify API.

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

cURL

  1. Use Composer [external link] to install the GOV.UK Notify PHP client. Run the following in the command line:

    composer require php-http/curl-client php-http/message alphagov/notifications-php-client
    

You can now use the autoloader [external link] to download the GOV.UK Notify PHP client.

  1. Add the following code to your application to create a new instance of the client:

    $notifyClient = new \Alphagov\Notifications\Client([
        'apiKey'        => '{your api key}',
        'httpClient'    => new \Http\Client\Curl\Client(
            new \Http\Message\MessageFactory\GuzzleMessageFactory,
            new \Http\Message\StreamFactory\GuzzleStreamFactory
        ),
    ]);
    
  2. Run $notifyClient to access the GOV.UK Notify API.

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

Send a message

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

Send a text message

Method

sendSms( $phoneNumber, $templateId, array $personalisation = array(), $reference = '', $smsSenderId = NULL  )

For example:

try {
    $response = $notifyClient->sendSms(
        '+447777111222',
        'df10a23e-2c6d-4ea5-87fb-82e520cbf93a', [
            'name' => 'Betty Smith',
            'dob'  => '12 July 1968'
        ],
        'unique_ref123',
        '862bfaaf-9f89-43dd-aafa-2868ce2926a9'
    );

} catch (ApiException $e){}

Arguments

phoneNumber (required)

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

templateId (required)

To find the template ID:

  1. Sign in to GOV.UK Notify.
  2. Go to the Templates page and select the relevant template.
  3. Select Copy template ID to clipboard.
personalisation (optional)

If a template has placeholder fields for personalised information such as name or application date, you must provide their values in a dictionary with key value pairs. For example:

$personalisation = [
    '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 necessary. 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:

$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.

To find the text message sender:

  1. Sign in to GOV.UK Notify.
  2. Go to the Settings page.
  3. In the Text Messages section, 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 will use, and select Save
$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 array:

[
    "id" => "bfb50d92-100d-4b8b-b559-14fa3b091cda",
    "reference" => None,
    "content" => [
        "body" => "Some words",
        "from_number" => "40604"
    ],
    "uri" => "https =>//api.notifications.service.gov.uk/v2/notifications/ceb50d92-100d-4b8b-b559-14fa3b091cd",
    "template" => [
        "id" => "ceb50d92-100d-4b8b-b559-14fa3b091cda",
       "version" => 1,
       "uri" => "https://api.notifications.service.gov.uk/v2/templates/bfb50d92-100d-4b8b-b559-14fa3b091cda"
    ]
];

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

All messages sent using the team and guest list or live keys will appear on your dashboard.

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code.

exc->getCode() exc->getErrors() 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: API key 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

sendEmail( $emailAddress, $templateId, array $personalisation = array(), $reference = '', $emailReplyToId = NULL )

For example:

try {

    $response = $notifyClient->sendEmail(
        'betty@example.com',
        'df10a23e-2c0d-4ea5-87fb-82e520cbf93c', [
            'name' => 'Betty Smith',
            'dob'  => '12 July 1968'
        ],
        'unique_ref123',
        '862bfaaf-9f89-43dd-aafa-2868ce2926a9'
        );

} catch (ApiException $e){}

Arguments

emailAddress (required)

The email address of the recipient.

templateId (required)

To find the template ID:

  1. Sign in to GOV.UK Notify.
  2. Go to the Templates page and select the relevant template.
  3. Select Copy template ID to clipboard.
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 with key value pairs. For example:

$personalisation = [
    '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 necessary. 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.

$reference = 'STRING';

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

emailReplyToId (optional)

This is an email address specified by you to receive replies from your users. You must add at least one reply-to email address before your service can go live.

To add a reply-to email address:

  1. Sign in to GOV.UK Notify.
  2. Go to the Settings page.
  3. In the Email section, select Manage on the Reply-to email addresses row.
  4. Select Add reply-to address.
  5. Enter the email address you want to use, and select Add.

For example:

$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.

Send a file by email

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

The links are unique and unguessable. GOV.UK Notify cannot access or decrypt your file.

Add contact details to the file download page

  1. Sign in to GOV.UK Notify.
  2. Go to the Settings page.
  3. In the Email section, select Manage on the Send files by email row.
  4. Enter the contact details you want to use, and select Save.

Add a placeholder to the template

  1. Sign in to GOV.UK Notify.
  2. Go to the Templates page and select the relevant email template.
  3. Select Edit.
  4. Add a placeholder to the email template using double brackets. For example:

“Download your file at: ((link_to_file))”

Upload your file

You can upload PDF, CSV, .odt, .txt, .rtf and MS Word Document files. Your file must be smaller than 2MB.. Contact the GOV.UK Notify team if you need to send other file types.

Pass the file object as a value into the personalisation argument. For example:

try {
    $file_data = file_get_contents('/path/to/my/file.pdf');

    $response = $notifyClient->sendEmail(
        'betty@example.com',
        'df10a23e-2c0d-4ea5-87fb-82e520cbf93c',
        [
            'name' => 'Betty Smith',
            'dob'  => '12 July 1968',
            'link_to_file' => $notifyClient->prepareUpload( $file_data )
        ]
    );
}
catch (ApiException $e){}
catch (InvalidArgumentException $e){}
CSV Files

Uploads for CSV files should use the is_csv parameter on the prepareUpload() helper method. For example:

try {
    $file_data = file_get_contents('/path/to/my/file.csv');

    $response = $notifyClient->sendEmail(
        'betty@example.com',
        'df10a23e-2c0d-4ea5-87fb-82e520cbf93c',
        [
            'name' => 'Betty Smith',
            'dob'  => '12 July 1968',
            'link_to_file' => $notifyClient->prepareUpload( $file_data, true )
        ]
    );
}
catch (ApiException $e){}
catch (InvalidArgumentException $e){}

Response

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

[
    "id" => "bfb50d92-100d-4b8b-b559-14fa3b091cda",
    "reference" => None,
    "content" => [
        "subject" => "SUBJECT TEXT",
        "body" => "MESSAGE TEXT",
        "from_email" => "SENDER EMAIL
    ],
    "uri" => "https://api.notifications.service.gov.uk/v2/notifications/ceb50d92-100d-4b8b-b559-14fa3b091cd",
    "template" => [
        "id" => "ceb50d92-100d-4b8b-b559-14fa3b091cda",
        "version" => 1,
        "uri" => "https://api.notificaitons.service.gov.uk/service/your_service_id/templates/bfb50d92-100d-4b8b-b559-14fa3b091cda"
    ]
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code.

exc->getCode() exc->getErrors() 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 file type '(FILE TYPE)'. Supported types are: '(ALLOWED TYPES)'"
}]
Wrong file type. You can only upload .pdf, .csv, .txt, .doc, .docx, .rtf or .odt files.
400 [{
"error": "BadRequestError",
"message": "File did not pass the virus scan"
}]
The file contains a virus.
400 [{
"error": "BadRequestError",
"message": "Send files by email has not been set up - add contact details for your service at https://www.notifications.service.gov.uk/services/(SERVICE ID)/service-settings/send-files-by-email"
}]
See how to add contact details to the file download page
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: API key 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.
N/A Exception\InvalidArgumentException( 'File is larger than 2MB.' ) The file is too big. Files must be smaller than 2MB.

Send a letter

Prerequisites

When you add a new service it will start in trial mode. You can only send letters when your service is live.

To send Notify a request to go live:

  1. Sign in to GOV.UK Notify.
  2. Go to the Settings page.
  3. In the Your service is in trial mode section, select request to go live.

Method

sendLetter( $templateId, array $personalisation = array(), $reference = '' )

For example:

try {

    $response = $notifyClient->sendEmail(
        'df10a23e-2c0d-4ea5-87fb-82e520cbf93c',
        [
            'name'=>'Fred',
            'address_line_1' => 'Foo',
            'address_line_2' => 'Bar',
            'address_line_3' => 'SW1 1AA'
        ],
        'unique_ref123'
    );

} catch (ApiException $e){}

Arguments

templateId (required)

To find the template ID:

  1. Sign in to GOV.UK Notify.
  2. Go to the Templates page and select the relevant template.
  3. Select Copy template ID to clipboard.
personalisation (required)

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

  • address_line_1
  • address_line_2
  • address_line_3
  • address_line_4
  • address_line_5
  • address_line_6
  • address_line_7

The address must have at least 3 lines.

The last line needs to be a real UK postcode or the name of a country outside the UK.

Notify checks for international addresses and will automatically charge you the correct postage.

The postcode personalisation argument has been replaced. If your template still uses postcode, Notify will treat it as the last line of the address.

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

$personalisation =
          [
            'address_line_1' => 'The Occupier',
            'address_line_2' => '123 High Street',
            'address_line_3' => 'Richmond upon Thames',
            'address_line_4' => 'Middlesex',
            'address_line_5' => 'SW14 6BF',
            'name' => 'John Smith',
            'application_id' => '4134325'
          ];
reference (optional)

A unique identifier you can create if necessary. 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:

$reference = 'STRING';

Response

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

[
    "id" => "bfb50d92-100d-4b8b-b559-14fa3b091cda",
    "reference" => "unique_ref123",
    "content" => [
        "subject" => "Licence renewal",
        "body" => "Dear Bill, your licence is due for renewal on 3 January 2016.",
    ],
    "uri" => "https://api.notifications.service.gov.uk/v2/notifications/ceb50d92-100d-4b8b-b559-14fa3b091cd",
    "template" => [
        "id" => "ceb50d92-100d-4b8b-b559-14fa3b091cda",
        "version" => 1,
        "uri" => "https://api.notifications.service.gov.uk/service/your_service_id/templates/bfb50d92-100d-4b8b-b559-14fa3b091cda"
    ],
    "scheduled_for" => null
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code.

exc->getCode() exc->getErrors() 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, check personalisation for more information.
400 [{
"error": "ValidationError",
"message": "Must be a real UK postcode"
}]
Ensure that the value for the last line of the address is a real UK postcode.
400 [{
"error": "ValidationError",
"message": "Last line of address must be a real UK postcode or another country"
}]
Ensure that the value for the last line of the address is a real UK postcode or the name of a country outside the UK.
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: API key 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

$response = $notifyClient->sendPrecompiledLetter(
    $reference,
    $pdf_data,
    $postage,
);

Arguments

reference (required)

A unique identifier you create if necessary. 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.

$reference = 'STRING';
pdf_data (required)

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

$pdf_data = file_get_contents("path/to/pdf_file");
try {

    $response = $notifyClient->sendPrecompiledLetter(
        'unique_ref123',
        $pdf_data,
        'first',
    );

} catch (ApiException $e){}
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.

$postage = 'first';

Response

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

[
  "id" => "740e5834-3a29-46b4-9a6f-16142fde533a",
  "reference" => "unique_ref123",
  "postage" => "first"
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code.

exc->getCode() exc->getErrors() 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": "Letter content is not a valid PDF"
}]
PDF file format is required.
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": "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’
429 [{
"error": "RateLimitError",
"message": "Exceeded rate limit for key type live of 10 requests per 20 seconds"
}]
Use the correct API key. Refer to API keys for more information.
429 [{
"error": "TooManyRequestsError",
"message": "Exceeded send limits (LIMIT NUMBER) for today"
}]
Refer to service limits for the limit number.

Get message status

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

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

Status - 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 for up to 72 hours. 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 was wrong. You should remove these email addresses from your database.”
- temporary-failure - “The provider could not deliver the message. This can happen when the recipient’s inbox is full. You can try to send the message again.”
- 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.”

Status - text message

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 for up to 72 hours. GOV.UK Notify is waiting for delivery 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 to an international number.
Delivered The message was successfully delivered.
Failed This covers all failure statuses:
- permanent-failure - “The provider could not deliver the message. This can happen if the phone number was wrong or if the network operator rejects the message. If you’re sure that these phone numbers are correct, you should contact GOV.UK Notify support. If not, you should remove them from your database. You’ll still be charged for text messages that cannot be delivered.”
- temporary-failure - “The provider could not deliver the message. This can happen when the recipient’s phone is off, has no signal, or their text message inbox is full. 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 - 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 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

getNotification( $notificationId )

For example:

try {

    $response = $notifyClient->getNotification( 'c32e9c89-a423-42d2-85b7-a21cd4486a2a' );

} catch (ApiException $e){}

Arguments

notificationId (required)

The ID of the notification. To find the notification ID, you can either:

Response

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

[
    "id" => "notify_id",
    "body" => "Hello Foo",
    "subject" => "null|email_subject",
    "reference" => "client reference",
    "email_address" => "email address",
    "phone_number" => "phone number",
    "line_1" => "full name of a person or company",
    "line_2" => "123 The Street",
    "line_3" => "Some Area",
    "line_4" => "Some Town",
    "line_5" => "Some county",
    "line_6" => "Something else",
    "line_7" => "Postcode or country",
    "postage" => "null|first|second",
    "type" => "sms|letter|email",
    "status" => "current status",
    "template" => [
        "version" => 1,
        "id" => 1,
        "uri" => "/template/{id}/{version}"
     ],
    "created_at" => "created at",
    "sent_at" => "sent to provider at",
];

Error codes

If the request is not successful, the client will return an Alphagov\Notifications\Exception\ApiException object containing the relevant error code:

exc->getCode() exc->getErrors() 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: API key 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 one page of up to 250 messages and statuses. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the older_than argument.

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

Method

listNotifications( array $filters = array() )
    $response = $notifyClient->listNotifications([
        'older_than' => 'c32e9c89-a423-42d2-85b7-a21cd4486a2a',
        'reference' => 'weekly-reminders',
        'status' => 'delivered',
        'template_type' => 'sms'
    ]);

You can leave out the older_than argument to get the 250 most recent messages.

To get older messages, pass the ID of an older notification into the older_than argument. This returns the next 250 oldest messages from the specified notification ID.

Arguments

You can leave out any of these arguments to ignore these filters.

template_type (optional)

You can filter by:

  • email
  • sms
  • letter

You can leave out this argument to ignore this filter.

status (optional)

You can filter by each:

You can leave out this argument to ignore this filter.

reference (optional)

A unique identifier you can create if necessary. 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.

$reference = 'STRING';

You can leave out this argument to ignore this filter.

older_than (optional)

Input the ID of a notification into this argument. If you use this argument, the method returns the next 250 received notifications older than the specified ID.

older_than='740e5834-3a29-46b4-9a6f-16142fde533a'

If you leave out this argument, the method 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 an array.

[
    "notifications" => [
            "id" => "notify_id",
            "reference" => "client reference",
            "email_address" => "email address",
            "phone_number" => "phone number",
            "line_1" => "full name of a person or company",
            "line_2" => "123 The Street",
            "line_3" => "Some Area",
            "line_4" => "Some Town",
            "line_5" => "Some county",
            "line_6" => "Something else",
            "postcode" => "postcode",
            "postage" => "null|first|second",
            "type" => "sms | letter | email",
            "status" => sending | delivered | permanent-failure | temporary-failure | technical-failure
            "template" => [
            "version" => 1,
            "id" => 1,
            "uri" => "/template/{id}/{version}"
        ],
        "created_at" => "created at",
        "sent_at" => "sent to provider at",
        ],
        
  ],
  "links" => [
     "current" => "/notifications?template_type=sms&status=delivered",
     "next" => "/notifications?older_than=last_id_in_list&template_type=sms&status=delivered"
  ]
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code:

exc->getCode() exc->getErrors() 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: API key not found"
}]
Use the correct API key. Refer to API keys for more information.

Get a PDF for a letter notification

Method

This returns the PDF contents of a letter notification.

$pdf_file = $notifyClient->getPdfForLetter(
  'f33517ff-2a88-4f6e-b855-c550268ce08a' // required string - notification ID
)

Arguments

notificationId (required)

The ID of the notification. To find the notification ID, you can either:

Response

If the request to the client is successful, the client will return a string containing the raw PDF data.

Error codes

If the request is not successful, the client throws an Alphagov\Notifications\Exception\ApiException object containing the relevant error code:

error.status_code error.message How to fix
400 [{
"error": "ValidationError",
"message": "id is not a valid UUID"
}]
Check the notification ID
400 [{
"error": "PDFNotReadyError",
"message": "PDF not available yet, try again later"
}]
Wait for the notification to finish processing. This usually takes a few seconds
400 [{
"error": "BadRequestError",
"message": "File did not pass the virus scan"
}]
You cannot retrieve the contents of a letter notification that contains a virus
400 [{
"error": "BadRequestError",
"message": "PDF not available for letters in technical-failure"
}]
You cannot retrieve the contents of a letter notification in technical-failure
400 [{
"error": "ValidationError",
"message": "Notification is not a letter"
}]
Check that you are looking up the correct notification
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: API key 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 a template

Get a template by ID

Method

This returns the latest version of the template.

$response = $notifyClient->getTemplate( 'templateId' );

Arguments

templateId (required)

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

Response

If the request to the client is successful, the client returns an array.

[
    "id" => "template_id",
    "type" => "sms|email|letter",
    "created_at" => "created at",
    "updated_at" => "updated at",
    "version" => "version",
    "created_by" => "someone@example.com",
    "body" => "body",
    "subject" => "null|email or letter subject",
    "letter_contact_block" => "null|letter_contact_block"
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code:

exc->getCode() exc->getErrors() 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: API key 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

$response = $notifyClient->getTemplateVersion( 'templateId', 1 );

Arguments

templateId (required)

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

version (required)

The version number of the template.

Response

If the request to the client is successful, the client returns an array.

[
    "id" => "template_id",
    "type" => "sms|email|letter",
    "created_at" => "created at",
    "updated_at" => "updated at",
    "version" => "version",
    "created_by" => "someone@example.com",
    "body" => "body",
    "subject" => "null|email or letter subject",
    "letter_contact_block" => "null|letter_contact_block"
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code:

exc->getCode() exc->getErrors() 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: API key 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.

    $this->listTemplates(
      $template_type  // optional
    );

Arguments

template_type (optional)

If omitted, 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 an array.

[
    "templates"  => [
        [
            "id" => "template_id",
            "type" => "sms|email|letter",
            "created_at" => "created at",
            "updated_at" => "updated at",
            "version" => "version",
            "created_by" => "someone@example.com",
            "body" => "body",
            "subject" => "null|email or letter subject",
            "letter_contact_block" => "null|letter_contact_block"
        ],
        [
            ... another template
        ]
    ]
];

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

[
    "templates"  => []
];

Generate a preview template

Method

This generates a preview version of a template.

    $personalisation = [ "foo" => "bar" ];
    $this->previewTemplate( $templateId, $personalisation );

The parameters in the personalisation argument must match the placeholder fields in the actual template. The API notification client will ignore 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 to find it.

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 with key value pairs. For example:

$personalisation = [
    'first_name' => 'Amala',
    'reference_number' => '300241',
];

Response

If the request to the client is successful, the client returns an array.

[
    "id" => "notify_id",
    "type" => "sms|email|letter",
    "version" => "version",
    "body" => "Hello bar" // with substitution values,
    "subject" => "null|email_subject"
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code:

exc->getCode() exc->getErrors() 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: API key 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 older_than 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 using the support page or chat to us on Slack to request a unique number for text message replies.

Get a page of received text messages

Method

    $this->listReceivedTexts(
      $older_than  // optional
    );

To get older messages, pass the ID of an older notification into the older_than argument. This returns the next 250 oldest messages from the specified notification ID.

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

Arguments

older_than (optional)

Input the ID of a received text message into this argument. If you use this argument, the client returns the next 250 received text messages older than the given ID. For example:

$older_than = '8e222534-7f05-4972-86e3-17c5d9f894e2'

If you leave out the older_than 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 collection response.

Response

If the request to the client is successful, the client returns an array.

[
    "received_text_messages" => [
        [
            "id" => "notify_id",
            "user_number" => "user number",
            "notify_number" => "notify number",
            "created_at" => "created at",
            "service_id" => "service id",
            "content" => "text content"
        ],
        [
            ... another received text message
        ]
    ]
  ],
  "links" => [
     "current" => "/received-text-messages",
     "next" => "/received-text-messages?older_than=last_id_in_list"
  ]
];

Error codes

If the request is not successful, the client returns an Alphagov\Notifications\Exception\ApiException object containing the relevant error code:

exc->getCode() exc->getErrors() Notes
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: API key not found"
}]
Use the correct API key. Refer to API keys for more information.

Testando

Todos os testes ocorrem no ambiente de produção. Não há ambiente de teste para Gov.br Notifica.

Teste de fumaça

Se você precisar de teste de fumaça sua integração com o Gov.br Notifica regularmente, você deve usar os seguintes números de telefone e endereços de e-mail para teste de fumaça.

 
Número de telefone
07700900000
07700900111
07700900222
Endereço de e-mail
simulate-delivered@notifications.service.gov.uk
simulate-delivered-2@notifications.service.gov.uk
simulate-delivered-3@notifications.service.gov.uk

Os números de telefone e endereços de e-mail do teste de fumaça validarão a solicitação e simularão uma resposta bem-sucedida, mas não enviarão uma mensagem real, produzirão um recibo de entrega ou manterão a notificação no banco de dados.

Você pode usar esses números e endereços de teste de fumaça com qualquer tipo de chave de API.

Você pode testar todas as funções do cliente Notificação API, exceto:

  • Obtenha o status de uma mensagem
  • Obtenha o status de todas as mensagens

Você não pode usar os números de telefone ou endereço de e-mail do teste de fumaça com essas funções porque eles retornam um falso notification_ID. Se você precisar testar essas funções, use uma chave API de teste e qualquer outro número de telefone ou e-mail.

Outros testes

Você deve usar uma chave de API de teste para fazer um teste sem fumaça, como teste de desempenho ou integração. Você pode usar qualquer número de telefone ou endereço de e-mail de teste que não seja fumante. Você não precisa de uma conta de teste específica do Gov.br Notifica.

Chaves da API

Existem três tipos diferentes de chaves de API:

  • teste
  • lista de equipe e de convidados
  • ao vivo

Quando você configura um novo serviço, ele começa em modo de teste. Um serviço em modo de teste pode criar chaves de lista de teste e equipe e de convidados. Você deve ter um serviço ativo para criar uma chave ativa.

Para criar uma chave de API:

  1. Faça login no Gov.br Notifica.
  2. Vá para a página de Integração da API.
  3. Selecione chaves de API.
  4. Selecione Criar uma chave da API.

Teste

Use uma chave de teste para testar o desempenho de seu serviço e sua integração com Gov.br Notifica.

Mensagens enviadas usando uma chave de teste:

  • gerar respostas realistas
  • resulta em um status entregue
  • não são realmente entregues a um destinatário
  • não aparecem no seu painel
  • não conte para as suas mensagens de texto e e-mail

Para testar as respostas de falha com uma chave de teste, use os seguintes números e endereços:

Número de telefone / endereço de e-mail Resposta
07700900003 temporary-failure
07700900002 permanent-failure
temp-fail@simulator.notify temporary-failure
perm-fail@simulator.notify permanent-failure
qualquer outro número ou endereço válido delivered

Você não precisa revogar as chaves de teste.

Equipe e lista de convidados

Uma chave de equipe e lista de convidados permite que você envie mensagens reais aos membros de sua equipe e endereços / números em sua lista de convidados enquanto seu serviço ainda está em modo de teste.

Você receberá um erro se usar essas teclas para enviar mensagens a alguém que não esteja em sua equipe ou na sua lista de convidados.

As mensagens enviadas com uma chave de equipe e lista de convidados aparecem em seu painel e contam em sua mensagem de texto e e-mail.

Você não precisa revogar as chaves da equipe e da lista de convidados.

Ao Vivo

Você só pode criar chaves ativas quando o serviço estiver ativo. Você pode usar as teclas ativas para enviar mensagens para qualquer pessoa.

As mensagens enviadas com uma tecla ativa aparecem no seu painel e contam contra as suas mensagens de texto e e-mail.

Você deve revogar e recriar essas chaves regularmente. Para revogar uma chave:

  1. Faça login no Gov.br Notifica.
  2. Vá para a página de Integração da API.
  3. Selecione chaves de API.
  4. Selecione Revogar para a chave de API que você deseja revogar.

Você pode ter mais de uma chave ativa por vez.

Você nunca deve enviar mensagens de teste para números ou endereços inválidos usando uma chave ativa.

Limites

Limites de taxa

Você está limitado a enviar 3.000 mensagens por minuto.

Esse limite é calculado em uma base contínua, por tipo de chave de API. Se você exceder o limite, obterá o erro 429 RateLimitError.

Limites diários

Há um limite para o número de mensagens que você pode enviar por dia:

Status do serviço Tipo de chave API Limite diário
Ao vivo Equipe ou ao vivo 250,000
Trial Equipe 50
Ao vivo ou trial Teste Ilimitada

Esses limites são redefinidos à meia-noite.

Limites da rede telefônica

Se você enviar mensagens de texto repetidamente para o mesmo número, as redes telefônicas as bloquearão.

Existe um limite por hora de:

  • 20 mensagens com o mesmo conteúdo
  • 100 mensagens com qualquer conteúdo

Suas mensagens não podem ser entregues se você exceder esses limites.

Chamadas de retorno

Chamadas de retorno são quando o Gov.br Notifica envia solicitações POST para o seu serviço. Você pode obter retornos de chamada quando:

  • uma mensagem de texto ou e-mail que você enviou foi entregue ou falhou
  • seu serviço recebe uma mensagem de texto

Configurar chamadas de retorno

Você deve fornecer:

  • um URL onde o Gov.br Notifica postará o retorno para a chamada
  • um token de portador que o Gov.br Notifica colocará no cabeçalho de autorização das solicitações

Para fazer isso:

  1. Faça login no Gov.br Notifica.
  2. Vá para a página de Integração da API.
  3. Selecione Callbacks.

Recibos de entrega

Quando você envia um e-mail ou mensagem de texto, o Gov.br Notifica envia um recibo para o seu URL de retorno com o status da mensagem. Este é um método automatizado para obter o status das mensagens.

Esta funcionalidade funciona com chaves de API de teste, mas não funciona com números de telefone ou endereços de e-mail de teste de fumaça.

A mensagem de retorno de chamada é formatada em JSON. A chave, a descrição e o formato dos argumentos da mensagem de retorno de chamada serão:

Chave Descrição Formato
id ID de notificação para os recibos de status UUID
reference A referência enviada pelo serviço 12345678
to O endereço de e-mail ou número de telefone do destinatário hello@gov.uk ou 07700912345
status O status da notificação delivered, permanent-failure, temporary-failure ou technical-failure
created_at A hora em que o serviço enviou a solicitação 2017-05-14T12:15:30.000000Z
completed_at A última vez que o status foi atualizado 2017-05-14T12:15:30.000000Z ou nulo
sent_at A hora em que a notificação foi enviada 2017-05-14T12:15:30.000000Z ou nulo
notification_type O tipo de notificação email ou sms

Mensagens de texto recebidas

Se o seu serviço receber mensagens de texto no Gov.br Notifica, o Gov.br Notifica pode encaminhá-las para o seu URL de retorno de chamada assim que chegarem.

Contate a equipe do Gov.br Notifica usando a página de suporte ou converse conosco no Slack para solicitar um número exclusivo para respostas de mensagens de texto.

A mensagem de retorno de chamada é formatada em JSON. A chave, a descrição e o formato dos argumentos da mensagem de retorno de chamada serão:

Chave Descrição Formato
id ID da notificação para a mensagem recebida UUID
source_number O número de telefone de onde a mensagem foi enviada 447700912345
destination_number O número para o qual a mensagem foi enviada (seu número) 07700987654
message A mensagem recebida Hello Notify!
date_received A data e hora UTC em que a mensagem foi recebida pelo Gov.br Notifica 2017-05-14T12:15:30.000000Z

Arquitetura da API

Envie uma mensagem

Obter status da mensagem

Receba mensagens de entrada

Suporte

Relate quaisquer problemas através da página de suporte de notificação do Gov.br Notifica.