Custom Chat Applications
  • 07 Aug 2023
  • 1 Minute to read
  • Contributors
  • PDF

Custom Chat Applications

  • PDF

Article summary

For custom chat applications it is possible to directly contact with Knovvu VA Orchestrator's Message API.

  • For custom chat applications, where the client system can send a predetermined Activity object directly to Knovvu VA Orchestrator service (in the format on MS Bot Framework).
  • There are three methods for orchestrator service to receive activity object.
  • POST Message: It is the endpoint that will send messages from the custom web chat. The "messages endpoint" is where the system accepts messages.
  • Project input fields must be filled. Sample request body is also shown in the Swagger API.

image.png

  • POST Rating: This method is only valid for v1.51 or below. The rating endpoint is used to send the rating data of external custom webchat clients.
    External Conversation ID, Conversation Session ID, Rating and comment information must be filled.
    Picture4.png

  • GET Version: The version information of the orchestrator can be accessed from this endpoint.

  • By clicking execute, the orchestrator’s version information is retrieved.
    Picture5.png

  • Gateway between the Knovvu VA Orchestrator service and client service must be defined.

  • It can be a custom chat application with voice or text; it can be on their website or their application, it can come directly through the webchat API; or the guide is written by the company directly, not via the webchat API, thus it can be sent directly to the orchestration from the Webchat application.

  • Webchat API and orchestrator, ND communication is provided with POST Method.

  • For orchestrator, Tenant, Project, FlowID fields must be filled. IsPublished and isTest values must be selected.

  • For nd communication, Project, Client ID and tenant fields must be filled.
    Picture6.png

Picture7.png

  • GET History: History can be achieved with conversation ID.
    Picture8.png
  • GET Settings: Settings can be achieved with Integration ID
    Picture9.png
  • POST Settings: The setting endpoint is used to send the settings information of external custom webchat clients.
    Picture10.png
  • GET Version: The version information can be accessed from this endpoint.
    Picture11.png

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.