SMS Detail Record Object

This section outlines the SMS Detail Record object. It displays detailed information for both sent and received SMS and MMS messages.

SMS Detail Record Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute	Data Type	Description
a2p_campaign read only	string	The external ID of the phone number 10DLC campaign assigned by the Campaign Registry.
date_changed read only	string	The date and time when the message was last changed.
date_insert read only	string	The date and time when the detail record was inserted to the database.
date_sent read only	string	The date and time when the message was actually sent.
date_start read only	string	The date and time of the message creation.
date_stop read only	string	The date and time of the message delivery (with any status).
delay_sent read only	integer	Delay between when the request is received and the message is actually sent measured in seconds.
direction read only	string	The direction of the message. Values accepted in this field are: any for both the received and sent messages. inbound for received messages. outbound for sent messages. undirected for the messages which direction could not be determined.
dr_sid read only	string	Secure ID of the message detail record.
mcc read only	integer	The mobile country code.
mcc_mnc_price read only	number	Price associated with the mobile country code (MCC) and mobile network code (MNC).
mcc_mnc_rate read only	number	Rate (cost per message) associated with the mobile country code (MCC) and mobile network code (MNC).
media_urls read only	array	The list of URLs for media resources, if type of message is set to mms.
message read only	string	The message body.
message_segments read only	integer	The quantity of 160-symbols segments of an sms message. Messages with type set to mms always consist of a single segment.
mnc read only	integer	The mobile network code.
number_billing read only	string	The subscriber's number in the E.164 format. It will coincide with (match??) the number_dst in case of the inbound direction, or with the number_src in case of outbound direction.
number_dst read only	string	The destination number in the E.164 format.
number_external read only	string	The non-subscriber's number in the E.164 format. It will coincide with (match??) the number_dst in case of the inbound direction, or with the number_src in case of outbound direction.
number_group_dst read only	array	Group of destination numbers. In the case of outbound direction these are the called party DIDs, and in the case of inbound direction these are the calling party DIDs.
number_src read only	string	The source number in the E.164 format.
p2p_nnid read only	string	The NetNumber ID associated with the phone number. This identifier represents the service provider that owns the SMS routing for this telephone number in the NetNumber registry.
partner_sid read only	string	The secure ID of the partner this message belongs to.
passthrough_price read only	number	The total passthrough cost for all message segments, calculated as: passthrough_price = passthrough_rate x message_segments.
passthrough_rate read only	number	The cost per message segment in USD charged for carrier pass-throughs.
price read only	number	The total cost in USD for all message segments, calculated as: price = rate x message_segments.
provider read only	string	Provider that is used to send the message.
rate read only	number	The rate (cost per message segment) that the system uses to calculate the price. Does not include passthrough_rate.
registration_type read only	string	The SMS registration type of the phone number (unregistered, a2p, p2p).
status read only	string	The status of the message. Values accepted in this field are: delivered for the outgoing messages that have been successfully delivered to the recipient. failed for the outgoing messages that failed for some reason. internal_error for the outgoing messages that encountered any type of internal system errors while being sent to the recipient. queued for the outgoing messages accepted by the system, but not yet sent. received for the incoming messages that are received by the rented DID. sending_failed for the outgoing messages that passed through either internal_error or sending_timed_out status. sending_timed_out for the outgoing messages that stuck at the queued status for a certain system-set timeout. sent for the outgoing messages that were sent to the recipient. timed_out for the outgoing messages that have been sent, but then stuck at the sent status for a certain system-set timeout. undelivered for the outgoing messages that passed through the sent status, but could not be delivered to the recipient for some reason (e.g., the destination number is unreachable).
type read only	string	The type of message. Values returned in this field are mms and sms. The default value is sms if both, the media_urls and group_recipients arrays, are empty. The value is mms if any or both of those arrays contain items.
user_data update	string	Some additional user-defined data added to the message. The field max length is 2000.
vendor_error_code read only	string	The error code returned by the underlying messaging vendor/platform, if applicable.
version read only	integer	The version of the detail record as it comes from the resource.

Sample SMS Detail Record object

{
    "a2p_campaign": null,
    "date_changed": "2025-04-14T10:32:18.175Z",  
    "date_insert": "2025-04-14T10:32:17.279Z",
    "date_sent": "2025-04-14T10:32:17.997Z",
    "date_start": "2025-04-14T10:32:17.279Z",
    "date_stop": "2025-04-14T10:32:00.000Z",
    "delay_sent": 0,
    "direction": "outbound",
    "dr_sid": "92cd9154-2f53-4e62-8b4e-8ff6e4849d16",
    "mcc": 310,
    "mcc_mnc_price": "0.015",
    "mcc_mnc_rate": "0.005",
    "media_urls": [
        "https://storage.carrierx.com/f/cdac0471-f144-42a2-94f8-d9838ce5e4b9"
    ],
    "message": null,
    "message_segments": 1,
    "mnc": 999,
    "number_billing": "12078152557",
    "number_dst": "17575000929",
    "number_external": "17575000929",
    "number_group_dst": [
        "17207217011",
        "17207210038",
        "17575000929"
    ],
    "number_src": "12078152557",
    "p2p_nnid": null,
    "partner_sid": "8d180104-0b34-4e55-907f-4a72409484c9",
    "passthrough_price": null,
    "passthrough_rate": null,
    "price": "0.015",
    "provider": "tsg",
    "rate": "0.005",
    "registration_type": null,
    "status": "sent",
    "type": "mms",
    "user_data": "test_message",
    "vendor_error_code": "503",
    "version": null
}