Qodex.ai

List calls

GET {{baseUrl}}/v1/calls

This API fetches a particular number of calls, based on the limit specified.

OAuth Scope

  • Desk.activities.calls.READ
  • Desk.activities.READ
  • Desk.calls.READ

Request Params

KeyDatatypeRequiredDescription
includestringAdditional information related to the call. Values allowed are: contacts, assignee,tickets,teams.
fromstringIndex number, starting from which the calls must be fetched
limitstringNumber of calls to fetch
departmentIdstringID of the department from which the calls must be fetched
departmentIdsstringDepartments from which the calls need to be queried
viewIdstringID of the view to apply while fetching the resources
assigneestringKey that filters tickets by assignee. Values allowed are any valid assignee ID or multiple assignee IDs separated by commas.
startTimestringStart time for completing the call. Values allowed are Overdue, Tomorrow, CurrentWeek, CurrentMonth and Today.You can pass multiple values by separating them with commas.
isCompletedstringKey that denotes whether the call is completed or not
sortBystringKey that sorts the calls by a specific attribute: startTime or createdTime.The default sorting order is ascending. A - prefix denotes descending order of sorting.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"ticket":null,"contactId":null,"subject":"hRl","completedTime":"2019-04-02T06:36:43.000Z","departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","team":null,"ownerId":"5000000015911","priority":"Normal","isCommented":true,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Calls/dv/9d4883f2d94d59e48740f9abf01f71bf","contact":null,"createdTime":"2019-04-02T06:36:43.000Z","startTime":"2019-03-24T11:40:01.000Z","id":"5000000049385","assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":null,"activityType":"Calls","ticketId":null,"status":"Canceled","direction":"inbound"},{"ticket":null,"contactId":null,"subject":"Irt","completedTime":"2019-04-02T06:37:06.000Z","departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","team":null,"ownerId":"5000000015911","priority":"Normal","isCommented":true,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Calls/dv/9d4883f2d94d59e4603451fcf41c54b2","contact":null,"createdTime":"2019-04-02T06:37:06.000Z","startTime":"2019-03-24T11:40:24.000Z","id":"5000000053840","assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":null,"activityType":"Calls","ticketId":null,"status":"Canceled","direction":"inbound"},{"ticket":null,"contactId":null,"subject":"SG0","completedTime":"2019-04-02T06:36:28.000Z","departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","team":null,"ownerId":"5000000015911","priority":"Normal","isCommented":true,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Calls/dv/9d4883f2d94d59e46c76cc4bfd688f1b","contact":null,"createdTime":"2019-04-02T06:36:28.000Z","startTime":"2019-04-01T11:39:44.000Z","id":"5000000047098","assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":null,"activityType":"Calls","ticketId":null,"status":"Completed","direction":"inbound"}]}