From 1378e0d97cd7b46b29b608dc02773755bff7e68d Mon Sep 17 00:00:00 2001 From: femi-ashiru-nhs <220047412+femi-ashiru-nhs@users.noreply.github.com> Date: Tue, 28 Oct 2025 15:36:35 +0000 Subject: [PATCH 1/3] CCM-12832: update API documentation for new global routing configs --- specification/documentation/APIDescription.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/documentation/APIDescription.md b/specification/documentation/APIDescription.md index b5c7f05e4..5557e66b7 100644 --- a/specification/documentation/APIDescription.md +++ b/specification/documentation/APIDescription.md @@ -159,6 +159,9 @@ Use the following routing plan IDs and personalisation fields that match the mes | Email | email_subject, email_body | 00000000-0000-0000-0000-000000000002 | | Text message | sms_body | 00000000-0000-0000-0000-000000000003 | | NHS App message with a fallback to email | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 | +| NHS App message with a 4hr fallback to email | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000005 | +| NHS App message with a 24hr fallback to Text message | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000006 | +| NHS App message with a 4hr fallback to Text message | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000007 | For email, use the personalisation field `email_subject` to allow your user to add the email subject line. From 9b073cd641aa2862f49691b78e2c03ba79562f41 Mon Sep 17 00:00:00 2001 From: femi-ashiru-nhs <220047412+femi-ashiru-nhs@users.noreply.github.com> Date: Thu, 30 Oct 2025 10:22:38 +0000 Subject: [PATCH 2/3] CCM-12832: change table format --- specification/documentation/APIDescription.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/documentation/APIDescription.md b/specification/documentation/APIDescription.md index 5557e66b7..a8cee873e 100644 --- a/specification/documentation/APIDescription.md +++ b/specification/documentation/APIDescription.md @@ -153,15 +153,15 @@ You'll then need to include this personalisation field in your request. ### Making your request to send messages from your software Use the following routing plan IDs and personalisation fields that match the message channel your user will send their message with. -| Message channel | Personalisation field | Routing plan ID | -|------------------------------------------|----------------------------------------|--------------------------------------| -| NHS App message | body | 00000000-0000-0000-0000-000000000001 | -| Email | email_subject, email_body | 00000000-0000-0000-0000-000000000002 | -| Text message | sms_body | 00000000-0000-0000-0000-000000000003 | -| NHS App message with a fallback to email | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 | -| NHS App message with a 4hr fallback to email | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000005 | -| NHS App message with a 24hr fallback to Text message | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000006 | -| NHS App message with a 4hr fallback to Text message | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000007 | +| Message channel | Read wait time (before failing channel) | Personalisation field | Routing plan ID | +|-------------------------------------------------------|------------------------------------------|----------------------------------------|--------------------------------------| +| NHS App message | 24 hours | body | 00000000-0000-0000-0000-000000000001 | +| Email | | email_subject, email_body | 00000000-0000-0000-0000-000000000002 | +| Text message | | sms_body | 00000000-0000-0000-0000-000000000003 | +| NHS App message with a fallback to Email | 24 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 | +| NHS App message with a fallback to Email | 4 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000005 | +| NHS App message with a fallback to Text message | 24 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000006 | +| NHS App message with a fallback to Text message | 4 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000007 | For email, use the personalisation field `email_subject` to allow your user to add the email subject line. From b9913807012ba5e4e19fd0f5b459847416d15949 Mon Sep 17 00:00:00 2001 From: "tom.droza2" Date: Thu, 6 Nov 2025 13:57:26 +0000 Subject: [PATCH 3/3] CCM-12832: Updates following review with content designer --- specification/documentation/APIDescription.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/specification/documentation/APIDescription.md b/specification/documentation/APIDescription.md index a8cee873e..5dc74a2ba 100644 --- a/specification/documentation/APIDescription.md +++ b/specification/documentation/APIDescription.md @@ -153,28 +153,28 @@ You'll then need to include this personalisation field in your request. ### Making your request to send messages from your software Use the following routing plan IDs and personalisation fields that match the message channel your user will send their message with. -| Message channel | Read wait time (before failing channel) | Personalisation field | Routing plan ID | -|-------------------------------------------------------|------------------------------------------|----------------------------------------|--------------------------------------| -| NHS App message | 24 hours | body | 00000000-0000-0000-0000-000000000001 | -| Email | | email_subject, email_body | 00000000-0000-0000-0000-000000000002 | -| Text message | | sms_body | 00000000-0000-0000-0000-000000000003 | -| NHS App message with a fallback to Email | 24 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 | -| NHS App message with a fallback to Email | 4 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000005 | -| NHS App message with a fallback to Text message | 24 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000006 | -| NHS App message with a fallback to Text message | 4 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000007 | +| Message channel | First message channel delivery failure time | Second message channel delivery failure time | Personalisation fields | Routing plan ID | +|-------------------------------------------------------|---------------------------------------------|----------------------------------------------|----------------------------------------|--------------------------------------| +| NHS App message | 24 hours | - | body | 00000000-0000-0000-0000-000000000001 | +| Email | 72 hours | - | email_subject, email_body | 00000000-0000-0000-0000-000000000002 | +| Text message | 72 hours | - | sms_body | 00000000-0000-0000-0000-000000000003 | +| NHS App message with a fallback to Email | 24 hours | 72 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 | +| NHS App message with a fallback to Email | 4 hours | 72 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000005 | +| NHS App message with a fallback to Text message | 24 hours | 72 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000006 | +| NHS App message with a fallback to Text message | 4 hours | 72 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000007 | For email, use the personalisation field `email_subject` to allow your user to add the email subject line. Complete your request in the same way you [send a single message](#post-/v1/messages) or [send a batch of messages](#post-/v1/message-batches). -When you make your request, we'll aim to deliver the message within: -* 24 hours for NHS App messages -* 72 hours for emails -* 72 hours for text messages +You can try out example requests in the sandbox environment in our [Postman collection](#overview--environments-and-testing). -Your message will have a 'failed' status if it's not delivered within this time. Find out more about [message, channel and supplier statuses](https://notify.nhs.uk/using-nhs-notify/message-channel-supplier-status). +### Delivery failure or fallback time +This is the maximum amount of time we'll attempt to deliver the message for each message channel in the routing plan before the message gets a 'failed' status. -You can try out example requests in the sandbox environment in our [Postman collection](#overview--environments-and-testing). +We'll then attempt to deliver the message using the second available message channel, if the routing plan includes one. + +Find out more about [message, channel and supplier statuses](https://notify.nhs.uk/using-nhs-notify/message-channel-supplier-status). ### Formatting messages written in your software You can use Markdown to add formatting that your users apply to NHS App messages and emails they write in your software.