SmsPaginatedListResponse

Successful response with a page of Sms

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data object[]required

Items of the page: an empty list beyond the last page

Array [

idintegerrequired

qualitystringrequired

Delivery quality: STANDARD or PREMIUM

statusstringrequired

Status of the sending: DRAFT (not confirmed), PROCESSING (being sent), ACCOMPLISHED (all the messages sent) or CANCELLED (sending stopped)

senderstring | nullnullablerequired

Sender name, for the PREMIUM quality

messagestring | nullnullablerequired

send_fromdate-timenullablerequired

Date and time from which the messages are sent

date_approveddate-timenullablerequired

Date and time the sending was confirmed; null for a DRAFT

stop_datedate-timenullablerequired

Date and time the sending was stopped; null if it was not

sms_countinteger | nullnullablerequired

Number of SMS the message takes for each recipient: a long text is split into several SMS

date_createddate-timerequired

]

meta objectrequired

Pagination of the list

totalintegerrequired

Number of items in the whole list

countintegerrequired

Number of items in this page: 0 beyond the last page

pagesintegerrequired

Number of pages of the list

pageintegerrequired

Number of this page, starting from 1

per_pageintegerrequired

Maximum number of items in a page

SmsPaginatedListResponse

{
  "error": 0,
  "message": "string",
  "data": [
    {
      "id": 0,
      "quality": "string",
      "status": "string",
      "sender": "string",
      "message": "string",
      "send_from": "2024-07-29T15:51:28.071Z",
      "date_approved": "2024-07-29T15:51:28.071Z",
      "stop_date": "2024-07-29T15:51:28.071Z",
      "sms_count": 0,
      "date_created": "2024-07-29T15:51:28.071Z"
    }
  ],
  "meta": {
    "total": 0,
    "count": 0,
    "pages": 0,
    "page": 0,
    "per_page": 0
  }
}