---
title: "Test Awsconnect Config"
method: POST
path: "/integrations/telephony/awsconnect/test"
tags: ["integrations", "telephony"]
---

# Test Awsconnect Config

`POST /integrations/telephony/awsconnect/test`

## Request

- Base URL: `https://dev.whispa.net` (the document declares no server; this is the origin it was published from)
- URL: `https://dev.whispa.net/integrations/telephony/awsconnect/test`
- Auth: one of:
  - OAuth 2
    - Password
    - Token URL: `auth/bearer/login`
  - API key in cookie `access_token`

Test AWS Connect configuration.

Tests:
1. AWS credentials are valid (via STS GetCallerIdentity)
2. KVS permissions work (via ListStreams - tests kinesisvideo access)
3. Agent discovery works (optional - via connect:ListUsers)

The core integration requires KVS read permissions. Connect API permissions
are only needed for agent discovery (optional feature).

## Request body

- AWSConnectTestRequest: Request to test AWS Connect configuration.
  - `provider` 'awsconnect'
  - `config` AWSConnectUIConfig, required: Configuration for AWS Connect integration (UI-configurable). Unlike ThreeCXConfig, there is NO default_user_id - if an agent is not explicitly mapped, their calls will NOT be captured.
    - `aws_region` string, required: AWS Region (e.g., ap-southeast-2)
    - `instance_id` string, required: AWS Connect Instance ID
    - `instance_alias` string, nullable: AWS Connect instance alias — the subdomain of the access URL https://<alias>.my.connect.aws. Used to deep-link call recordings.
    - `agent_user_map` object: Maps AWS Connect agent usernames to Whispa user IDs

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/whispa/apis/whispa-api.md) - [All operations](https://skmtc.dev/whispa/apis/whispa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whispa/apis/whispa-api/revisions/12c2e4aca43c?raw)