Send Message

POST 
/messages/send

Send a message with specified details such as destination number, message content, scheduled send time, and validity period. Requires Bearer Auth Token from ApiManagement for authentication. Throws an exception if failed to send the message, if there's insufficient balance, or for other system errors.

Request

application/json

Body

required

Request body for sending a 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.

validity_period integer

The validity period of the message (in seconds).

Responses

200

Message sent 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).

message object

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

400

Failed to send message. Check the response for details.

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

401

Unauthorized. Invalid token.

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

Example (from schema)

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

402

Failed to send message. Insufficient balance.

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