Skip to content

Commit 2a9dfd5

Browse files
committed
CCM-12832: Updates following review with content designer
1 parent 9b073cd commit 2a9dfd5

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

specification/documentation/APIDescription.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -153,28 +153,28 @@ You'll then need to include this personalisation field in your request.
153153
### Making your request to send messages from your software
154154
Use the following routing plan IDs and personalisation fields that match the message channel your user will send their message with.
155155

156-
| Message channel | Read wait time (before failing channel) | Personalisation field | Routing plan ID |
157-
|-------------------------------------------------------|------------------------------------------|----------------------------------------|--------------------------------------|
158-
| NHS App message | 24 hours | body | 00000000-0000-0000-0000-000000000001 |
159-
| Email | | email_subject, email_body | 00000000-0000-0000-0000-000000000002 |
160-
| Text message | | sms_body | 00000000-0000-0000-0000-000000000003 |
161-
| NHS App message with a fallback to Email | 24 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 |
162-
| NHS App message with a fallback to Email | 4 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000005 |
163-
| NHS App message with a fallback to Text message | 24 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000006 |
164-
| NHS App message with a fallback to Text message | 4 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000007 |
156+
| Message channel | First message channel delivery failure time | Second message channel delivery failure time | Personalisation fields | Routing plan ID |
157+
|-------------------------------------------------------|---------------------------------------------|----------------------------------------------|----------------------------------------|--------------------------------------|
158+
| NHS App message | 24 hours | - | body | 00000000-0000-0000-0000-000000000001 |
159+
| Email | 72 hours | - | email_subject, email_body | 00000000-0000-0000-0000-000000000002 |
160+
| Text message | 72 hours | - | sms_body | 00000000-0000-0000-0000-000000000003 |
161+
| NHS App message with a fallback to Email | 24 hours | 72 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000004 |
162+
| NHS App message with a fallback to Email | 4 hours | 72 hours | nhsapp_body, email_subject, email_body | 00000000-0000-0000-0000-000000000005 |
163+
| NHS App message with a fallback to Text message | 24 hours | 72 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000006 |
164+
| NHS App message with a fallback to Text message | 4 hours | 72 hours | nhsapp_body, sms_body | 00000000-0000-0000-0000-000000000007 |
165165

166166
For email, use the personalisation field `email_subject` to allow your user to add the email subject line.
167167

168168
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).
169169

170-
When you make your request, we'll aim to deliver the message within:
171-
* 24 hours for NHS App messages
172-
* 72 hours for emails
173-
* 72 hours for text messages
170+
You can try out example requests in the sandbox environment in our [Postman collection](#overview--environments-and-testing).
174171

175-
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).
172+
### Delivery failure or fallback time
173+
This is the maximum amount of time we'll attempt to deliver the message using the first (or only) message channel in the routing plan before the the message gets a 'failed' status.
176174

177-
You can try out example requests in the sandbox environment in our [Postman collection](#overview--environments-and-testing).
175+
We'll then attempt to deliver the message using the second available message channel, if the routing plan includes one.
176+
177+
Find out more about [message, channel and supplier statuses](https://notify.nhs.uk/using-nhs-notify/message-channel-supplier-status).
178178

179179
### Formatting messages written in your software
180180
You can use Markdown to add formatting that your users apply to NHS App messages and emails they write in your software.

0 commit comments

Comments
 (0)