From 1fdf1bc9afe77af85bc13ff3cd444fe2881ea09e Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 11:42:11 +0100 Subject: [PATCH 01/10] Add _email_status_descriptions.md email status descriptions are similar across our tech docs, this partial will now house the email status descriptions and will be used across all the tech docs. --- .../_email_status_descriptions.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 source/documentation/notification_status_descriptions/_email_status_descriptions.md diff --git a/source/documentation/notification_status_descriptions/_email_status_descriptions.md b/source/documentation/notification_status_descriptions/_email_status_descriptions.md new file mode 100644 index 00000000..4e621cff --- /dev/null +++ b/source/documentation/notification_status_descriptions/_email_status_descriptions.md @@ -0,0 +1,10 @@ +### Email status descriptions + +|Status|Description| +|:---|:---| +|#`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.| +|#`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 or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you 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.| From 79ba62d3e7073935d34b38c10dfc4b0c6c74146b Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 11:49:00 +0100 Subject: [PATCH 02/10] Add _text_status_descriptions.md text message status descriptions are similar across our tech docs, this partial will now house the text message status descriptions and will be used across all the tech docs. --- .../_text_status_descriptions.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 source/documentation/notification_status_descriptions/_text_status_descriptions.md diff --git a/source/documentation/notification_status_descriptions/_text_status_descriptions.md b/source/documentation/notification_status_descriptions/_text_status_descriptions.md new file mode 100644 index 00000000..e96ad897 --- /dev/null +++ b/source/documentation/notification_status_descriptions/_text_status_descriptions.md @@ -0,0 +1,12 @@ +### Text message status descriptions + +|Status|Description| +|:---|:---| +|#`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 text message.| +|#`sent`|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 website displays this status as 'Sent to an international number'.| +|#`delivered`|The message was successfully delivered. If a recipient blocks your sender name or mobile number, your message will still show as delivered.| +|#`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](https://www.notifications.service.gov.uk/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.| From 3f61dde04f3efaeafbaa97313ebf4bd8cebd79be Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 11:50:59 +0100 Subject: [PATCH 03/10] Add _letter_status_descriptions.md letter status descriptions are similar across our tech docs, this partial will now house the letter status descriptions and will be used across all the tech docs. --- .../_letter_status_descriptions.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 source/documentation/notification_status_descriptions/_letter_status_descriptions.md diff --git a/source/documentation/notification_status_descriptions/_letter_status_descriptions.md b/source/documentation/notification_status_descriptions/_letter_status_descriptions.md new file mode 100644 index 00000000..9810d3a2 --- /dev/null +++ b/source/documentation/notification_status_descriptions/_letter_status_descriptions.md @@ -0,0 +1,9 @@ +### Letter status descriptions + +|Status|Description| +|:---|:---| +|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| +|#`received`|The provider has printed and dispatched the letter.| +|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| +|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| +|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| From 26f9d9990deed23abc0eb6dbceffea63d248d012 Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 11:56:34 +0100 Subject: [PATCH 04/10] Add _precompiled_letter_status_descriptions.md precompiled letter status descriptions are similar across our tech docs, this partial will now house the precompiled letter status descriptions and will be used across all the tech docs. --- .../_precompiled_letter_status_descriptions.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 source/documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md diff --git a/source/documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md b/source/documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md new file mode 100644 index 00000000..0ce8a829 --- /dev/null +++ b/source/documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md @@ -0,0 +1,12 @@ +### Precompiled letter status descriptions + +|Status|Description| +|:---|:---| +|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| +|#`received`|The provider has printed and dispatched the letter.| +|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| +|#`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](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.| +|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| +|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| From 1c0030876d011e08a03bcf4b6e27a0df9d0fd727 Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 12:08:25 +0100 Subject: [PATCH 05/10] Update python.html.md.erb to use notification_status_descriptions partials --- source/python.html.md.erb | 50 ++++----------------------------------- 1 file changed, 4 insertions(+), 46 deletions(-) diff --git a/source/python.html.md.erb b/source/python.html.md.erb index 5934cefd..fd365add 100644 --- a/source/python.html.md.erb +++ b/source/python.html.md.erb @@ -948,52 +948,10 @@ If the request is not successful, the client returns an error. To learn more abo |:---|:---| <%= partial 'documentation/error_tables/get_the_status_of_multiple_messages' %> -### Email status descriptions - -|Status|Description| -|:---|:---| -|#`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.| -|#`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 or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you 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.| - -### Text message status descriptions - -|Status|Description| -|:---|:---| -|#`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 text message.| -|#`sent`|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 website displays this status as 'Sent to an international number'.| -|#`delivered`|The message was successfully delivered. If a recipient blocks your sender name or mobile number, your message will still show as delivered.| -|#`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](https://www.notifications.service.gov.uk/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.| - -### Letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - -### Precompiled letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`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](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| +<%= partial 'documentation/notification_status_descriptions/_email_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_text_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_letter_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md' %> ### Get a PDF for a letter notification From 2c6b6af56318898bff6547ef2ecbe8a27d865677 Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 12:15:44 +0100 Subject: [PATCH 06/10] Update node.html.md.erb to use notification_status_descriptions partials --- source/node.html.md.erb | 52 ++++------------------------------------- 1 file changed, 4 insertions(+), 48 deletions(-) diff --git a/source/node.html.md.erb b/source/node.html.md.erb index 487ff32a..602b4a57 100644 --- a/source/node.html.md.erb +++ b/source/node.html.md.erb @@ -972,54 +972,10 @@ If the request is not successful, the promise fails with an `err`. To learn more |:---|:---| <%= partial 'documentation/error_tables/get_the_status_of_multiple_messages' %> - -### Email status descriptions - -|Status|Description| -|:---|:---| -|#`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.| -|#`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 or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you 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.| - -### Text message status descriptions - -|Status|Description| -|:---|:---| -|#`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 text message.| -|#`sent`|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 website displays this status as 'Sent to an international number'.| -|#`delivered`|The message was successfully delivered. If a recipient blocks your sender name or mobile number, your message will still show as delivered.| -|#`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](https://www.notifications.service.gov.uk/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.| - -### Letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - -### Precompiled letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`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](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - +<%= partial 'documentation/notification_status_descriptions/_email_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_text_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_letter_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md' %> ### Get a PDF for a letter notification From a05079de8eac4e574f8ec9e47520399883e27e08 Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 12:27:23 +0100 Subject: [PATCH 07/10] Update rest.html.md.erb to use notification_status_descriptions partials --- source/rest-api.html.md.erb | 51 +++---------------------------------- 1 file changed, 4 insertions(+), 47 deletions(-) diff --git a/source/rest-api.html.md.erb b/source/rest-api.html.md.erb index ca33ad45..b9504c1c 100644 --- a/source/rest-api.html.md.erb +++ b/source/rest-api.html.md.erb @@ -950,54 +950,11 @@ If the request is not successful, the API returns `json` containing the relevant |Error message|How to fix| |:---|:---| <%= partial 'documentation/error_tables/get_the_status_of_multiple_messages' %> -### Email status descriptions - -|Status|Description| -|:---|:---| -|#`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.| -|#`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 or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you 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.| - -### Text message status descriptions - -|Status|Description| -|:---|:---| -|#`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 text message.| -|#`sent`|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 website displays this status as 'Sent to an international number'.| -|#`delivered`|The message was successfully delivered. If a recipient blocks your sender name or mobile number, your message will still show as delivered.| -|#`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](https://www.notifications.service.gov.uk/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.| - - -### Letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - -### Precompiled letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`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](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| +<%= partial 'documentation/notification_status_descriptions/_email_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_text_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_letter_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md' %> ### Get a PDF for a letter notification From 96de7d9a4191576e9855428e09d503915c3fb4f0 Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 13:04:54 +0100 Subject: [PATCH 08/10] Update ruby.html.md.erb to use notification_status_descriptions partials --- source/ruby.html.md.erb | 51 ++++------------------------------------- 1 file changed, 4 insertions(+), 47 deletions(-) diff --git a/source/ruby.html.md.erb b/source/ruby.html.md.erb index d223e918..db660106 100644 --- a/source/ruby.html.md.erb +++ b/source/ruby.html.md.erb @@ -842,53 +842,10 @@ If the request is not successful, the client returns an error. To learn more abo |:---|:---| <%= partial 'documentation/error_tables/ruby/get_the_status_of_multiple_messages' %> -### Email status descriptions - -|Status|Description| -|:---|:---| -|#`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.| -|#`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 or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you 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.| - -### Text message status descriptions - -|Status|Description| -|:---|:---| -|#`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 text message.| -|#`sent`|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 website displays this status as 'Sent to an international number'.| -|#`delivered`|The message was successfully delivered. If a recipient blocks your sender name or mobile number, your message will still show as delivered.| -|#`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](https://www.notifications.service.gov.uk/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.| - -### Letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - -### Precompiled letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`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](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - +<%= partial 'documentation/notification_status_descriptions/_email_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_text_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_letter_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md' %> ### Get a PDF for a letter notification From 8766f7143b487296d9790ca78d72d0f81af17639 Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Fri, 27 Jun 2025 13:35:54 +0100 Subject: [PATCH 09/10] Update php.html.md.erb to use notification_status_descriptions partials --- source/php.html.md.erb | 51 ++++-------------------------------------- 1 file changed, 4 insertions(+), 47 deletions(-) diff --git a/source/php.html.md.erb b/source/php.html.md.erb index 2875e8f3..3a2d55df 100644 --- a/source/php.html.md.erb +++ b/source/php.html.md.erb @@ -939,53 +939,10 @@ If the request is not successful, the client returns an error. To learn more abo |:---|:---| <%= partial 'documentation/error_tables/get_the_status_of_multiple_messages' %> - -### Email status descriptions - -|Status|Description| -|:---|:---| -|#`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.| -|#`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 or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you 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.| - -### Text message status descriptions - -|Status|Description| -|:---|:---| -|#`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 text message.| -|#`sent`|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 website displays this status as 'Sent to an international number'.| -|#`delivered`|The message was successfully delivered. If a recipient blocks your sender name or mobile number, your message will still show as delivered.| -|#`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](https://www.notifications.service.gov.uk/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.| - -### Letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - -### Precompiled letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`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](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| +<%= partial 'documentation/notification_status_descriptions/_email_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_text_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_letter_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md' %> ### Get a PDF for a letter notification From bcec31ba97640f31f1d702a6232b4d10c68b7d78 Mon Sep 17 00:00:00 2001 From: Chukwugozie Mbeledogu Date: Mon, 30 Jun 2025 09:43:34 +0100 Subject: [PATCH 10/10] Update java.html.md.erb to use notification_status_descriptions partials --- source/java.html.md.erb | 49 ++++------------------------------------- 1 file changed, 4 insertions(+), 45 deletions(-) diff --git a/source/java.html.md.erb b/source/java.html.md.erb index f624a21d..006b79ba 100644 --- a/source/java.html.md.erb +++ b/source/java.html.md.erb @@ -822,52 +822,11 @@ If the request is not successful, the client returns an error. To learn more abo |:---|:---| <%= partial 'documentation/error_tables/get_the_status_of_multiple_messages' %> -### Email status descriptions +<%= partial 'documentation/notification_status_descriptions/_email_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_text_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_letter_status_descriptions.md' %> +<%= partial 'documentation/notification_status_descriptions/_precompiled_letter_status_descriptions.md' %> -|Status|Description| -|:---|:---| -|#`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.| -|#`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 or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you 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.| - -### Text message status descriptions - -|Status|Description| -|:---|:---| -|#`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 text message.| -|#`sent`|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 website displays this status as 'Sent to an international number'.| -|#`delivered`|The message was successfully delivered.| -|#`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](https://www.notifications.service.gov.uk/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.| - -### Letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| - -### Precompiled letter status descriptions - -|Status|Description| -|:---|:---| -|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.| -|#`received`|The provider has printed and dispatched the letter.| -|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.| -|#`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](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.| -|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.| -|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.| ### Get a PDF for a letter notification