Schedule List

To list scheduled SMS

List Sms Schedule

get

List all the sms schedule

Authorizations

Query parameters

pageintegerOptional

Page number

Example: 1

filter[sender_name]stringOptional

Filter by sender id name

Example: DUCKSMS

filter[type]string · enumOptional

Filter by sms type

Example: quickPossible values:

filter[message_type]string · enumOptional

Filter by sms message type

Example: asciiPossible values:

filter[status]string · enumOptional

Filter by sms status

Example: pendingPossible values:

Responses

200

List all the sms schedule

application/json

400

Invalid request

application/json

401

Unauthenticated

application/json

404

No data found

application/json

500

Server error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/sms/scheduled HTTP/1.1
Host: ducksms.com
Authorization: Bearer JWT
Accept: */*

{
  "status": 200,
  "message": "The sms scheduled return successfully",
  "data": [
    {
      "smsid": "59961854",
      "type": "quick",
      "scheduled_at": "2022-12-04 13:41:00",
      "sender_name": "DUCKSMS",
      "message": "Hello World",
      "recipients": 1,
      "status": "completed",
      "created_at": "2022-12-03 13:40:30",
      "updated_at": "2022-12-03 13:46:20"
    },
    {
      "smsid": "1636438975",
      "type": "quick",
      "scheduled_at": "2022-12-03 12:34:00",
      "sender_name": "MYCOMPANY",
      "message": "Hi john",
      "recipients": 1,
      "status": "cancelled",
      "created_at": "2022-12-03 12:32:42",
      "updated_at": "2022-12-03 12:32:46"
    }
  ]
}