Facebook
Login Contact Us Support Partner With Us

Ticket Pull API

PURPOSE

Ticket pull API will retrieve information on a specific Ticket. Start date and end date to be mandatory.

API CONFIGURATION

  • Click on configuration > API Configuration > Select Ticket API > Click on Ticket Pull API > enter the API name to create API request
  • Select Mandatory required field as mentioned above along with additional required parameters to generate the URL.
  • Assign the Auth Key to API before generating the code
  • Created API will be added in “API Information” Section
  • Each API request will be created along with “Auth Key” to pass the URL
Ticket API 1 Ticket API 2 Ticket API 3 Ticket API 4 Ticket API 4

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/select-ticket-between-start-and-end-dates.html

DATA FORMAT

[
   {
      "start_date":"2020-05-23",
      "end_date":"2020-05-23"
   }
];

SUCCESS RESPONSE

{
"status":"success",
"message":[
      {
         "tat":"0:1:29",
         "sla":"0:1:29",
         "ticketId":"5839952682",
         "contactId":"47895486",
         "referenceId":"44128722",
         "creatorName":" employee 1",
         "priority":"low",
         "assignedToName":"employee 1",
         "status":"success",
         "sla status":"out of sla",
         "date":"2020-05-23 12:11:08",
         "total_conversations":"1",
         "taskTitle":"order not received",
         "substatus":"Closed",
         "taskEnddate":"2020-05-23 12:37",
         "disposition":"Customer Support|Query|Refunds ",
         "companyName":"Rock stores",
         "customerName":"Rock",
         "customerEmail":"rock@gmail.com",
         "customerPhone":"3685465875"
      }
]
};

FAILURE RESPONSE

{
   "Message": "either start_date is null or blank",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages Description
AuthKeyInvalid Please use correct Authkey
ServerFailure Server error while processing this request
ReqFieldMissing Mandatory field missing
APIExpired API Request is Expired

ADDITIONAL NOTES

  • While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
  • You must have permission to access API service
  • You must have a valid Auth Key to send the Request, Auth key should not be expired

Ticket Push API

PURPOSE

Ticket Push API is used to push the data of Ticket into the database. Title to be mandatory field to create a ticket.

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Ticket API > Click on Ticket Push API > enter the API name to create API request and Key expiry date.
  • Select Mandatory required fields along with additional required parameters to generate the URL.
  • Each API request will be created along with “Auth Key” to pass the URL
Select API 1 Select API 2 Select API 3 Select API 4

DATA FORMAT

[
   {
      "title":"order is still not delivered",
      "ticket_details":"",
      "due_date":"",
      "customer_id":"48985478",
      "customer_name":"rock",
      "phone":"985553210",
      "email_id":"rock@gmail.com",
      "address":"bangalore"
   }
];

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/add-ticket-from-other-source.html/v.2.0

SUCCESS RESPONSE

{
   "due_date":"2020-05-23 14:06:37",
   "title":"order is still not delivered",
   "customer_id":"48451273",
   "ticket_id":"5902229973",
   "ticket_url":"https://kapdemo.kapturecrm.com/employee/view-task-detail.html?detail=5/112727802/5902229973",
   "status":"success"
};

FAILURE RESPONSE

{
"Message": "title is missing",
"Status": "failed"
}

ERROR MESSAGES

Error Messages Description
AuthKeyInvalid Please use correct Authkey
ServerFailure Server error while processing this request
ReqFieldMissing Mandatory field missing
APIExpired API Request is Expired

ADDITIONAL NOTES

  • While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
  • You must have permission to access API service
  • You must have a valid Auth Key to send the Request

Get Ticket API

PURPOSE

Get ticket API is to retrieve a list of Tickets using a variety of parameters. Ticket id to be mandatory field.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Ticket API > Click on Get Ticket API > enter the API name to create API request and Key expiry date.
  • Select Mandatory required fields along with additional required parameters to generate the URL.
  • Each API request will be created along with “Auth Key” to pass the URL
Search API 1 Search API 2 Search API 3

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/search-ticket-by-ticket-id.html/v.2.0

DATA FORMAT

{
   "ticket_ids":"5900282003",
   "conversation_type":"",
   "history_type":"",
   "assigned":"",
   "disposed":"",
   "response":"",
   "landing_queue":"",
   "create":"",
   "resolved":"",
   "include_emailbody":""
};

SUCCESS RESPONSE

[
   {
      "task_details":{
               "status":"Pending",
               "substatus":"Unattended",
               "date":"21-05-2020 08:00",
               "tat":"",
               "sla":"",
               "nextFollowUp":"21-05-2020 08:00",
               "lastFollowUp":"21-05-2020 08:00",
               "taskId":"112412826",
               "email":"",
               "phone":"",
               "lastSource":"AMC Task",
               "lastConvesationTime":"21-05-2020 08:00",
               "title":" 5900282003",
               "orderId":"4075548",
               "primarySource":"AMC Task",
               "ticketEmail":"",
               "folderId":"156736",
               "ticketId":"5900282003",
               "contactId":"51655898",
               "productId":"523216",
               "creatorId":"43528",
               "customerId":"47803533",
               "assignedId":"43528",
               "creatorName":"Kapdemo",
               "priority":"low",
               "attachment":"",
               "ticketCloseEmpId":"43528",
               "assignedToName":"Kapdemo",
               "queueKey":"",
               "customer_rating":"0",
               "lastConversationId":"0",
               "slaStatus":"out of sla",
               "queueName":"",
               "total_conversations":"0",
               "disposition":"AMC",
               "taskEnddate":"",
               "detail":"",
               "ftr":"no",
               "attachments":[]
         }
   }
];

FAILURE RESPONSE

{
   "Message": "ticket_ids are missing.",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages Description
AuthKeyInvalid Please use correct Authkey
ServerFailure Server error while processing this request
ReqFieldMissing Mandatory field missing
APIExpired API Request is Expired

ADDITIONAL NOTES

  • While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
  • You must have permission to access API service
  • You must have a valid Auth Key to send the Request, Auth key should not be expired

Update Ticket API

PURPOSE

Update Ticket API used to update the existing tickets in the system. Only the fields provided in the data block will be updated any unspecified fields will remain unchanged. Ticket id and Status to be mandatory fields.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Ticket API > Click on Update Ticket API > enter the API name to create API request and Key expiry date.
  • Select Mandatory required fields along with additional required parameters to generate the URL.
  • Each API request will be created along with “Auth Key” to pass the URL
Update API 1 update API 2 Update API 3 Update API 3

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/update-ticket-from-other-source.html/v.2.0

DATA FORMAT

[
   {
      "comment":"",
      "ticket_id":"5900282003",
      "file_name":"",
      "file_data":"",
      "callback_time":"",
      "sub_status":"PS",
      "queue":"C_Q",
      "disposition":""
   }
];

SUCCESS RESPONSE

{
   "message":"Status and Comment have been updated. ",
   "status":"success"
};

FAILURE RESPONSE

{
   "Message": "Wrong Data.Status should be PENDING or COMPLETE",
   "Status": "Fail"
}

ERROR MESSAGES

Error Messages Description
AuthKeyInvalid Please use correct Authkey
ServerFailure Server error while processing this request
ReqFieldMissing Mandatory field missing
APIExpired API Request is Expired

ADDITIONAL NOTES

  • While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
  • You must have permission to access API service
  • You must have a valid Auth Key to send the Request, Auth key should not be expired
SCHEDULE A DEMO