Format statuses as a table

Format statuses as a table
This commit is contained in:
karlchillmaid
2019-04-05 12:23:40 +01:00
committed by Chris Hill-Scott
parent 4827c7f4ba
commit 574f7bb149

View File

@@ -19,7 +19,6 @@
<p>Notifys real-time dashboard lets you check the status of any message, to see when it was delivered. You can use our API to check the status of your messages too.</p>
<p>For security, this information is only available for X days after a message has been sent. You can download a list of sent messages for your own records.</p>
<p><a href="https://www.notifications.service.gov.uk/documentation">Read our documentation</a> for a detailed list of API message statuses.</p>
<img
src="{{ asset_url('images/message-sending-flow.svg') }}"
alt="A picture of the sending flow of messages in Notify, showing the three states of Sending, Delivered, And Failed. Also shows the next
@@ -27,36 +26,56 @@
temporary failures"
style="width: 100%;"
>
<h2 id="messagestatus" class="heading-medium">Message status emails and text messages</h2>
<h3 class="heading-small">Sending</h3>
<p>GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient. GOV.UK Notify is waiting for delivery information.</p>
<h3 class="heading-small">Sent internationally (text messages only)</h3>
<p>The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information.</p>
<h3 class="heading-small">Delivered</h3>
<p>The message was successfully delivered.</p>
<p>Notify will not tell you if a user has opened or read a message.</p>
<h3 class="heading-small" id="does-not-exist">Phone number or email address does not exist</h3>
<p>The provider could not deliver the message because the email address or phone number was wrong.
<p>You should remove these email addresses or phone numbers from your database.</p>
<p>Youll still be charged for text messages to numbers that do not exist.</p>
<h3 class="heading-small" id="not-accepting-messages">Inbox or phone not accepting messages right now</h3>
<p>The provider could not deliver the message after trying for 72 hours.</p>
<p>This can happen when the recipients inbox is full or their phone is off.</p>
<p>You can try to send the message again.</p>
<p>Youll still be charged for text messages to phones that are not accepting messages.</p>
<h3 class="heading-small" id="technical-failure">Technical failure</h3>
<p>Your message was not sent because there was a problem between Notify and the provider.</p>
<p>Youll have to try sending your messages again.</p>
<p>You will not be charged for text messages that are affected by a technical failure.</p>
<h2 id="messagestatus" class="heading-medium">Message states youll see in Notify</h2>
<h3 class="heading-small">Emails and text messages</h3>
<div class="bottom-gutter-3-2">
{% call mapping_table(
caption='Message statuses email and text message',
field_headings=['Status', 'Description'],
field_headings_visible=True,
caption_visible=False
) %}
{% for message_length, charge in [
('Sending', 'GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient. GOV.UK Notify is waiting for delivery information.'),
('Sent internationally (text messages only)', 'The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information.'),
('Delivered', 'The message was successfully delivered. Notify will not tell you if a user has opened or read a message.'),
('Phone number or email address does not exist', 'The provider could not deliver the message because the email address or phone number was wrong. You should remove these email addresses or phone numbers from your database. Youll still be charged for text messages to numbers that do not exist.'),
('Inbox or phone not accepting messages right now', 'The provider could not deliver the message after trying for 72 hours. This can happen when the recipients inbox is full or their phone is off. You can try to send the message again. Youll 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. Youll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure.'),
] %}
{% call row() %}
{{ text_field(message_length) }}
{{ text_field(charge) }}
{% endcall %}
{% endfor %}
{% endcall %}
</div>
<h2 class="heading-medium">Message status letters</h2>
<h3 class="heading-small">Sent</h3>
<p>GOV.UK Notify has sent the letter to the provider to be printed.</p>
<h3 class="heading-small">Cancelled</h3>
<p>Sending cancelled. Your letter will not be printed or dispatched.</p>
<h3 class="heading-small">Technical failure</h3>
<p>GOV.UK Notify had an unexpected error while sending to our printing provider.</p>
<h3 class="heading-small"></h3>
<div class="bottom-gutter-3-2">
{% call mapping_table(
caption='Letters',
field_headings=['Status', 'Description'],
field_headings_visible=True,
caption_visible=False
) %}
{% for message_length, charge in [
('Sent', 'GOV.UK Notify has sent the letter to the provider to be printed.'),
('Cancelled', 'Sending cancelled. Your letter will not be printed or dispatched.'),
('Technical failure', 'GOV.UK Notify had an unexpected error while sending to our printing provider.'),
] %}
{% call row() %}
{{ text_field(message_length) }}
{{ text_field(charge) }}
{% endcall %}
{% endfor %}
{% endcall %}
</div>
<p><a href="https://www.notifications.service.gov.uk/documentation">Read our documentation</a> for a detailed list of API message statuses.</p>
</div>
</div>