List calls by ticket

GET {{baseUrl}}/api/v1/tickets/:ticket_id/calls

This API lists a particular number of calls associated with a ticket, based on the limit specified.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the calls must be listed
isCompletedstringKey that denotes if the call was completed or not
isSpamstringKey that denotes whether to fetch spam calls or not
limitstringNumber of calls to list
sortBystringSort by a specific attribute: startTime or createdTime.The default sorting order is ascending. A - prefix denotes descending order of sorting.
includestringAllowed values are : contacts, assignee,tickets,teams.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"subject":"Call check scheduled","completedTime":"2019-04-17T07:12:09.000Z","departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","ownerId":"5000000015911","secId":"9d4883f2d94d59e4c0ddb2a7dd8a14ee","isCommented":true,"contact":{"firstName":null,"lastName":"Lawrence","phone":"1 888 900 9646","mobile":null,"id":"5000000016252","isSpam":false,"secId":"9d4883f2d94d59e42b7cc45393ad8ff8"},"createdTime":"2019-04-10T10:30:55.000Z","startTime":"2019-04-11T06:30:00.000Z","id":"5000000081089","direction":"outbound","ticket":{"ticketNumber":"101","phone":"1 888 900 9646","subject":"Here's your first ticket.","dueDate":"2019-03-29T09:51:26.000Z","teamId":null,"id":"5000000016294","assignee":{"photoURL":null,"firstName":"George","lastName":"McKinson","id":"5000000015911"},"isSpam":false,"status":"Open","secId":"9d4883f2d94d59e415b08d3d4c697d42"},"contactId":"5000000016252","team":null,"priority":"High","layoutId":"5000000013468","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Calls/dv/9d4883f2d94d59e4c0ddb2a7dd8a14ee","teamId":null,"assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":"Call","activityType":"Calls","ticketId":"5000000016294","status":"Completed"},{"subject":"ddddd","completedTime":"2019-04-17T07:11:43.000Z","departmentId":"5000000012710","dueDate":null,"creatorId":"5000000015911","ownerId":"5000000015911","secId":"9d4883f2d94d59e4437f38846d520c51","isCommented":false,"contact":{"firstName":null,"lastName":"Lawrence","phone":"1 888 900 9646","mobile":null,"id":"5000000016252","isSpam":false,"secId":"9d4883f2d94d59e42b7cc45393ad8ff8"},"createdTime":"2019-04-05T11:15:15.000Z","startTime":"2019-04-24T06:30:00.000Z","id":"5000000069105","direction":"outbound","ticket":{"ticketNumber":"101","phone":"1 888 900 9646","subject":"Here's your first ticket.","dueDate":"2019-03-29T09:51:26.000Z","teamId":null,"id":"5000000016294","assignee":{"photoURL":null,"firstName":"George","lastName":"McKinson","id":"5000000015911"},"isSpam":false,"status":"Open","secId":"9d4883f2d94d59e415b08d3d4c697d42"},"contactId":"5000000016252","team":null,"priority":"High","layoutId":"5000000013468","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Calls/dv/9d4883f2d94d59e4437f38846d520c51","teamId":null,"assignee":{"firstName":"George","lastName":"McKinson","photoURL":null,"id":"5000000015911"},"isSpam":false,"category":"Call","activityType":"Calls","ticketId":"5000000016294","status":"Completed"}]}