Skip to main content
GET
Get lead SMS event details by event ID

Path Parameters

smsEventId
string
required

The ID of the SMS event to retrieve.

Response

Returns the sms event table row.

List item schema for Leadping API SMS event table row results shown in searchable tables.

id
string

Unique Leadping identifier for this SMS event table row.

conversationId
string | null

Conversation ID that links this SMS event table row to the Leadping inbox thread.

lead
object

The ID and name for this lead.

fromPhoneNumberId
string

Sender phone number ID used for this outbound SMS or call.

outboundPhoneNumberId
string

Phone number ID selected for outbound delivery.

fromPhoneNumber
string

Sender phone number used for this communication.

toPhoneNumber
string

Recipient phone number used for this communication.

text
string

Body text for the SMS message or communication represented by this SMS event table row.

status
enum<string> | null

Defines the supported SMS Message Status values.

Available options:
draft,
scheduled,
queued,
sending,
sent,
received,
delivered,
failed,
undeliverable,
opted_out,
blocked_compliance,
blocked_billing,
blocked_missing_campaign,
canceled
statusReason
string | null

Human-readable reason explaining the current status of this SMS event table row.

direction
string

Communication direction for this SMS event table row, such as inbound or outbound.

createdAt
string<date-time>

UTC timestamp when this SMS event table row was created.

queuedAt
string<date-time> | null

UTC timestamp when Leadping queued this SMS event table row for processing.

scheduledFor
string<date-time> | null

UTC timestamp when this SMS event is scheduled to send.

scheduledReason
string | null

Reason Leadping scheduled this delivery for a later time.

sendingStartedAt
string<date-time> | null

UTC timestamp when Leadping began sending this message.

sentAt
string<date-time> | null

UTC timestamp when Leadping sent this message to the provider.

deliveredAt
string<date-time> | null

UTC timestamp when the provider confirmed delivery.

failedAt
string<date-time> | null

UTC timestamp when processing failed for this SMS event table row.

undeliverableAt
string<date-time> | null

UTC timestamp when the provider marked the message undeliverable.

receivedAt
string<date-time> | null

UTC timestamp when Leadping received this inbound event or message.

blockedAt
string<date-time> | null

UTC timestamp when Leadping blocked this communication.

canceledAt
string<date-time> | null

UTC timestamp when this delivery or workflow was canceled.

cancelReason
string | null

Reason this delivery, run, or request was canceled.

errorCode
string | null

Machine-readable error code returned while processing this SMS event table row.

errorMessage
string | null

Human-readable error message returned while processing this SMS event table row.

isAutomated
boolean

Indicates whether automation created or triggered this SMS event table row.

outboundSource
enum<string> | null

Defines the source that requested outbound delivery.

Available options:
manual,
automation,
campaign,
import,
api,
system_notification,
warmup,
retry
trafficType
enum<string> | null

Defines the supported SMS Traffic Type values.

Available options:
RealLead,
Warmup,
Test,
SystemInternal,
FailedAttempt
billableAmount
string<double> | null

Monetary amount billed for this Leadping communication or transaction.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
billingStatus
string | null

Billing state for this communication, charge, or transaction.

complianceAction
string | null

Compliance action applied to this message, lead, or sender.

user
string

User summary connected to this SMS event table row.

actorUserId
string | null

User ID for the actor that performed the action.

actorDisplayName
string | null

Display name for the actor that performed the action.

userName
string | null

Display name for the user connected to this SMS event table row.

senderName
string | null

Display name for the sender of this message.

business
string

Business summary connected to this SMS event table row.

businessName
string | null

Business display name shown for this SMS event.