GET - Get scheduled SMS

Purpose

Use this API to fetch scheduled sms.

Note

MMS and Templates are only available in v2 version

Authorization

HeaderKey	Description
Authorization*	Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*	Set to application/json

Request URL

Method: GET

https://voice.zoho.com/rest/json/v1/sms/schedule

Scope: ZohoVoice.sms.READ

Parameters:

Param Name	Data Type	Description
from	Integer	Represents the starting index of the data array for retrieving records.
size	Integer	Represents the size of the data array. Default value is 100
fromDate	String	Represents the start date-time filter in yyyy-mm-dd HH:MM:ss format.
toDate	String	Represents the end date-time filter in yyyymmdd HH:MM:ss format.
searchtext	String	Represents the keyword used to search SMS text as a whole word.
optArchived	Boolean	Represents whether only archived logs are retrieved. When set to true, only archived logs are returned.
optUnread	Boolean	Represents whether only unread logs are retrieved. When set to true, only unread logs are returned.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/v1/sms/schedule" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "schedule": [
    {
      "multipartCount": 1,
      "country": "us",
      "scheduledTime": "2023-03-04 21:35:00",
      "timeZone": "Pacific/Niue",
      "customerNumber": "+1 46XXXXXXXX0",
      "message": "this is scheduled SMS",
      "userName": "Mark",
      "customerName": "John",
      "zuid": 8956275,
      "jobId": "961000000506031",
      "senderId": "+1 48XXXXXXX30",
      "messageType": "OUTGOING",
      "countryCode": "us",
      "isLongCode": true,
      "logid": "32712527-db0a-4aa9-840d-d0d3d72f7d0b",
      "zsoid": "696913717",
      "senderIdCountry": "us",
      "senderIdName": "SMS US",
      "status": "IN_QUEUE"
    }
  ],
  "code": "200",
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
 "status": "ERROR",
 "code": "500",
 "message": "failed"
}