Skip to content

Commit 9378e54

Browse files
jakecosgrovejakecosgrove
authored
Merge pull request #9 from NHSDigital/message-status-content
Message and channel status page + other edits
2 parents fab3891 + dc21528 commit 9378e54

File tree

3 files changed

+141
-10
lines changed

3 files changed

+141
-10
lines changed

‎docs/pages/using-nhs-notify/mesh.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ section: Accessing NHS Notify
1212

1313
NHS England organisations and services can use the [Message Exchange for Social care and Health (MESH)](https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh) to send messages with NHS Notify.
1414

15-
You should only use MESH to send messages if your organisation or service does not:
15+
You should only use MESH to send messages if your organisation or service:
1616

17-
- have a developer
18-
- need the features offered by our API
17+
- has limited developer or technical capacity
18+
- only needs to send batches of messages to specific groups of recipients
19+
- does not need advanced features offered by NHS Notify API
1920

2021
Check if MESH is right for you by contacting our engagement team at <[email protected]>.

‎docs/pages/using-nhs-notify/message-status.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Message and channel status
7+
parent: Using NHS Notify
8+
nav_order: 7
9+
permalink: /using-nhs-notify/message-and-channel-status
10+
section: Sending a message
11+
---
12+
13+
You can find out what's happened to your messages and channels by checking the message or channel status.
14+
15+
To get an overall status of a message you've sent using a routing plan, use the [message status](#message-status).
16+
17+
To see the status of a specific channel in your routing plan, use the [channel status](#channel-status).
18+
19+
{% include components/details.html
20+
heading='If you’re using NHS Notify API'
21+
text='
22+
23+
Check the status of a single message or channel by using the [get message status endpoint](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#get-/v1/messages/-messageId-).
24+
25+
To check the status of multiple messages automatically, use [message status callbacks](https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/%3Cclient-provided-message-status-URI%3E).'
26+
%}
27+
28+
{% include components/details.html
29+
heading='If you’re using NHS Notify MESH'
30+
text='
31+
32+
You’ll receive a daily report of messages and channels that have completed that day.'
33+
34+
%}
35+
36+
## Message status
37+
38+
| Status | Description |
39+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------- |
40+
| created | The message has been created but has not been processed by NHS Notify. |
41+
| pending_enrichment | NHS Notify is waiting to check and improve the recipient's contact details using the Personal Demographics Service (PDS). |
42+
| enriched | NHS Notify has found the recipient's contact details. |
43+
| sending | The message is in the process of being sent. |
44+
| delivered | The message has been successfully delivered. |
45+
| failed | We have failed to deliver the message. |
46+
47+
### Failed messages
48+
49+
Messages and channels that have not reached a recipient will have a 'failed' status with one of the following descriptions:
50+
51+
| Failed message status descriptions |
52+
| -------------------------------------------------------------------------------- |
53+
| The provider could not deliver the message. |
54+
| There was an unexpected error while sending the letter to our printing provider. |
55+
| PDS - patient record invalidated. |
56+
| PDS response date of birth does not match given date of birth. |
57+
| PDS - patient is formally dead. |
58+
| PDS - patient is informally dead. |
59+
| PDS - patient has an exit code. |
60+
| PDS - contact detail is malformed. |
61+
| PDS - patient does not exist. |
62+
63+
## Channel status
64+
65+
There are specific statuses for each message channel:
66+
67+
- [NHS App status descriptions](#nhs-app-message-status-descriptions) <!-- markdownlint-disable-line -->
68+
- [Email status descriptions](#email-status-descriptions)
69+
- [Text message status descriptions](#text-message-status-descriptions)
70+
- [Letter status descriptions](#letter-status-descriptions)
71+
72+
### NHS App message status descriptions
73+
74+
| Status | Description |
75+
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
76+
| received | The supplier received the request to send an NHS App message. |
77+
| created | The NHS App message has been created. |
78+
| skipped | The NHS App message has been skipped. |
79+
| sending | The NHS App message is in the process of being sent. |
80+
| delivered | The NHS App message was successfully delivered. |
81+
| read | The recipient has opened the NHS App message. |
82+
| notified | A push notification was sent and displayed on the recipient's device. |
83+
| notification attempted | A push notification has been sent to the recipient's device but we cannot confirm if the notification was received or displayed. |
84+
| unnotified | A push notification was not sent or displayed on the recipient's device. |
85+
| rejected | The supplier rejected the request to send the NHS App message. |
86+
| failed | [Read more about failed messages descriptions](#failed-messages). |
87+
88+
### Email status descriptions
89+
90+
| Status | Description |
91+
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
92+
| created | The email has been created. |
93+
| skipped | The email has been skipped. |
94+
| sending | The email is in the process of being sent. |
95+
| delivered | The email was successfully delivered. |
96+
| failed | [Read more about failed messages descriptions](#failed-messages). |
97+
| permanent_failure | The provider could not deliver the message because the email address was wrong. |
98+
| 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. |
99+
| technical_failure | Your message was not sent because there was a problem between NHS Notify and the provider. |
100+
101+
### Text message status descriptions
102+
103+
| Status | Description |
104+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
105+
| created | The text message has been created. |
106+
| skipped | The text message has been skipped. |
107+
| sending | The text message is in the process of being sent. |
108+
| delivered | The text message was successfully delivered. |
109+
| failed | [Read more about failed messages descriptions](#failed-messages). |
110+
| 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. |
111+
| 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. |
112+
| technical_failure | Your message was not sent because there was a problem between NHS Notify and the provider. You will not be charged for text messages that are affected by a technical failure. |
113+
114+
### Letter status descriptions
115+
116+
| Status | Description |
117+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
118+
| created | The letter has been created. |
119+
| accepted | NHS Notify has sent the letter to the provider to be printed. |
120+
| skipped | The letter has been skipped. |
121+
| sending | The letter is in the process of being sent. |
122+
| received | The provider has printed and dispatched the letter. |
123+
| delivered | The letter was successfully delivered. |
124+
| pending_virus_check | The provider has not yet completed a virus scan of the letter. |
125+
| cancelled | Sending cancelled. The letter will not be printed or dispatched. |
126+
| failed | [Read more about failed messages descriptions](#failed-messages). |
127+
| virus_scan_failed | The provider has found a potential virus in the precompiled letter file. |
128+
| validation_failed | Content in the letter file is outside the printable area. |
129+
| technical_failure | NHS Notify had an unexpected error while sending the letter to our printing provider. You will not be charged for letters that are affected by a technical failure. |
130+
| permanent_failure | The provider cannot print the letter. Your letter will not be dispatched. |

‎docs/pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,27 @@ It’s important that your recipients know and trust who has sent them a message
1414

1515
You can change the:
1616

17-
- [NHS App sender ID](#nhs-app-sender-id)<!-- markdownlint-disable-line -->
18-
- [text message sender ID](#text-message-sender-id)
17+
- [NHS App sender name](#nhs-app-sender-name)<!-- markdownlint-disable-line -->
18+
- [text message sender name](#text-message-sender-name)
1919
- [reply-to email address](#reply-to-email-address)
2020

2121
## Return addresses
2222

2323
You cannot change the return addresses of letters. These are set by NHS Notify’s suppliers and are printed on the envelopes.
2424

25-
## NHS App sender ID
25+
## NHS App sender name
2626

27-
The NHS App uses your service or organisation’s ODS code to set up your NHS App message sender ID.
27+
The NHS App uses your service or organisation’s ODS code to set up your NHS App message sender name.
2828

2929
NHS Notify will ask you for your ODS code during onboarding.
3030

3131
Find your ODS code with the [ODS Portal](https://odsportal.digital.nhs.uk/).
3232

33-
## Text message sender ID
33+
## Text message sender name
3434

35-
You can set your text message sender ID during onboarding.
35+
You can set your text message sender name during onboarding.
3636

37-
If you need to set up a different text message sender ID for another batch of messages, contact our onboarding team.
37+
If you need to set up a different text message sender name for another batch of messages, contact our onboarding team.
3838

3939
## Reply-to email address
4040

0 commit comments

Comments
 (0)