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

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

smsEventId
string
required

The ID of the SMS event to retrieve.

Response

Returns the SMS event table row.

Summarizes SMS event data in paginated and searchable results.

id
string

Unique Leadping identifier for this SMS event table row.

conversationId
null | string

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

lead
object

Provides a compact API reference to another resource using its stable identifier and human-readable display name.

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.

media
object[]

Media attached to this SMS/MMS event.

status
null | enum<string>

Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.

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

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
null | string<date-time>

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

scheduledFor
null | string<date-time>

UTC timestamp when this SMS event is scheduled to send.

scheduledReason
null | string

Reason Leadping scheduled this delivery for a later time.

sendingStartedAt
null | string<date-time>

UTC timestamp when Leadping began sending this message.

sentAt
null | string<date-time>

UTC timestamp when Leadping sent this message to the provider.

deliveredAt
null | string<date-time>

UTC timestamp when the provider confirmed delivery.

failedAt
null | string<date-time>

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

undeliverableAt
null | string<date-time>

UTC timestamp when the provider marked the message undeliverable.

receivedAt
null | string<date-time>

UTC timestamp when Leadping received this inbound event or message.

blockedAt
null | string<date-time>

UTC timestamp when Leadping blocked this communication.

canceledAt
null | string<date-time>

UTC timestamp when this delivery or workflow was canceled.

cancelReason
null | string

Reason this delivery, run, or request was canceled.

errorCode
null | string

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

errorMessage
null | string

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
null | enum<string>

Defines the source that requested outbound delivery.

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

Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.

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

Monetary amount billed for this Leadping communication or transaction.

billingStatus
null | string

Billing state for this communication, charge, or transaction.

complianceAction
null | string

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

consoleEntries
object[]

Ordered diagnostic entries recorded while Leadping processed this message.

user
string

User summary connected to this SMS event table row.

actorUserId
null | string

User ID for the actor that performed the action.

actorDisplayName
null | string

Display name for the actor that performed the action.

userName
null | string

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

senderName
null | string

Display name for the sender of this message.

organization
string

Organization summary connected to this SMS event table row.

organizationName
null | string

Organization display name shown for this SMS event.