Inbound SMS Report
- 15 Jan 2025
- 1 Minute to read
- Print
- DarkLight
Inbound SMS Report
- Updated on 15 Jan 2025
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Inbound SMS Report
Purpose
A flat file report of inbound SMS messages over a period of time for a specific short code. This report is available in both Staging and Production Environments.
Included Events
Expected Frequency:
The default frequency is daily.
Clients may request the frequency be changed to weekly or monthly.
Monthly reports are generated on the first weekend of each month or the following weekend.
Standard Report File Properties: Text Message Received Events
Property | Data Type | Length | Primary Key | Description |
|---|---|---|---|---|
event_type | string | 255 | Yes | Identifies the main event type category. |
event_subtype | string | 255 | Yes | Identifies the subtype of the event. |
event_timestamp | string | Yes | Contains the date and time of when the event occurred. The data is in ISO 8601 format. | |
channel_type | string | 10 | No | Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification |
ccid | string | 50 | No | The unique identifier of the Customer. |
message_id | string | 255 | No | The unique, internal, identifier associated with the source notification. The value is optional and may be set to null. |
a2w_mo_ref_id | string | 20 | No | A unique system generated message ID used by the sms aggregator. |
carrier | string | 20 | No | The carrier associated with the mobile number (i.e., Verizon, T-mobile, and AT&T, etc.) |
short_code | string | 10 | No | Short code that Relay uses to send an SMS message to the customer. |
country_code | string | 3 | No | The country code associated with the mobile number. E.g. ‘1’ for US mobile numbers, ’44’ for UK, etc. |
phone_number | string | 10 | Yes | The phone number associated with the Customer or Patient expressed only using numeric values. |
message_text | string | 5000 | No | The SMS text sent by the customer to the Relay short code. |
response_text | string | 2000 | No | Automated SMS response that is sent from Relay systems in reply to inbound SMS, if any. |
response_time | string | 10 | No | Timestamp of the automated response sent in reply, if there was one. The data is in ISO 8601 format. |
Was this article helpful?