Entrypoint Configuration
Calls ECE’s ‘Get Entrypoint Configuration’ API to retrieve the configuration details of an entry point. The configuration details can then be used for Asynchronous messaging.
Please note that:
- The provided entry point must be an active entry point.
- The client application accessing this API must be of type "Chat".
Authorization
Refer to the Node Authorization section for more information.
Methods and Outcomes
Get Entrypoint Configuration
Input Variables | Output Variables | Node Outcomes |
---|---|---|
Entry Point ID * ID of the entry point. On successful execution, the node returns the configuration details for this entry point. | entryPointId Id of the entrypoint. lastModifiedDate Last modification date of the entry point. attachmentPolicies Value of the attachment policy restriction type. E.g., ‘allow_all’. response Complete JSON response payload received on successful execution of Get Entrypoint Configuration. | onInvalidData Request processing failed due to missing data. onError Request processing failed due to an error. onInvalidChoice Request processing failed but there is no outcome configured for the concerned scenario. onTimeout Request processing timed out. Unauthorized Authorization header is not provided. Authorization header format is incorrect. Session does not exist corresponding to the provided authorization header. The session identified through authorization header is not a client application session. Forbidden The client application is not configured to use the provided entry point. Not Found An entry poing with the provided ID does not exist. Internal server error Request processing failed because of internal server error. onEntryPointConfigSuccess * The request was successfully executed. onauthorizationfail The authorization is failed due to authentication |
Updated about 1 year ago