Engati APIs

the engati apis allow you to integrate with the platform and create useful functionality around the platform the apis are rest based using json as the standard response type you can now import the curl as well authentication authentication the engati apis follow basic authentication utilizing api keys to authenticate the api calls the api keys can be generated by going to the integration > engati apis settings and creating an app the api keys can be revoked or regenerated at any point of time revoked or older keys would throw authentication errors for the api calls made using them the api keys need to be added to the authorization header as follows – “authorization” “basic \<api key>” api endpoints api endpoints following is the list of api endpoints currently supported along with their parameters and sample responses customer identifier and bot key details required for the apis can also be accessed from the developer settings section on the portal navigate to integration > engati api base url for the apis – https //api engati com/ https //api engati com/ get matching users this api will return the list of users matching the set of attribute values as specified required parameters list of required parameters for this api call are parameter description type attribute name the name of the attribute associated with the user string attribute value the value of the attribute associated with the user string error codes some of the error codes you might get while making the api call are error codes description 401 unauthorized 403 forbidden 404 not found 500 server side api failure retrieve chat history for a user this api will return the messages exchanged between the bot and the user, based on the parameters specified /bot api/v1 0/customer/{customerid}/bot/{botkey}/channel user/{channeluserid}/conversations required parameters parameters you can pass to filter the api response are parameter description type userid \[path parameter] the user identifier retrieved from users list api string start date \[optional] start date (utc time in milliseconds), if blank, all records will be considered long end date \[optional] end date (utc time in milliseconds), if blank, the current utc time will be considered long page number \[optional] the number of pages for which the data should be displayed by default, the first page will be shown integer page size \[optional] total number of records to be shown in the api call, the default value is set to 500 integer error codes some of the error codes you might get while making the api call error codes description 400 error code 1002, error message invalid bot or customer id, error details the bot id/customer id/user id provided is invalid error code 1003, error message invalid input date value, error details the start date and end date values are the time in milliseconds and the end date should be greater than start date error code 1004, error message invalid page number, error details please enter the correct page number the page number in the api is a positive integer value starting with 1 401 unauthorized 403 forbidden 500 server side api failure if you face any issues or queries please reach out to us at support\@engati com