Getting started with Voice Agent Tester

To configure Voice Agent Tester, start by cloning or downloading the samples repository and setting up your environment for outbound calls. Then, ensure that the voice agent that you're testing is running and ready to receive calls. Finally, set the environment variables and start the service.

  1. Clone or download the samples.voice.gateway GitHub repository and change to the voice-agent-tester directory.

    This directory contains sample test cases, workers, and deployment scripts to help you get started.

  2. Configure IBM® Voice Gateway to initiate outbound calls.

    Choose one of the following options:

    • Use the docker-compose.yml file in the samples.
    • Configure your Caller Voice Gateway, which manages the outbound calls.
      1. Set the ENABLE_OUTBOUND_CALLS to true
      2. Set the HTTP_HOST environment variable to *.
      3. Expose the port for the outbound calls REST API in the SIP Orchestrator.
  3. Ensure that the voice agent that you run tests against is running and ready to receive calls.

    If you run load tests, ensure that the voice agent can process all the concurrent calls that you start.

  4. Set the environment variables for the voice agent tester.

    • Set the following environment variables:
      • CLOUDANT_URL OR CLOUDANT_ACCOUNT
      • CLOUDANT_USERNAME and CLOUDANT_PASSWORD, OR CLOUDANT_APIKEY
      • CLOUDANT_DATABASE_NAME
      • CALLER_VOICE_GATEWAY_URI
    • If you don't use a custom registry, set the following environment variables for authentication:
      • REST_ADMIN_USERNAME and REST_ADMIN_PASSWORD, which specify the credentials for securing the REST API
      • TESTER_WEBHOOK_USERNAME and TESTER_WEBHOOK_PASSWORD, which specify the credentials for securing the tester
    • If you use a custom registry, set the TESTER_WEBHOOK_USERNAME environment variable to specify the user in the custom registry.
    • If Voice Gateway, which manages the outbound calls, is in a different network, set the TESTER_WEBHOOK_URI environment variable.
  5. Start the service.
    • If you use the compose file, run the docker-compose up command.
    • Otherwise, run the Docker image to start the service.

What to do next

  1. Create a test case.
  2. With the ID of your newly created test case, create a worker.
  3. With the ID of the newly created worker, start jobs or batch jobs and verify the results.