Features
Data APIs
Zoho Desk provides a set of APIs that facilitate interaction between your extension and your help desk portal. The APIs available are listed below:
- Ticket Object
- User Object
- Portal Object
- Department Object
- Extension Object
Ticket Object
This object provides you with access to the various properties of a ticket.
It is accessible only from the desk.ticket.detail.rightpanel, desk.ticket.detail.subtab and desk.ticket.detail.lefttab widget locations.
| Property | Request | Response |
| departmentId | ticket.departmentId | {'status':'success','ticket.departmentId':'12345678901234567'} |
| ticket.email | {'status':'success','ticket.email':'youremail@domainname.com'} | |
| subject | ticket.subject | {'status':'success','ticket.subject':'Faulty phone charging port'} |
| description | ticket.description | {'status':'success','ticket.description':'Product replacement'} |
| status | ticket.status | {'status':'success','ticket.status':'Open'} |
| dueDate | ticket.dueDate | {'status':'success','ticket.dueDate':'21/02/2018 12:00 PM'} |
| threadCount | ticket.threadCount | {'status':'success','ticket.threadCount':'1'} |
| isSpam | ticket.isSpam | {'status':'success','ticket.isSpam':'false'} |
| createdTime | ticket.createdTime | {'status':'success','ticket.createdTime':'29/01/2018 11:55 PM'} |
| modifiedTime | ticket.modifiedTime | {'status':'success','ticket.modifiedTime':'31/01/2018 11:27 AM'} |
| owner | ticket.owner | {'status':'success','ticket.owner':'Agent Name'} |
| id | ticket.id | {'status':'success','ticket.id':'12345678901234567'} |
| accountName | ticket.accountName | {'status':'success','ticket.accountName':'Account Name'} |
| phone | ticket.phone | {'status':'success','ticket.phone':'9876543210'} |
| productName | ticket.productName | {'status':'success','ticket.productName':'Product Name'} |
| commentCount | ticket.commentCount | {'status':'success','ticket.commentCount':'1'} |
| priority | ticket.priority | {'status':'success','ticket.priority':'High'} |
| channel | ticket.channel | {'status':'success','ticket.channel':'Phone'} |
| classification | ticket.classification | {'status':'success','ticket.classification':'Problem'} |
| category | ticket.category | {'status':'success','ticket.category':'General'} |
| subCategory | ticket.subCategory | {'status':'success','ticket.subCategory':'Sub General'} |
| contactName | ticket.contactName | {'status':'success','ticket.contactName':'Contact Name'} |
| customField | ticket.cf | {'status':'success','ticket.cf':{"cf_counter": "12","cf_deal_id": "2288589490093"}} |
| contactId | ticket.contactId | {'status':'success','ticket.contactId':'271540000000358001'} |
Request:
ZOHODESK.get(“ticket”."<property>").then(function(response) {
//Response - requested detail
}).catch(function(err){
//Error Handling })
Response:
{"ticket"."<property>": "<Requested Value>",
"status": "success"
}
User Object
Listed below are the properties related to the user object: