Get Messages List

GET 
/messages

Retrieve a list of paginated messages.

Request

Query Parameters

per_page integer

Number of items to be displayed per page.

page integer

Page number for the requested data set.

Responses

200

Messages list retrieved successfully.

application/json

Schema

Schema

status object

Object containing the status of the response.

message string

A message describing the status of the operation.

error_code integer

Http Error Code.

errors string[]

A list of error messages (empty for success).

current_page integer

The current page number of the requested data set.

per_page integer

The number of items to be displayed per page.

total integer

The total number of items in the entire data set.

messages object[]
Array [
id string
The id of the message.
dest_number string
The destination number of the message.
short_message string
The message content.
schedule_send_at date-time
The date and time when the message will be sent.
created_at date-time
The date and time when the message was created.
delivered_at date-time
The date and time when the message was delivered.
validity_period integer
The validity period of the message.
]

Example (from schema)

{
  "status": {
    "message": "Status Message",
    "error_code": 200,
    "errors": []
  },
  "current_page": 1,
  "per_page": 10,
  "total": 100,
  "messages": [
    {
      "id": "1",
      "dest_number": "628123456789",
      "short_message": "Test Message",
      "schedule_send_at": "2024-01-01 12:12:12",
      "created_at": "2024-01-01 12:12:12",
      "delivered_at": "2024-01-01 12:12:12",
      "validity_period": 60
    }
  ]
}

401

Unauthorized. Invalid token.

application/json

Schema

Schema

message string

A message describing the status of the operation.

error_code integer

Http Error Code.

errors string[]

A list of error messages (empty for success).

Example (from schema)

{
  "message": "Status Message",
  "error_code": 200,
  "errors": []
}

500

Internal Server Error.

application/json

Schema

Schema

message string

A message describing the status of the operation.

error_code integer

Http Error Code.

errors string[]

A list of error messages (empty for success).

Example (from schema)

{
  "message": "Status Message",
  "error_code": 200,
  "errors": []
}

Loading...