Get Calls List

Description

This API allows you to fetch the list of call conversations from your Zoho SalesIQ account. You can filter the results based on call status, department, brand, date range, visitor type, and more.

Query Parameters

Parameter	Type	Description	Example
limit	int	Number of call records to retrieve (pagination).	10
index	int	Starting index for paginated results.	0
include_fields	string	Additional data to include in the response (comma-separated).	brand,department,conversation
status* (mandatory)	string	Filter calls by status. Accepted values: cancelled, missed, rejected, initiated, accepted, ended, connected.	missed
department_ids	long	Comma-separated department IDs to filter calls.	359526000000002024,359526000000002025
attender_ids	long	Comma-separated operator IDs who attended the calls.	359526000000024031,359526000000024030
brand_ids	long	Comma-separated brand IDs to filter calls.	359526000000002242
from_time	long	Start time for filtering calls (epoch in milliseconds).	1742552171662
to_time	long	End time for filtering calls (epoch in milliseconds).	1742552131206
visitor_type	string	Filter based on visitor type. Accepted values: lead, contact.	lead
email	string	Filter by visitor email address.	jack@zoho.com

OAuth Scope

SalesIQ.media.READ

Method

GET

URL

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screen_name}/calls

Example

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

Sample response

Copied{
  "url": "/api/v2/zylker/calls",
  "object": "list",
  "data": [
    {
      "brand": {
        "name": "media",
        "id": "359526000000002242"
      },
      "last_attender": {
        "id": "359526000000024031"
      },
      "id": "359526000000451169",
      "created_time": "1742552117647",
      "pickup_time": "1742552131206",
      "connected_time": "1742552136865",
      "end_time": "1742552171662",
      "missed_time": "1742552171662",
      "status": "ended",
      "initiated_by": {
        "type": "operator",
        "id": "359526000000002024"
      },
      "type": "audio",
      "ended_by": {
        "type": "operator",
        "id": "359526000000002024"
      },
      "voice_message_available": false,
      "recording_available": true,
      "transcript_available": true,
      "summary_available": true,
      "department": {
        "name": "media",
        "id": "359526000000002024"
      },
      "conversation": {
        "status": "Attended Online",
        "type": "call",
        "in_time": "1742552113453",
        "reference_id": "402",
        "id": "359526000000451167"
      }
    },
    {
      "brand": {
        "name": "media",
        "id": "359526000000002242"
      },
      "last_attender": {
        "image_key": "",
        "email": "james@zylker",
        "name": "James",
        "id": "359526000000024031"
      },
      "id": "359526000000451170",
      "created_time": "1742552131205",
      "pickup_time": "1742552131207",
      "connected_time": "1742552131210",
      "end_time": "1742552131310",
      "missed_time": "1742552171662",
      "status": "accepted",
      "initiated_by": {
        "type": "operator",
        "id": "359526000000002024"
      },
      "type": "audio",
      "ended_by": {
        "type": "operator",
        "id": "359526000000002024"
      },
      "voice_message_available": true,
      "recording_available": true,
      "transcript_available": true,
      "summary_available": true,
      "department": {
        "name": "media",
        "id": "359526000000002024"
      },
      "conversation": {
        "status": "Attended Online",
        "type": "call",
        "in_time": "1742552113453",
        "reference_id": "402",
        "id": "359526000000451167"
      }
    }
  ]
}

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor

Workplace

Vani

Expense

Recruit

People