Test your Virtual Agent API configuration

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：1分

    • Test your Virtual Agent API configuration using API testing tool.

    始める前に

    Make sure you've setup Postman or Swagger or any other third-party application environment for API testing.

    Role required: admin

    このタスクについて

    API tests are a way to ensure that your API is behaving as you expect it to. To write a test, do the following:

    手順

    1. Select the environment that you've setup and navigate to tab where you can send your first API request.
    2. Configure the payload.
      For example, send the below request:
      {
    "requestId": "requestid123",
    "userId": "testuser.1",
    "emailId": "admin@example.com",
    "action": "START_CONVERSATION",
    "message": {
        "text": "",
        "typed": true
    },
    "contextVariables": {
        "app_name": "test"
    }
}
    3. Click Send.
      You can check the response of your payload and your communication status in the response section.
      • If your instance is on asynchronous mode, you have to check enabling Virtual Agent API logging. See for more information.
      • If your instance is on synchronous mode, you have to check the Body of the response.