ADD TICKET API

PURPOSE

Add Ticket API will push the data of Ticket / Task details into the database. Name, phone & Email should be mandatory field, rest of the additional fields can be used based on required to push the data.

API CONFIGURATION

  • Click on configuration > API Configuration > Select Ticket API > Click on Add Ticket 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

SAMPLE REQUEST URL

http://sales.adjetter.com/ticket-push-api

REQUEST PARAMETERS

Parameter Data Type Description
Title * String Required field in specified data type to Title which can be a Subject of the ticket
Type * Char Required field in specified data type to identify the type of Ticket
Ticket Details * String Required field in specified data type to Ticket Details
Due Date * String Required field in specified data type & format Ticket Due Date should be read in string & date data should be in YYYY-MM-DD
Customer Id int Customer Id
Customer Name String Customer Name
Phone String Mobile number / Phone Number Details
Email id String Customer Email address
Transaction id String Ticket Transaction Id

SAMPLE REQUEST URL FORMAT

HTML Format

http://sales.kapturecrm.com/ customer-push-api?auth_key=gwwxorj6chod2q46b67o1n0mme5j79v6y6g15jga8w2x1b45if&api_id=35 &ticket_fields= {"title":" General Complaint","type":"G","ticket_details":"Website Issue","due_date":"2016041912:10"}

SUCCESS RESPONSE

{ 
"Message": "Ticket Added Successfully",
"Status": "Success"
};

FAILURE RESPONSE

{ 
"Message": "Auth Key Expired",
"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

SELECT TICKET API

PURPOSE

To retrieve information on a specific Ticket / Task, you should feed requests must specify a beginning date and ending date range, the Ticket information will be returned as “Ticket” in the JSON response.

API CONFIGURATION

  • Click on configuration > API Configuration > Select Ticket API > Click on Select Ticket 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

REQUEST PARAMETERS

Parameter Data Type Description
Title * String Required field in specified data type to Title which can be a Subject of the ticket
Type * Char Required field in specified data type to identify the type of Ticket
Ticket Details * String Required field in specified data type to Ticket Details
Due Date * String Required field in specified data type & format Ticket Due Date should be read in string & date data should be in YYYY-MM-DD
Start Date String Start Date format should be in YYYY-MM-DD
End Date String End Date format should be in YYYY-MM-DD

SAMPLE REQUEST

JSON Format

{ 
"auth_key": "gwwxorj6chod2q46b67o1n0mme5j79v6y6g15jga8w2x1b45if",
"api_Id": "39",
"start_date":"2016-03-31",
"end_date":"2016-03-31"
}

SAMPLE REQUEST URL FORMAT

HTML Format

http://sales.adjetter.com/get-customer?auth_key=gwwxorj6chod2q46b67o1n0mme5j79v6y6g15jga8w2x1b45if&api_id=47&customer_id=123

SUCCESS RESPONSE

{
"message": [
{
"id": 54751,
"cmId": 396,
"assignedToId": 0,
"assignedToName": "",
"creatorId": 0,
"creatorName": "",
"detail": "transactionId_192:offerId_789:test",
"date": "May 3, 2016 5:18:11 PM",
"taskEnddate": "May 3, 2016 5:18:11 PM",
"lastFollowUp": "May 3, 2016 5:18:11 PM",
"nextFollowUp": "May 31, 2016 12:00:00 AM",
"status": "P",
"enabled": true,
"type": "E",
"referenceId": 286829,
"isPeriodic": false,
"periodicityUnit": 1,
"periodicityType": "0",
"periodicity": "1x0",
"sendTaskRemainderAutoEmailRespond": false,
"sendTaskRemainderAutoSmsRespond": false,
"totalTaskAssigned": 0,
"totalTaskCompleted": 0,
"totalTaskPending": 0,
"pendingTaskId": 0,
"newTaskAutoEmail": false,
"newTaskAutoSms": false,
"taskCompleteAutoEmail": false,
"taskCompleteAutoSms": false,
"categoryId": 0,
"memberId": 0,
"updatePeriodicValue": false,
"taskTitle": "adId_123:General Complaint ",
"taskRepeatWeekDays": "",
"sendEmail": false,
"sendMessage": false,
"taskType": "0",
"clientEmpId": 0,
"agencyBriefId": 0,
"agencyCreativeRequirementId": 0,
"agencyContentRequirementId": 0,
"lastModificationTime": {
"year": 2016,
"month": 4,
"dayOfMonth": 3,
"hourOfDay": 17,
"minute": 18,
"second": 28
},
"productId": 0,
"repeatInterval": 0,
"associativefile": "",
"ticketId": "4622760787",
"address": "",
"contactId": 365384,
"chargeable": false,
"serviceCharge": 0.0,
"updateTask": true,
"priority": 0,
"lastConversationTime": 1462276091287,
"enquiryId": 0,
"ticketEmail": "",
"folderId": 0,
"substatus": "US",
"customerFeedback": 0,
"isOutOfSLA": false
},
{
"id": 54752,
"cmId": 396,
"assignedToId": 0,
"assignedToName": "",
"creatorId": 0,
"creatorName": "",
"detail": "transactionId_192:offerId_789:test",
"date": "May 3, 2016 6:03:29 PM",
"taskEnddate": "May 3, 2016 6:03:29 PM",
"lastFollowUp": "May 3, 2016 6:03:29 PM",
"nextFollowUp": "May 31, 2016 12:00:00 AM",
"status": "P",
"enabled": true,
"type": "E",
"referenceId": 287288,
"isPeriodic": false,
"periodicityUnit": 1,
"periodicityType": "0",
"periodicity": "1x0",
"sendTaskRemainderAutoEmailRespond": false,
"sendTaskRemainderAutoSmsRespond": false,
"totalTaskAssigned": 0,
"totalTaskCompleted": 0,
"totalTaskPending": 0,
"pendingTaskId": 0,
"newTaskAutoEmail": false,
"newTaskAutoSms": false,
"taskCompleteAutoEmail": false,
"taskCompleteAutoSms": false,
"categoryId": 0,
"memberId": 0,
"updatePeriodicValue": false,
"taskTitle": "General Complaint Ticket",
"taskRepeatWeekDays": "",
"sendEmail": false,
"sendMessage": false,
"taskType": "0",
"clientEmpId": 0,
"agencyBriefId": 0,
"agencyCreativeRequirementId": 0,
"agencyContentRequirementId": 0,
"lastModificationTime": {
"year": 2016,
"month": 4,
"dayOfMonth": 3,
"hourOfDay": 18,
"minute": 3,
"second": 40
},
"productId": 0,
"repeatInterval": 0,
"associativefile": "",
"ticketId": "4622788096",
"address": "marathahalli",
"contactId": 365857,
"chargeable": false,
"serviceCharge": 0.0,
"updateTask": true,
"priority": 0,
"lastConversationTime": 1462278809648,
"enquiryId": 0,
"ticketEmail": "",
"folderId": 0,
"substatus": "US",
"customerFeedback": 0,
"isOutOfSLA": false
}
],
"status": "success"
} 

FAILURE RESPONSE

{ 
"Message": "Auth Key Expired",
"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

SEARCH TICKET API

PURPOSE

Retrieve a list of Tickets using a variety of parameters. For Search Ticket API to use the Get method to fetch data along with Auth Kay specified in the API request. To retrieve information on a specific ticket, you should ideally use the Ticket ID In this case, the Ticket information will be returned as “Ticket” in the JSON response.

If you do not have the Ticket ID stored, you can also look up Ticket based on indexed field, Ticket Code. These must be an exact match, but can return multiple results on non-unique fields such as the customer Ticket.

API CONFIGURATION

  • Click on configuration > API Configuration > Select Ticket API > Click on Search Ticket API > enter the API name to create API request
  • 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

REQUEST URL

http://sales.adjetter.com/get-ticket-api

REQUEST PARAMETERS

Parameter Data Type Description
Title * String Required field in specified data type to Title which can be a Subject of the ticket
Type * Char Required field in specified data type to identify the type of Ticket
Ticket Details * String Required field in specified data type to Ticket Details

SAMPLE REQUEST

JSON Format

{ 
"auth_key": "et3726c45gabxhcue1wixydlr5hunsjvz2yku3qcs2dynxv7lk",
"api_id": "45", 
"ticket_id": "123"
}

SAMPLE REQUEST URL FORMAT

HTML Format

http://sales.kapturecrm.com/get-ticket-api?auth_key=et3726c45gabxhcue1wixydlr5hunsjvz2yku3qcs2dynxv7lk&api_id=45&ticket_id=123

SUCCESS RESPONSE

{
"message": {
"id": 54759,
"cmId": 396,
"assignedToId": 0,
"assignedToName": "",
"creatorId": 0,
"creatorName": "",
"detail": "transactionId_6789:offerId_2345 :d",
"date": "May 5, 2016 5:43:21 PM",
"taskEnddate": "May 5, 2016 5:43:21 PM",
"lastFollowUp": "May 5, 2016 5:43:21 PM",
"nextFollowUp": "May 31, 2016 12:00:00 AM",
"status": "P",
"enabled": true,
"type": "E",
"referenceId": 287331,
"isPeriodic": false,
"periodicityUnit": 1,
"periodicityType": "0",
"periodicity": "1x0",
"sendTaskRemainderAutoEmailRespond": false,
"sendTaskRemainderAutoSmsRespond": false,
"totalTaskAssigned": 0,
"totalTaskCompleted": 0,
"totalTaskPending": 0,
"pendingTaskId": 0,
"newTaskAutoEmail": false,
"newTaskAutoSms": false,
"taskCompleteAutoEmail": false,
"taskCompleteAutoSms": false,
"categoryId": 0,
"memberId": 0,
"updatePeriodicValue": false,
"taskTitle": "adId_987:e",
"taskRepeatWeekDays": "",
"sendEmail": false,
"sendMessage": false,
"taskType": "0",
"clientEmpId": 0,
"agencyBriefId": 0,
"agencyCreativeRequirementId": 0,
"agencyContentRequirementId": 0,
"lastModificationTime": {
"year": 2016,
"month": 4,
"dayOfMonth": 5,
"hourOfDay": 17,
"minute": 43,
"second": 21
},
"productId": 0,
"repeatInterval": 0,
"associativefile": "",
"ticketId": "4624504011",
"address": "bangalore,karanataka",
"contactId": 0,
"chargeable": false,
"serviceCharge": 0.0,
"updateTask": true,
"priority": 0,
"lastConversationTime": 1462450401147,
"enquiryId": 0,
"ticketEmail": "",
"folderId": 0,
"substatus": "US",
"customerFeedback": 0,
"isOutOfSLA": false
},
"status": "success"
}

FAILURE RESPONSE

{ 
"Message": "Auth Key Invalid",
"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

UPDATE TICKET API

PURPOSE

A specific, existing ticket can be updated with this API, Data is sent using an HTTP POST request and data request should be in JSON format. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. When using this method, it is best to specify only those fields you wish to change. Updated information status will revert in JSON response.

API CONFIGURATION

  • Click on configuration > API Configuration > Select Ticket API > Click on Update Ticket API > enter the API name to create API request
  • 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

REQUEST URL

http://sales.adjetter.com/update-ticket-api

REQUEST PARAMETERS

Parameter Data Type Description
Title * String Required field in specified data type to Title which can be a Subject of the ticket
Type * Char Required field in specified data type to identify the type of Ticket
Ticket Details * String Required field in specified data type to Ticket Details

SAMPLE REQUEST

JSON Format

{ 
"auth_key": "gwwxorj6chod2q46b67o1n0mme5j79v6y6g15jga8w2x1b45if",
"api_id": "35", 
"ticket_id": "123", "ticket_fields": {"title": "General Complaint", "type": "General", "ticket_details": "Website Issue"}
}

SAMPLE REQUEST URL FORMAT

HTML Format

http://sales.kapturecrm.com/ update-ticket-api? auth_key=et3726c45gabxhcue1wixydlr5hunsjvz2yku3qcs2dynxv7lk&api_id=46&ticket_id=123&ticket_fields={"title":" General Complaint ","type":"general","ticket_details":" Website Issue "}

SUCCESS RESPONSE

{
{"message": "Ticket Updated Successfully""status": "success"
}

FAILURE RESPONSE

{ 
"Message": "Auth Key Invalid",
"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