Skip to content

Quick Connect

Installation

  1. Clone this repository to your local machine.
  2. Navigate to the project directory.
  3. Run npm install to install the required dependencies.

Usage

  1. Prepare your CSV files:

    • quick_connects.csv: This file should contain the details of the quick connects you want to create. Each row should have the following columns:

      • Name: The name of the Quick Connect.
      • Description: A description of the Quick Connect.
      • Type: The type of the Quick Connect (USER, QUEUE, or PHONE_NUMBER).
      • Type Value: The value corresponding to the type (user ID, queue ID/ARN, or phone number).
      • Contact Flow: The name or ID of the contact flow associated with the Quick Connect.
    • queue_association.csv: This file should contain the associations between quick connects and queues. Each row should have the following columns:

      • Queue: The name, ID, or ARN of the queue.
      • Quick Connect: The name, ID, or ARN of the Quick Connect.
  2. Place the CSV files in the project root directory.

  3. Run the following command to execute the tool: npm run migrate:quickConnect --profile={PROFILE_NAME}

The tool will process the CSV files, create the quick connects, and associate them with the specified queues.

  1. Monitor the console output for any errors or success messages.

Error Handling

The tool includes error handling for the following scenarios:

  • If a Quick Connect with the same name already exists, the creation of that Quick Connect will be skipped, and a message will be logged.
  • If an error occurs during the association of a Quick Connect with a queue, an error message will be logged, and the tool will continue processing the remaining associations.