Engati APIs

introduction introduction 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 headers api keys need to be added to the authorization header as follows – authorization basic \<authorization key> the api keys can be generated by going to engati api section engati apis follow basic authentication utilizing api keys to authenticate the api calls the api keys can be revoked or regenerated at any point in time and would throw authentication errors for the api calls made using them users api an api to fetch users who match the value specified for the attribute example to get list of users who have feedback with 1 star list of required parameters for this api call 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 conversations api an api to fetch a user conversation via user id example to store conversation data in crm parameters you can pass to filter the api response 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 whatsapp template broadcasting for template broadcasting to bulk users on whatsapp note only templates can be sent to users as per whatsapp policy beyond the time limts example apis broadcast api to enable and use broadcast wrapper api please contact support\@engati com for all channels including whatsapp with users within time limit for broadcast a simple text message or interactive messages to bulk users example marketing & advertisments, survey and promotion learn more about broadcasts in depth via broadcast document broadcast will be published based on the time mentioned in utc, immediate broadcasts will be sent for expired time multiple numbers in list format "channeluserids" \[ "9178921978038123","9190193486731" ] api trigger to trigger automations build on engati platform for external usecases example sending an email to a customer who fills an external website form learn more about broadcasts in depth via api trigger document error scenarios 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