Get Message by ID

GET 
/messages/:id

Retrieve details of a specific message by providing its ID.

Request

Path Parameters

id stringrequired

The ID of the message to retrieve.

Responses

200

Message retrieved successfully.

application/json

Schema

Schema

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)

{
  "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": []
}

403

Forbidden. User is not authorized to access the message.

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": []
}

404

Message not found.

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...