GET - Get SMS logs in conversation view


Purpose

Use this API to fetch SMS logs in conversation view.


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

Scope: ZohoVoice.sms.READ

Parameters: 

Param Name

Data Type

Description

page

Integer

Represents the page number.

size

Integer

Represents the size of the data array.

Default value is 100

shortCode

String

Represents the Zoho Voice shortcode.

longCode

String

Represents the Zoho Voice SMS DID number.

 

Example: +1 484292xxxx

totalPages

Integer

Represents the total number of pages.

search

String

Represents the keyword used to search SMS text as a whole word.

Sample Request

Copiedurl -X GET "https://voice.zoho.com/rest/json/v1/sms/chatlist?page=1&size=25&totalPages=0&shortCode=&longCode=+1****&search=" \
  -H "Authorization: Zoho-oauthtoken <access_token>" \
  -H "Accept: application/json"

Sample Response - Success

Copied{
  "chatlist": [
    {
      "country": "au",
      "submittedTime": 1656313040887,
      "messageId": "61a2d48d-45bf-4583-a34c-44b8f924a61e",
      "customerNumber": "+61 2XXXXXXXX7",
      "message": "test AUS SMS",
      "userName": "Mark",
      "customerName": "+6XXXXXXXXX7",
      "zuid": 8956275,
      "senderId": "+61 4XXXXXXXX5",
      "statusDescription": "Message was not delivered due to one of the possible errors reported by SMSC",
      "messageType": "OUTGOING",
      "sentTime": "2022-06-26 19:57",
      "logid": "66fccfe8-95e6-4a39-bd1a-5f258755ed81",
      "zsoid": "696913717",
      "email": "mark@zylker.com",
      "status": "UNDELIVERED"
    }
  ],
  "meta": {
    "total": 20,
    "totalPages": 2
  },
  "status": "success"
}

Sample Response - Error

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