Conversation Calls

This API allows you to fetch the calls associated to conversations from your Zoho SalesIQ account. You can filter the results based on call status, time, and more.

Query Parameters:

include_fields (String) – Fetches additional details by specifying any of the following values (comma-separated).
- department – Includes the department to which the call belongs.
- brand – Includes brand-related details.
- conversation – Provides details of the conversation.
- attachments – Includes the attachments related to the call.
status - Filter calls by status. Accepted values: cancelled, missed, rejected, initiated, accepted, ended, connected.
from_time (long) - Start time for filtering calls (epoch in milliseconds, eg., 1742552131206).
to_time (long) - End time for filtering calls (epoch in milliseconds, eg., 1742552171662).
limit – Specifies the number of calls to retrieve per request. The default and maximum value is 10.
index - Starting index for paginated results.
sort_by - Sort the call list using call time based filters. Accepted values: initiated_time, pickup_time, end_time, missed_time
order - Sort the call list using order. Accepted values: ascending, descending

OAuth Scope

SalesIQ.media.READ

Method

GET

URL

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screen_name}/conversations/{conversation_id}/calls

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylker/conversations/1385449374538322/calls

Payload

Copied{
  "include_fields": "department,brand,conversation,attachments",
  "status": "missed",
  "from_time": 1742552131206,
  "to_time": 1742552171662,
  "limit": 10,
  "index": 0,
  "sort_by": "initiated_time",
  "order": "ascending"
}

Sample response

Copied{
url:"/api/v2/zylker/conversations/1385449374538322/calls"
object: "calls",
data: 
[{
   "brand":{
      "name":"media",
      "id":"359526000000002242"
   },
   "last_attender":{
      "image_key":"",
      "email":"james@zylker.com",
      "name":"James",
      "id":"359526000000024031"
   },
  
      "end_time":"1742552171662",
      "id":"359526000000451169",
      "status":"ended",
      "initiated_by":{"type" : "operator","id": "359526000000002024"},
      "pickup_time":"1742552131206",
      "type":"audio",
      "ended_by":{"type" : "visitor","id": "748547702749023"},
      "created_time":"1742552117647",
      "connected_time":"1742552136865",
      "voice_message_available":true,
      "recording_available":true,
      "transcript_available":true,
      "summary_available":true
   
   "department":{
      "name":"media",
      "id":"359526000000002024"
   },
   "visitor":{
      "last_name":"208134",
      "first_name_empty":false,
      "name":"Larry Thomas",
      "first_name":"Larry",
      "type":"lead",
      "last_name_empty":false,
      "salutation":"None",
      "id":"359526000000451165"
   },
   "conversation":{
      "status":"Attended Online",
      "type":"chat",
      "in_time":"1742552113453",
      "reference_id":"402",
      "id":"359526000000451167",

   }
}
]