Facebook
Login Contact Us Support Partner With Us

FAQ CATEGORY API

PURPOSE

FAQ Category API is used to get the category path which are existing in the database. By using the category details we will be able to pass the value in FAQ API.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select FAQ category API > enter the API name > Portal details > Select Key
  • Each API request will be created along with “Auth Key” to pass the URL
Ticket API 1 Ticket API 2 Ticket API 3

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/get-all-faq-categories.html

SUCCESS RESPONSE

{
   "message":{
            "contents":[
                     {
                        "id":"596",
                        "name":"FAQ",
                        "detail":"",
                        "parentCategoryName":"Add as Parent Category",
                        "categoryPath":"497/"
                     },
                     {
                        "id":"597",
                        "name":"Sales FAQ",
                        "detail":"",
                        "parentCategoryName":"FAQ",
                        "categoryPath":"497/596/"
                     },
                     {
                        "id":"596",
                        "name":"sales faq",
                        "detail":"",
                        "parentCategoryName":"Sales FAQ",
                        "categoryPath":"497/596/597/"
                     },
            ]
   },
   "status":"success"
};

FAILURE RESPONSE

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

FAQ API

PURPOSE

FAQ API used to pass the FAQ details for the particular category. Start date and end date to be mandatory. Since FAQ contents are huge data, by default start index will be 0 and end index will be 20.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select FAQ category API > enter the API name > Portal details > Select Key
  • Each API request will be created along with “Auth Key” to pass the URL
Ticket API 1 Ticket API 2 Ticket API 3

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/get-faq-contents.html

DATA FORMAT

[
   {
      "start_date":"2019-07-04",
      "end_date":"2019-07-04",
      "employee_id":"",
      "category_id":"497/596/597/",
      "start_index":"0",
      "end_index":"20"
   }
];

SUCCESS RESPONSE

{
   "message":{
            "contents":[
                     {
                        "id":"1781",
                        "title":"READY TO EAT",
                        "detail":"<p>Chicken Seekh Kabab, Chicken Spicy Seekh Kabab,&nbsp;Chicken Malai Seekh   Kabab</p>\r\n<p>Mutton&nbsp;Seekh Kabab,&nbsp;Mutton spicy Seekh Kabab,&nbsp;Mutton Malai Seekh Kabab</p>\r\n<p>\r\n  <br />\r\n</p>",
                        "type":"FAQ",
                        "categoryId":"598",
                        "categoryName":"sales faq",
                        "categoryPath":"497/596/597/598/",
                        "enabled":"Yes",
                        "queueKey":"",
                        "createDate":"04 Jul, 2019 11:47",
                        "attachmentDetail":"",
                        "displayIndex":"0"
                  }
            ]
   },
   "status":"success"
};

FAILURE RESPONSE

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