Bappy API

SMS

SMS messaging — list sent messages and send new SMS to SIMs.

The link_id in the send request body accepts either a Link UUID or ICCID.

List SMS messages (by link)

GET

https://api.omaxtelecom.com/bappy

/v1/sms

List SMS Messages for Link

Filter SMS messages for a specific link.

List SMS messages (by link) › query Parameters

link_id

string

Link UUID to filter by

per_page

integer

List SMS messages (by link) › Headers

Accept

string

List SMS messages (by link) › Responses

200

Successful response

No data returned

GET/v1/sms

curl --request GET \
  --url https://api.omaxtelecom.com/bappy/v1/sms

shell

Example Responses

No example specified for this content type

application/json

Send SMS

POST

https://api.omaxtelecom.com/bappy

/v1/sms

Send SMS

Send an SMS message to a specific SIM. The message is queued for async delivery via a background job.

Body Parameters:

Parameter	Type	Required	Description
`link_id`	string	Yes	Link UUID or ICCID identifying the target SIM
`message`	string	Yes	Message content (max 80 characters)

Response (202 Accepted):


Code
 
{
  "success": true,
  "data": {
    "id": "sms-uuid",
    "link_id": "link-uuid",
    "status": "pending"
  },
  "message": "SMS queued for delivery."
}

Notes:

SMS is delivered asynchronously — check the status via GET /v1/sms
Cost per SMS is determined by the organization's price_per_sms setting
The link_id field accepts either a UUID or ICCID

Errors:

404 NOT_FOUND – Link not found
422 VALIDATION_ERROR – link_id and message are required, message max 80 chars

Send SMS › Headers

Accept

string

Content-Type

string

Send SMS › Request Body

Send SMS › Responses

200

Successful response

No data returned

POST/v1/sms

curl --request POST \
  --url https://api.omaxtelecom.com/bappy/v1/sms \
  --header 'Content-Type: application/json' \
  --data '
{
  "link_id": "{{link_identifier}}",
  "message": "Hello from API"
}
'

shell

Example Request Body

{
  "link_id": "{{link_identifier}}",
  "message": "Hello from API"
}

json

Example Responses

No example specified for this content type

application/json

Transactions Organization

List SMS messages (by link)

GET

https://api.omaxtelecom.com/bappy

/v1/sms

List SMS Messages for Link

Filter SMS messages for a specific link.

List SMS messages (by link) › query Parameters

link_id

string

Link UUID to filter by

per_page

integer

List SMS messages (by link) › Headers

Accept

string

List SMS messages (by link) › Responses

200

Successful response

No data returned

Send SMS

POST

https://api.omaxtelecom.com/bappy

/v1/sms

Send SMS

Send an SMS message to a specific SIM. The message is queued for async delivery via a background job.

Body Parameters:

Parameter	Type	Required	Description
`link_id`	string	Yes	Link UUID or ICCID identifying the target SIM
`message`	string	Yes	Message content (max 80 characters)

Response (202 Accepted):


Code
 
{
  "success": true,
  "data": {
    "id": "sms-uuid",
    "link_id": "link-uuid",
    "status": "pending"
  },
  "message": "SMS queued for delivery."
}

Notes:

SMS is delivered asynchronously — check the status via GET /v1/sms
Cost per SMS is determined by the organization's price_per_sms setting
The link_id field accepts either a UUID or ICCID

Errors:

404 NOT_FOUND – Link not found
422 VALIDATION_ERROR – link_id and message are required, message max 80 chars

Send SMS › Headers

Accept

string

Content-Type

string

Send SMS › Request Body

Send SMS › Responses

200

Successful response

No data returned