Sms API v1

SMS APIs

Queues a SMS message for sending.

/api/v1/Sms/Queue

Request parameters

{
  "recipient": "example",
  "message": "example",
  "sender": "example",
  "batchId": "abf946fa-2d2c-38d4-8122-bd46c0e97db0"
}

Responses

Queues a SMS message for sending.

/api/v1/Sms

Request parameters

{
  "recipient": "example",
  "message": "example",
  "sender": "example",
  "batchId": "abf946fa-2d2c-38d4-8122-bd46c0e97db0"
}

Responses

/api/v1/Sms/SendBatch POST

/api/v1/Sms/SendBatch

Request parameters

Responses

Retrieves the status of a message with the specified messageId.

/api/v1/Sms/message/{messageId}

Request parameters

Responses

Subscribes to the inbound message.

/api/v1/Sms/Subscribe

This method is an HTTP POST endpoint for subscribing to the inbound message. The request body should be in JSON format containing the required data. The method returns an HTTP 200 status code with the subscription data on success. For incorrect or invalid data, the method returns an HTTP 400 status code with detailed error information. In case of any internal server errors, the method returns an HTTP 500 status code with detailed error information.

Request parameters

{
  "hookUrl": "example",
  "shortCode": "example"
}

Responses

Batch APIs

Creates a new batch.

/api/v1/Batch/new

Responses

Retrieves the status of a batch.

/api/v1/Batch/{batchId}

Request parameters

Responses

Opens a batch with the specified batch ID.

/api/v1/Batch/{batchId}/open

Request parameters

Responses

Closes a batch with the specified batch ID.

/api/v1/Batch/{batchId}/close

Request parameters

Responses

Last modified: 12 September 2024