Skip to main content
POST
/
events
/
sms
/
all
/
my
Gets all SMS events for current user.
curl --request POST \
  --url https://api.leadping.ai/events/sms/all/my \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": "<string>",
  "continuationToken": "<string>",
  "orderBy": [
    {
      "field": "<string>"
    }
  ],
  "includeCount": true,
  "search": "<string>",
  "searchFields": [
    "<string>"
  ],
  "filters": [
    {
      "value": "<unknown>",
      "field": "<string>"
    }
  ],
  "rangeFilters": [
    {
      "greaterThan": "<unknown>",
      "greaterThanOrEqual": "<unknown>",
      "lessThan": "<unknown>",
      "lessThanOrEqual": "<unknown>",
      "field": "<string>"
    }
  ]
}
'
{
  "items": [
    {
      "id": "<string>",
      "telnyxId": "<string>",
      "providerMessageId": "<string>",
      "conversationId": "<string>",
      "leadId": "<string>",
      "fromPhoneNumberId": "<string>",
      "outboundPhoneNumberId": "<string>",
      "fromPhoneNumber": "<string>",
      "toPhoneNumber": "<string>",
      "text": "<string>",
      "statusReason": "<string>",
      "direction": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "queuedAt": "2023-11-07T05:31:56Z",
      "scheduledFor": "2023-11-07T05:31:56Z",
      "scheduledReason": "<string>",
      "sendingStartedAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "deliveredAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z",
      "undeliverableAt": "2023-11-07T05:31:56Z",
      "receivedAt": "2023-11-07T05:31:56Z",
      "blockedAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z",
      "cancelReason": "<string>",
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "isWarmup": true,
      "tenDlcCampaignId": "<string>",
      "billableAmount": "<string>",
      "billingStatus": "<string>",
      "complianceAction": "<string>",
      "user": "<string>",
      "business": "<string>"
    }
  ],
  "pageSize": "<string>",
  "totalCount": "<string>",
  "continuationToken": "<string>"
}

Body

Pagination, filtering, and sorting options.

pageSize
string<int32>
Pattern: ^-?(?:0|[1-9]\d*)$
continuationToken
string | null
orderBy
object[] | null
includeCount
boolean | null
search
string | null
searchFields
string[] | null
filters
object[] | null
rangeFilters
object[] | null

Response

SMS events were successfully retrieved.

items
object[]
pageSize
string<int32>
Pattern: ^-?(?:0|[1-9]\d*)$
totalCount
string<int32> | null
Pattern: ^-?(?:0|[1-9]\d*)$
continuationToken
string | null