Example AWS End User Messaging SMS event data

Focus mode

Example AWS End User Messaging SMS event data - AWS End User Messaging SMS

SMS example log Voice example event log MMS example log

AWS End User Messaging SMS can stream event data about SMS, MMS, and voice message deliveries. Events generated by carriers can take up to 72 hours to be received and should not be used to determine if there is a delay in outbound message delivery. After 72 hours, if AWS End User Messaging SMS has not received a final event from a carrier, the service will automatically return an UNKNOWN messageStatus as we do not know what happened to that message.

SMS example log

The JSON object for an SMS event contains the data shown in the following example.



{
    "eventType": "TEXT_SUCCESSFUL",
    "eventVersion": "1.0",
    "eventTimestamp": 1686975103470,
    "isFinal": true,
    "originationPhoneNumber": "+12065550152",
    "destinationPhoneNumber": "+14255550156",
    "isoCountryCode": "US",
    "mcc": "310",
    "mnc": "800",
    "messageId": "862a8790-60c0-4430-9b2b-658bdexample",
    "messageRequestTimestamp": 1686975103170,
    "messageEncoding": "GSM",
    "messageType": "PROMOTIONAL",
    "messageStatus": "SUCCESSFUL",
    "messageStatusDescription": "Message has been accepted by phone carrier",
    "context": {
        "account": "bar"
    },
    "totalMessageParts": 1,
    "totalMessagePrice": 0.09582,
    "totalCarrierFee": 0.0
}

Attribute	Description
`eventType`	The type of event. Values are listed in Event types for SMS, MMS, and voice
`eventVersion`	The version of the event JSON schema.
`eventTimestamp`	The time when the event was reported, shown as Unix time in milliseconds.
`isFinal`	`True` if this is the final status for the message. There are intermediate message statuses and it can take up to 72 hours for the final message status to be received.
`originationPhoneNumber`	The phone number that the message was sent from.
`destinationPhoneNumber`	The phone number that you attempted to send the message to.
`isoCountryCode`	The country that's associated with the recipient's phone number, shown in ISO 3166-1 alpha-2 format.
`mcc`	Mobile Country Codes identifies the country which a phone number belongs to. This field is optional and may not be present.
`mnc`	Mobile Network Codes identifies a mobile network operator. This field is optional and may not be present.
`messageId`	The unique ID that AWS End User Messaging SMS generates when it accepts the message.
`messageRequestTimestamp`	The time when the SMS message request was received, shown as Unix time in milliseconds.
`messageEncoding`	The encoding of the message. Possible values are GSM and Unicode. For more information on message encoding, see SMS character limits.
`messageType`	The type of message. Possible values are Promotional and Transactional.
`messageStatus`	The status of the message. Possible values are: SUCCESSFUL – The message has been accepted by the phone carrier. DELIVERED – The message has been accepted by the recipient's device. PENDING – The message hasn't yet been delivered to the recipient's device. INVALID – The destination phone number is invalid. UNREACHABLE – The recipient's device is currently unreachable or unavailable. For example, the device might be powered off, or might be disconnected from the network. You can try to send the message again later. UNKNOWN – An error occurred that prevented the delivery of the message. This error is usually transient, and you can attempt to send the message again later. BLOCKED – The recipient's device is blocking SMS messages from the originator phone number. CARRIER_UNREACHABLE – An issue with the mobile network of the recipient prevented the message from being delivered. This error is usually transient, and you can attempt to send the message again later. SPAM – The recipient's mobile carrier identified the contents of the message as spam and blocked delivery of the message. INVALID_MESSAGE – The body of the SMS message is invalid and can't be delivered. CARRIER_BLOCKED – The recipient's carrier has blocked delivery of this message. This often occurs when the carrier identifies the contents of the message as unsolicited or malicious. TTL_EXPIRED – The SMS message couldn't be delivered within a certain time frame. This error is usually transient, and you can attempt to send the message again later. ACCEPTED – The SMS message was accepted. FAILED – The SMS message failed to be delivered to the recipient's device. SENT – The message has been sent but not delivered to the recipient's device. UNROUTABLE – Not able to route due to a bad account configuration. QUEUED – The message is queued for delivery
`messageStatusDescription`	A description of the message status.
`context`	Custom attributes you can specify and will be logged, when you send a message.
`totalMessageParts`	The number of message parts that AWS End User Messaging SMS created in order to send the message. Generally, SMS messages can contain only 160 GSM-7 characters or 67 non-GSM characters, although these limits can vary by country . If you send a message that exceeds these limits, AWS End User Messaging SMS automatically splits the message into smaller parts. We bill you based on the number of message parts that you send. For more information on message parts, see What are the Message Parts per Second (MPS) limits.
`totalMessagePrice`	The amount that we charged you to send the message. This price is shown in thousandths of a United States cent. For example, if the value of this attribute is `645`, then we charged you 0.645¢ to send the message (645 / 1000 = 0.645¢ = $0.00645).
`totalCarrierFee`	The total cost of carrier fees for a message.

Voice example event log

The JSON object for a Voice event contains the data shown in the following example.



{
    "eventType": "VOICE_COMPLETED",
    "eventVersion": "1.0",
    "eventTimestamp": 1697835373500,
    "isFinal": true,
    "originationPhoneNumber": "+12065550153",
    "destinationPhoneNumber": "+14255550159",
    "isoCountryCode": "US",
    "messageId": "567f6c11-6e8b-4352-9749-a42a0example",
    "messageRequestTimestamp": 1697835372720,
    "messageStatus": "COMPLETED",
    "callDurationInSeconds": 60,
    "totalDurationInMinutes": 1,
    "totalMessagePrice": 0.013,
    "context": {
        "account": "bar"
    }
}

Attribute	Description
`eventType`	The type of event. Values are listed in Event types for SMS, MMS, and voice
`eventVersion`	The version of the event JSON schema.
`eventTimestamp`	The time when the event was reported, shown as Unix time in milliseconds.
`isFinal`	`True` if this is the final status for the message. There are intermediate message statuses.
`originationPhoneNumber`	The phone number that the message was sent from.
`destinationPhoneNumber`	The phone number that you attempted to send the message to.
`isoCountryCode`	The country that's associated with the recipient's phone number, shown in ISO 3166-1 alpha-2 format.
`messageId`	The unique ID that AWS End User Messaging SMS generates when it accepts the message.
`messageRequestTimestamp`	The time when the SMS message request was received, shown as Unix time in milliseconds.
`messageStatus`	The status of the message. Possible values are: INITIATED – The voice message is ready to start dialing. RINGING – Ringing events occur after the call has been placed, but before the recipient answers. COMPLETED – Sends all completed events for voice messages to the specified destination. Completed events occur when the audio message is played to the recipient. This status doesn't necessarily mean that the message was delivered to a human recipient. For example, it could indicate that the message was delivered to a voicemail system. ANSWERED – Answered events occur when the recipient answers the phone. COMPLETED – The call was answered and ended. BUSY – Busy events occur when the recipient's phone line is busy. NO_ANSWER – No answer events occur after the call has been placed, but the recipient (or their voicemail system) never answer. FAILED – Failure events occur when the message fails to be delivered. TTL_EXPIRED – TTL Expired events occur when the time required to deliver the message exceeds the `TTL` value that you specified when you sent the message. SPAM – The call was marked as spam and blocked.
`callDurationInSeconds`	The duration of the call in seconds.
`totalDurationInMinutes`	The duration of the call in minutes.
`totalMessagePrice`	The amount that we charged you to send the voice message. This price is shown in thousandths of a United States cent.
`context`	Custom attributes you can specify and will be logged, when you send a message.

MMS example log

The JSON object for an MMS event contains the data shown in the following example.


{
    "contentType":"MMS",
    "eventType": "MEDIA_DELIVERED",
    "eventVersion": "1.0",
    "eventTimestamp": 1635197695208,
    "isFinal": true,
    "originationPhoneNumber": "+12065550153",
    "destinationPhoneNumber": "+14255550159",
    "isoCountryCode": "US",
    "messageId": "b4a3196d-5b61-4884-a0d9-745acf1f6235example",
    "messageRequestTimestamp": 1635197693241,
    "messageType": "TRANSACTIONAL",
    "messageStatus": "DELIVERED",
    "messageStatusDescription": "Message has been accepted by phone",
    "context": {"foo":"bar"},
    "totalMessageParts": 1,
    "totalMessagePrice": 0.0195,
    "totalCarrierFee": 0.00266
}

Attribute	Description
`eventType`	The type of event. Values are listed in Event types for SMS, MMS, and voice
`eventVersion`	The version of the event JSON schema.
`eventTimestamp`	The time when the event was reported, shown as Unix time in milliseconds.
`isFinal`	`True` if this is the final status for the message. There are intermediate message statuses and it can take up to 72 hours for the final message status to be received.
`originationPhoneNumber`	The phone number that the message was sent from.
`destinationPhoneNumber`	The phone number that you attempted to send the message to.
`isoCountryCode`	The country that's associated with the recipient's phone number, shown in ISO 3166-1 alpha-2 format.
`messageId`	The unique ID that AWS End User Messaging SMS generates when it accepts the message.
`messageRequestTimestamp`	The time when the SMS message request was received, shown as Unix time in milliseconds.
`messageType`	The type of message. Possible values are Promotional and Transactional.
`messageStatus`	The status of the message. Possible values are: SUCCESSFUL – The message has been accepted by the phone carrier. DELIVERED – The message has been accepted by the recipient's device. PENDING – The message hasn't yet been delivered to the recipient's device. INVALID – The destination phone number is invalid. UNREACHABLE – The recipient's device is currently unreachable or unavailable. For example, the device might be powered off, or might be disconnected from the network. You can try to send the message again later. UNKNOWN – An error occurred that prevented the delivery of the message. This error is usually transient, and you can attempt to send the message again later. BLOCKED – The recipient's device is blocking SMS/MMS messages from the originator phone number. CARRIER_UNREACHABLE – An issue with the mobile network of the recipient prevented the message from being delivered. This error is usually transient, and you can attempt to send the message again later. SPAM – The recipient's mobile carrier identified the contents of the message as spam and blocked delivery of the message. INVALID_MESSAGE – The body of the SMS/MMS message is invalid and can't be delivered. CARRIER_BLOCKED – The recipient's carrier has blocked delivery of this message. This often occurs when the carrier identifies the contents of the message as unsolicited or malicious. TTL_EXPIRED – The SMS message couldn't be delivered within a certain time frame. This error is usually transient, and you can attempt to send the message again later. ACCEPTED – The SMS message was accepted. FAILED – The SMS message failed to be delivered to the recipient's device. SENT – The message has been sent but not delivered to the recipient's device. UNROUTABLE – Not able to route due to a bad account configuration. QUEUED – The message is queued for delivery
`messageStatusDescription`	A description of the message status.
`context`	Custom attributes you can specify and will be logged, when you send a message.
`totalMessageParts`	The number of message parts that AWS End User Messaging SMS created in order to send the message. For more information on message parts, see What are the Message Parts per Second (MPS) limits.
`totalMessagePrice`	The amount that we charged you to send the message. This price is shown in thousandths of a United States cent. For example, if the value of this attribute is `645`, then we charged you 0.645¢ to send the message (645 / 1000 = 0.645¢ = $0.00645).
`totalCarrierFee`	The total cost of carrier fees for a message.

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Event types

Set up Amazon CloudWatch event destination

Select your cookie preferences

Customize cookie preferences

Essential

Performance

Functional

Advertising

Unable to save cookie preferences

Example AWS End User Messaging SMS event data

SMS example log

Voice example event log

MMS example log

On this page

Did this page help you?

Next topic:

Previous topic:

Need help?