SMS

SMS

Get sms messages sent report

get

Authorizations

bearerAuth

Query parameters

allbooleanOptional

Retrieve all records without pagination

per_pageintegerOptional

Number of items per page

Default: 15

pageintegerOptional

Page number

Default: 1

searchstringOptional

Search term

from_datestring · dateOptional

Start date for filtering

till_datestring · dateOptional

End date for filtering

sender_namestringOptional

Filter by sender name

Responses

200

Successful operation

application/json

successbooleanOptional

messagestringOptional

get

/api/workspaces/{workspace}/sms/messages

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspace}/sms/messages HTTP/1.1
Accept: */*

200

Successful operation

{
  "success": true,
  "message": "text",
  "data": [],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1
  }
}

Get a sent message

get

Get a specific sms message by its ID

Authorizations

api_key

Path parameters

idinteger · int64Required

ID of the message to delete

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Message deleted successfully

401

Unauthenticated

404

Message not found

application/json

get

/api/workspaces/{workspace}/sms/messages/{message}

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspace}/sms/messages/{message} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Message deleted successfully"
}

Upload excel file

post

Upload a file to the server

Body

application/json

filefileRequired

sms_typestring · enumRequired

SMS type

Possible values:

Responses

200

Successful operation

application/json

successbooleanOptional

messagestringOptional

422

Validation Error(s)

application/json

500

unable to upload file

application/json

post

/api/SmsUsers/sms/upload

HTTPcURLJavaScriptPython

POST /api/SmsUsers/sms/upload HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "file": null,
  "sms_type": "NORMAL"
}

{
  "success": true,
  "message": "text",
  "data": {
    "path": "text"
  }
}