> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # List SMS event history for a phone number > Lists SMS events for one phone number with paging, helping users review volume, delivery outcomes, and communication history. ## OpenAPI ````yaml /openapi.json post /events/sms/phone/{phoneNumber} openapi: 3.0.4 info: title: Leadping API description: >- Leadping API for lead intake, messaging, calling, automations, billing, business settings, and compliant lead communication workflows. license: name: MIT url: https://opensource.org/licenses/MIT version: v1 servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: Analytics - name: Automations - name: Contact - name: Conversations - name: Dispositions - name: Feedback - name: Leads - name: LeadStatuses - name: Notifications - name: OutboundDelivery - name: Sources - name: Suppressions - name: Tags - name: Users - name: Calls - name: PhoneNumbers - name: Sms - name: Telephony - name: UserDataExports - name: CallEvents - name: Events - name: SmsEvents - name: Businesses - name: PaymentMethods - name: Transactions - name: Usage - name: Wallets paths: /events/sms/phone/{phoneNumber}: post: tags: - SmsEvents summary: List SMS event history for a phone number description: >- Lists SMS events for one phone number with paging, helping users review volume, delivery outcomes, and communication history. operationId: SmsEvents_GetByPhoneNumber parameters: - name: phoneNumber in: path description: The phone number to search for. required: true schema: type: string requestBody: description: Pagination, filtering, and sorting options. content: application/json: schema: allOf: - $ref: '#/components/schemas/RequestDataOptions' description: >- Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories. application/*+json: schema: allOf: - $ref: '#/components/schemas/RequestDataOptions' description: >- Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories. required: true responses: '200': description: Returns the paged sms event table row. content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedResultOfSmsEventTableRow' description: >- A generic container for paginated results returned to the client. '400': description: The request was invalid or failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' components: schemas: RequestDataOptions: type: object properties: pageSize: pattern: ^-?(?:0|[1-9]\d*)$ description: Maximum items to return in one page format: int32 continuationToken: type: string description: >- Opaque Cosmos DB continuation token. ‑ on the **first** request. ‑ Client must echo back the NextToken it received from the previous page. nullable: true orderBy: type: array items: allOf: - $ref: '#/components/schemas/OrderByOption' description: An object for ordering during querying description: List of sort instructions, in priority order. nullable: true includeCount: type: boolean description: Whether to include the total count in the response (for pagination). nullable: true search: type: string description: The search term to filter results (applied to ). nullable: true searchFields: type: array items: type: string description: >- The list of fields to apply the Search term to (must be string properties). nullable: true filters: type: array items: allOf: - $ref: '#/components/schemas/ExactMatchFilter' description: >- A generic object for handling exact match filtering during querying description: Key-value exact match filters (e.g., Status = Active). nullable: true rangeFilters: type: array items: allOf: - $ref: '#/components/schemas/RangeFilter' description: A generic object for handling range filtering during querying description: Advanced range-based filters (e.g., Price > 50 and Price <= 200). nullable: true description: >- Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories. PagedResultOfSmsEventTableRow: type: object properties: items: type: array items: allOf: - $ref: '#/components/schemas/SmsEventTableRow' description: >- List item schema for Leadping API SMS event table row results shown in searchable tables. description: The subset of items returned for the current page. pageSize: pattern: ^-?(?:0|[1-9]\d*)$ description: >- The number of items returned per page in the response. This may reflect the client's requested page size, or a server-defined default or limit. format: int32 totalCount: pattern: ^-?(?:0|[1-9]\d*)$ description: >- The total number of items that match the query across all pages. May be null if the count is not computed or not applicable (e.g., in continuation-based pagination). format: int32 nullable: true continuationToken: type: string description: >- Opaque storage continuation token. ‑ `null` → the current page was the last page. nullable: true description: A generic container for paginated results returned to the client. ProblemDetails: type: object properties: type: type: string description: URI reference that identifies the problem type. nullable: true title: type: string description: Short, human-readable summary of the problem. nullable: true status: pattern: ^-?(?:0|[1-9]\d*)$ description: HTTP status code returned for the problem. format: int32 nullable: true detail: type: string description: >- Human-readable explanation specific to this occurrence of the problem. nullable: true instance: type: string description: >- URI reference that identifies this specific occurrence of the problem. nullable: true OrderByOption: type: object properties: field: type: string description: The field to sort by. direction: enum: - asc - desc type: string description: An enumerator for sort direction during querying nullable: true description: An object for ordering during querying ExactMatchFilter: type: object properties: value: description: The value that the field must match. field: type: string description: The field to filter by. description: A generic object for handling exact match filtering during querying RangeFilter: type: object properties: greaterThan: description: The exclusive lower bound for the field value. greaterThanOrEqual: description: The inclusive lower bound for the field value. lessThan: description: The exclusive upper bound for the field value. lessThanOrEqual: description: The inclusive upper bound for the field value. field: type: string description: The field to filter by. description: A generic object for handling range filtering during querying SmsEventTableRow: type: object properties: id: type: string description: Unique Leadping identifier for this SMS event table row. conversationId: type: string description: >- Conversation ID that links this SMS event table row to the Leadping inbox thread. nullable: true lead: allOf: - $ref: '#/components/schemas/IdNamePair' description: The ID and name for this lead. fromPhoneNumberId: type: string description: Sender phone number ID used for this outbound SMS or call. outboundPhoneNumberId: type: string description: Phone number ID selected for outbound delivery. fromPhoneNumber: type: string description: Sender phone number used for this communication. toPhoneNumber: type: string description: Recipient phone number used for this communication. text: type: string description: >- Body text for the SMS message or communication represented by this SMS event table row. status: enum: - draft - scheduled - queued - sending - sent - received - delivered - failed - undeliverable - opted_out - blocked_compliance - blocked_billing - blocked_missing_campaign - canceled type: string description: Defines the supported SMS Message Status values. nullable: true statusReason: type: string description: >- Human-readable reason explaining the current status of this SMS event table row. nullable: true direction: type: string description: >- Communication direction for this SMS event table row, such as inbound or outbound. createdAt: type: string description: UTC timestamp when this SMS event table row was created. format: date-time queuedAt: type: string description: >- UTC timestamp when Leadping queued this SMS event table row for processing. format: date-time nullable: true scheduledFor: type: string description: UTC timestamp when this SMS event is scheduled to send. format: date-time nullable: true scheduledReason: type: string description: Reason Leadping scheduled this delivery for a later time. nullable: true sendingStartedAt: type: string description: UTC timestamp when Leadping began sending this message. format: date-time nullable: true sentAt: type: string description: UTC timestamp when Leadping sent this message to the provider. format: date-time nullable: true deliveredAt: type: string description: UTC timestamp when the provider confirmed delivery. format: date-time nullable: true failedAt: type: string description: UTC timestamp when processing failed for this SMS event table row. format: date-time nullable: true undeliverableAt: type: string description: UTC timestamp when the provider marked the message undeliverable. format: date-time nullable: true receivedAt: type: string description: UTC timestamp when Leadping received this inbound event or message. format: date-time nullable: true blockedAt: type: string description: UTC timestamp when Leadping blocked this communication. format: date-time nullable: true canceledAt: type: string description: UTC timestamp when this delivery or workflow was canceled. format: date-time nullable: true cancelReason: type: string description: Reason this delivery, run, or request was canceled. nullable: true errorCode: type: string description: >- Machine-readable error code returned while processing this SMS event table row. nullable: true errorMessage: type: string description: >- Human-readable error message returned while processing this SMS event table row. nullable: true isAutomated: type: boolean description: >- Indicates whether automation created or triggered this SMS event table row. outboundSource: enum: - manual - automation - campaign - import - api - system_notification - warmup - retry type: string description: Defines the source that requested outbound delivery. nullable: true trafficType: enum: - RealLead - Warmup - Test - SystemInternal - FailedAttempt type: string description: Defines the supported SMS Traffic Type values. nullable: true billableAmount: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ description: >- Monetary amount billed for this Leadping communication or transaction. format: double nullable: true billingStatus: type: string description: Billing state for this communication, charge, or transaction. nullable: true complianceAction: type: string description: Compliance action applied to this message, lead, or sender. nullable: true user: type: string description: User summary connected to this SMS event table row. actorUserId: type: string description: User ID for the actor that performed the action. nullable: true actorDisplayName: type: string description: Display name for the actor that performed the action. nullable: true userName: type: string description: Display name for the user connected to this SMS event table row. nullable: true senderName: type: string description: Display name for the sender of this message. nullable: true business: type: string description: Business summary connected to this SMS event table row. businessName: type: string description: Business display name shown for this SMS event. nullable: true description: >- List item schema for Leadping API SMS event table row results shown in searchable tables. IdNamePair: required: - id - name type: object properties: id: type: string description: The unique identifier. name: type: string description: The display name. description: >- A minimal Record type with an (string), (string), and maximum JSON compatibility. The reason for this type (over something like KeyValuePair, dictionary) is because of JSON serialization support. ````