GET - Get SMS logs


Purpose

Use this API to fetch SMS logs.


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/logs

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 yyyymmdd HH:MM format.

toDate

String

Represents the end date-time filter in yyyymmdd HH:MM format.

messageType

String

Represents the direction of the message.

 

Possible values:

  • All

  • Incoming

  • Outgoing

customerNumber

Long

Represents the recipient phone number.

longCode

Long

Represents the Zoho Voice SMS sender ID.

country

String

Represents the country code.

 

Example: us

fetchMMS

Boolean

Represents whether only MMS logs are retrieved. 

When set to true, only MMS logs are returned.

optArchived

Boolean

Represents whether only archived logs are retrieved. 

When set to true, only archived logs are returned.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/v1/sms/logs?from=0&size=50&fromDate=2025-12-04 00:00:00&toDate=2025-12-04 23:59:59&messageType=&customerNumber=12015550123&country=us&longCode=+1 4****&fetchMMS=true&optArchived=true" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "smsLogQuery": [
    {
      "country": "us",
      "multipartCount": 1,
      "submittedTime": 1702035249667,
      "isBlocked": false,
      "emailId": "mark@zylker.com",
      "customerNumber": "+1 4XXXXXXXXX0",
      "message": "Take this",
      "userName": "Mark",
      "customerName": "Josiah",
      "zuid": 669069956,
      "senderId": "+1 4XXXXXXXX73",
      "messageType": "INCOMING",
      "isMMS": true,
      "mmsMeta": [
        {
          "bucketName": "zohovoice-mms-local-02-697950588",
          "objectName": "697950588-mms-669069956-1702035250091",
          "fileName": "697950588-mms-669069956-1702035250091",
          "fileSize": "960637",
          "mmsId": "6d39bf14-43cb-4cff-8a98-68ab1de26064",
          "contentType": "image/jpeg"
        }
      ],
      "isLongCode": true,
      "sentTime": "2023-12-08 17:04",
      "logid": "953473b3-0b33-4d4e-a9c8-abf0ae8893c7",
      "zsoid": "697950588",
      "senderIdCountry": "us",
      "senderIdName": "+1 46XXXXXXX73",
      "status": "DELIVERED"
    }
  ],
  "meta": {
    "total": 4
  },
  "status": "success"
}

Sample Response - Error

Copied{
   "code": "ZVSMS-4038",
   "message": "Destination country not supported. Kindly contact zohovoice support",
   "status": "ERROR"
}