Sign in

v2

latestOpenAPI 3.1.02026-07-2661920.3 KB
SMS Libraries and APIs

List SMS logs

List SMS logs for the team with optional filters and pagination.

get/sms/v1/sms/logs

Query parameters

direction'inbound' | 'outbound'
status'pending' | 'received' | 'delivered' | 'failed'
errorCode'validation_error' | 'phone_number_not_found' | 'credentials_error' | 'credentials_not_found' | 'send_failed' | 'rate_limit_error' | 'upstream_error' | 'encryption_error' | 'server_error' | 'phone_provider_not_supported'
phoneProvider'twilio' | 'telnyx' | 'vonage'
assistantIdstring nullable

Filter by assistant ID

campaignIdstring nullable

Filter by campaign ID

conversationIdstring nullable

Filter by conversation ID

userNumberstring nullable

Filter by user phone number

{
  "assistantId": "5eb7cf5a86d9755df3a6c593",
  "campaignId": "5eb7cf5a86d9755df3a6c593"
}
sizeinteger

Number of items per page

Number of items per page

pageinteger

Page number

Page number

searchstring nullable

Search keywords

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Example response

{
  "logs": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "phoneNumberId": "5eb7cf5a86d9755df3a6c593",
      "meta": {
        "assistantId": "5eb7cf5a86d9755df3a6c593",
        "workflowId": "5eb7cf5a86d9755df3a6c593",
        "campaignId": "5eb7cf5a86d9755df3a6c593"
      }
    }
  ]
}