Delivery Receipts Overview

1
/* Retrieving Delivery Receipts (aggregated and detailed) for rendering */
2

3
const aggregatedDeliveryReceipt = message.aggregatedDeliveryReceipt;
4

5
// get amount (DeliveryAmount) of participants with particular delivery status
6
const deliveredReceipts = aggregatedDeliveryReceipt?.delivered;
7
const failedReceipts = aggregatedDeliveryReceipt?.failed;
8
const readReceipts = aggregatedDeliveryReceipt?.read;
9
const sentReceipts = aggregatedDeliveryReceipt?.sent;
10
const undeliveredReceipts = aggregatedDeliveryReceipt?.undelivered;
11
// get the amount of participants which have the status for the message
12
const totalReceipts = aggregatedDeliveryReceipt?.total;
13

14
if (undeliveredReceipts !== "none") {
15
    // some delivery problems
16
    alert(`Out of ${totalReceipts} sent messages, ${deliveredReceipts} were delivered, ${failedReceipts} have failed.`);
17
}

1
// get the list of of delivery receipts
2
const detailedDeliveryReceipts = await message.getDetailedDeliveryReceipts();
3

4
const statusMap = {};
5

6
detailedDeliveryReceipts.map((detailedDeliveryReceipt) => {
7
    // get status of the delivery receipts
8
    const receiptStatus = detailedDeliveryReceipt.status;
9
    const participantSid = detailedDeliveryReceipt.participantSid;
10
    statusMap[participantSid] = receiptStatus;
11

12
});

1
/* Checking delivery receipts for errors */
2

3
// get the list of aggregated delivery receipts
4
const aggregatedDeliveryReceipt = message.aggregatedDeliveryReceipt;
5

6
// retrieve delivery receipt status
7
if (aggregatedDeliveryReceipt.failed !== "none" || aggregatedDeliveryReceipt.undelivered !== "none") {
8
    // handle error
9
}
10

11
// get the list of delivery receipts
12
const detailedDeliveryReceipts = await message.getDetailedDeliveryReceipts();
13

14
detailedDeliveryReceipts.map((detailedDeliveryReceipt) => {
15
    // check delivery receipt status
16
    if (!detailedDeliveryReceipt.status === "undelivered" && !detailedDeliveryReceipt.status === "failed") {
17
        return;
18
    }
19

20
    // handle error. the error codes page: https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors
21
    if (detailedDeliveryReceipt.errorCode === 30006) {
22
        alert("The destination number is unable to receive this message.");
23
        return;
24
    }
25

26
    if (detailedDeliveryReceipt.errorCode === 30007) {
27
        alert("Your message was flagged as objectionable by the carrier.");
28
    }
29
});