Amazon Chime SDK Chime Voice Connector Groups API
The Chime Voice Connector Groups API from Amazon Chime SDK — 2 operation(s) for chime voice connector groups.
The Chime Voice Connector Groups API from Amazon Chime SDK — 2 operation(s) for chime voice connector groups.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-chime:amazon-chime-voice-connector-groups-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon Chime SDK Meetings Voice Connector Groups API
version: '2021-07-15'
description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://voice-chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/voice-connector-groups:
post:
operationId: CreateVoiceConnectorGroup
summary: Create Voice Connector Group
description: Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate
Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.
You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism
for fallback in case of availability events.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVoiceConnectorGroupResponse'
'403':
description: AccessDeniedException; ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'400':
description: BadRequestException; ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVoiceConnectorGroupRequest'
tags:
- Voice Connector Groups
get:
operationId: ListVoiceConnectorGroups
summary: List Voice Connector Groups
description: Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListVoiceConnectorGroupsResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeForbiddenException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListVoiceConnectorGroupsRequest'
tags:
- Voice Connector Groups
/voice-connector-groups/{VoiceConnectorGroupId}:
delete:
operationId: DeleteVoiceConnectorGroup
summary: Delete Voice Connector Group
description: Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated
with the group must be removed before it can be deleted.
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeConflictException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteVoiceConnectorGroupRequest'
tags:
- Voice Connector Groups
get:
operationId: GetVoiceConnectorGroup
summary: Get Voice Connector Group
description: Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and
associated VoiceConnectorItems.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetVoiceConnectorGroupResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetVoiceConnectorGroupRequest'
tags:
- Voice Connector Groups
put:
operationId: UpdateVoiceConnectorGroup
summary: Update Voice Connector Group
description: Updates the settings for the specified Amazon Chime SDK Voice Connector group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVoiceConnectorGroupResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeConflictException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVoiceConnectorGroupRequest'
tags:
- Voice Connector Groups
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: chime
schemas:
AccessDeniedException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
CreateVoiceConnectorGroupRequest:
type: object
properties:
Name:
type: string
description: The name of the Voice Connector group.
VoiceConnectorItems:
type: array
items:
$ref: '#/components/schemas/VoiceConnectorItem'
description: Lists the Voice Connectors that inbound calls are routed to.
CallDistributionType:
type: string
enum:
- PriorityWeightedDistribution
- LoadBalancedDistribution
required:
- Name
CreateVoiceConnectorGroupResponse:
type: object
properties:
VoiceConnectorGroup:
$ref: '#/components/schemas/VoiceConnectorGroup'
DeleteVoiceConnectorGroupRequest:
type: object
properties:
VoiceConnectorGroupId:
type: string
description: The Voice Connector Group ID.
required:
- VoiceConnectorGroupId
GetVoiceConnectorGroupRequest:
type: object
properties:
VoiceConnectorGroupId:
type: string
description: The Voice Connector group ID.
required:
- VoiceConnectorGroupId
GetVoiceConnectorGroupResponse:
type: object
properties:
VoiceConnectorGroup:
$ref: '#/components/schemas/VoiceConnectorGroup'
ListVoiceConnectorGroupsRequest:
type: object
properties:
NextToken:
type: string
description: The token used to return the next page of results.
MaxResults:
type: integer
description: The maximum number of results to return in a single call.
ListVoiceConnectorGroupsResponse:
type: object
properties:
VoiceConnectorGroups:
type: array
items:
$ref: '#/components/schemas/VoiceConnectorGroup'
description: The details of the Voice Connector groups.
NextToken:
type: string
description: The token used to return the next page of results.
UpdateVoiceConnectorGroupRequest:
type: object
properties:
VoiceConnectorGroupId:
type: string
description: The Voice Connector ID.
Name:
type: string
description: The name of the Voice Connector group.
VoiceConnectorItems:
type: array
items:
$ref: '#/components/schemas/VoiceConnectorItem'
description: The VoiceConnectorItems to associate with the Voice Connector group.
CallDistributionType:
type: string
enum:
- PriorityWeightedDistribution
- LoadBalancedDistribution
required:
- VoiceConnectorGroupId
- Name
- VoiceConnectorItems
UpdateVoiceConnectorGroupResponse:
type: object
properties:
VoiceConnectorGroup:
$ref: '#/components/schemas/VoiceConnectorGroup'
VoiceChimeBadRequestException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeConflictException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeForbiddenException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeNotFoundException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeServiceFailureException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeServiceUnavailableException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeThrottledClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeUnauthorizedClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceConnectorGroup:
type: object
properties:
VoiceConnectorGroupId:
type: string
description: The ID of a Voice Connector group.
Name:
type: string
description: The name of a Voice Connector group.
VoiceConnectorItems:
type: array
items:
$ref: '#/components/schemas/VoiceConnectorItem'
description: The Voice Connectors to which you route inbound calls.
CreatedTimestamp:
type: string
format: date-time
description: The Voice Connector group's creation time stamp, in ISO 8601 format.
UpdatedTimestamp:
type: string
format: date-time
description: The Voice Connector group's creation time stamp, in ISO 8601 format.
VoiceConnectorGroupArn:
type: string
description: The ARN of the Voice Connector group.
CallDistributionType:
type: string
enum:
- PriorityWeightedDistribution
- LoadBalancedDistribution
VoiceConnectorItem:
type: object
properties:
VoiceConnectorId:
type: string
description: The Voice Connector ID.
Priority:
type: integer
description: The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1
as the highest priority. When hosts have equal priority, the system distributes calls among them based on their
relative weight.
required:
- VoiceConnectorId
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)