SmsEvents

Get lead SMS event details by event ID

Returns one SMS event, including message metadata, provider status, related lead, and delivery context.

get/events/sms/{smsEventId}

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/events/sms/{smsEventId}
  • Auth: HTTP bearer

Path parameters

smsEventIdstring required

The ID of the SMS event to retrieve.

Response

Returns the SMS event table row.

isDemoboolean
idstring

Unique Leadping identifier for this SMS event table row.

conversationIdstring nullable

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

fromPhoneNumberIdstring

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

outboundPhoneNumberIdstring

Phone number ID selected for outbound delivery.

fromPhoneNumberstring

Sender phone number used for this communication.

toPhoneNumberstring

Recipient phone number used for this communication.

textstring

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

status'draft' | 'scheduled' | 'queued' | 'sending' | 'sent' | 'received' | 'delivered' | 'failed' | 'undeliverable' | 'opted_out' | 'blocked_compliance' | 'blocked_billing' | 'blocked_missing_campaign' | 'canceled' nullable

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

statusReasonstring nullable

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

directionstring

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

createdAtstring date-time

UTC timestamp when this SMS event table row was created.

queuedAtstring date-time nullable

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

scheduledForstring date-time nullable

UTC timestamp when this SMS event is scheduled to send.

scheduledReasonstring nullable

Reason Leadping scheduled this delivery for a later time.

sendingStartedAtstring date-time nullable

UTC timestamp when Leadping began sending this message.

sentAtstring date-time nullable

UTC timestamp when Leadping sent this message to the provider.

deliveredAtstring date-time nullable

UTC timestamp when the provider confirmed delivery.

failedAtstring date-time nullable

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

undeliverableAtstring date-time nullable

UTC timestamp when the provider marked the message undeliverable.

receivedAtstring date-time nullable

UTC timestamp when Leadping received this inbound event or message.

blockedAtstring date-time nullable

UTC timestamp when Leadping blocked this communication.

canceledAtstring date-time nullable

UTC timestamp when this delivery or workflow was canceled.

cancelReasonstring nullable

Reason this delivery, run, or request was canceled.

errorCodestring nullable

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

errorMessagestring nullable

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

isAutomatedboolean

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

outboundSource'manual' | 'automation' | 'campaign' | 'import' | 'api' | 'system_notification' | 'warmup' | 'retry' nullable

Defines the source that requested outbound delivery.

trafficType'RealLead' | 'Warmup' | 'Test' | 'SystemInternal' | 'FailedAttempt' nullable

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

billableAmountnumber double nullable

Monetary amount billed for this Leadping communication or transaction.

billingStatusstring nullable

Billing state for this communication, charge, or transaction.

complianceActionstring nullable

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

userstring

User summary connected to this SMS event table row.

actorUserIdstring nullable

User ID for the actor that performed the action.

actorDisplayNamestring nullable

Display name for the actor that performed the action.

userNamestring nullable

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

senderNamestring nullable

Display name for the sender of this message.

organizationstring

Organization summary connected to this SMS event table row.

organizationNamestring nullable

Organization display name shown for this SMS event.

Changes

No recorded changes to this operation across all 1 revision of this API.