Amazon Chime SDK Chime Voice Connectors API

The Chime Voice Connectors API from Amazon Chime SDK — 2 operation(s) for chime voice connectors.

GitHub OpenAPI

Operations 5

POST /voice-connectors Create Voice Connector #
GET /voice-connectors List Voice Connectors #
DELETE /voice-connectors/{VoiceConnectorId} Delete Voice Connector #
GET /voice-connectors/{VoiceConnectorId} Get Voice Connector #
PUT /voice-connectors/{VoiceConnectorId} Update Voice Connector #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-chime:amazon-chime-voice-connectors-api"
All apis
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.

Get an API 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 Specification

amazon-chime-voice-connectors-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Voice Connectors 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-connectors:
    post:
      operationId: CreateVoiceConnector
      summary: Create Voice Connector
      description: Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing
        Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVoiceConnectorResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '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/CreateVoiceConnectorRequest'
      tags:
      - Voice Connectors
    get:
      operationId: ListVoiceConnectors
      summary: List Voice Connectors
      description: Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVoiceConnectorsResponse'
        '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/ListVoiceConnectorsRequest'
      tags:
      - Voice Connectors
  /voice-connectors/{VoiceConnectorId}:
    delete:
      operationId: DeleteVoiceConnector
      summary: Delete Voice Connector
      description: Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice
        Connector must be disassociated from it 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/DeleteVoiceConnectorRequest'
      tags:
      - Voice Connectors
    get:
      operationId: GetVoiceConnector
      summary: Get Voice Connector
      description: Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound
        host, and encryption requirements.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVoiceConnectorResponse'
        '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/GetVoiceConnectorRequest'
      tags:
      - Voice Connectors
    put:
      operationId: UpdateVoiceConnector
      summary: Update Voice Connector
      description: Updates the details for the specified Amazon Chime SDK Voice Connector.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVoiceConnectorResponse'
        '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/UpdateVoiceConnectorRequest'
      tags:
      - Voice Connectors
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
    CreateVoiceConnectorRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the Voice Connector.
        AwsRegion:
          type: string
          enum:
          - us-east-1
          - us-west-2
          - ca-central-1
          - eu-central-1
          - eu-west-1
          - eu-west-2
          - ap-northeast-2
          - ap-northeast-1
          - ap-southeast-1
          - ap-southeast-2
          description: 'The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1
            .'
        RequireEncryption:
          type: boolean
          description: Enables or disables encryption for the Voice Connector.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the Voice Connector.
        IntegrationType:
          type: string
          enum:
          - CONNECT_CALL_TRANSFER_CONNECTOR
          - CONNECT_ANALYTICS_CONNECTOR
          description: 'The connectors for use with Connect Customer. The following options are available: CONNECT_CALL_TRANSFER_CONNECTOR
            - Enables enterprises to integrate Connect Customer with other voice systems to directly transfer voice calls
            and metadata without using the public telephone network. They can use Connect Customer telephony and Interactive
            Voice Response (IVR) with their existing voice systems to modernize the IVR experience of their existing contact
            center and their enterprise and branch voice systems. Additionally, enterprises migrating their contact center
            to Connect Customer can start with Con'
        NetworkType:
          type: string
          enum:
          - IPV4_ONLY
          - DUAL_STACK
          description: The type of network for the Voice Connector.
      required:
      - Name
      - RequireEncryption
    CreateVoiceConnectorResponse:
      type: object
      properties:
        VoiceConnector:
          $ref: '#/components/schemas/VoiceConnector'
    DeleteVoiceConnectorRequest:
      type: object
      properties:
        VoiceConnectorId:
          type: string
          description: The Voice Connector ID.
      required:
      - VoiceConnectorId
    GetVoiceConnectorRequest:
      type: object
      properties:
        VoiceConnectorId:
          type: string
          description: The Voice Connector ID.
      required:
      - VoiceConnectorId
    GetVoiceConnectorResponse:
      type: object
      properties:
        VoiceConnector:
          $ref: '#/components/schemas/VoiceConnector'
    ListVoiceConnectorsRequest:
      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.
    ListVoiceConnectorsResponse:
      type: object
      properties:
        VoiceConnectors:
          type: array
          items:
            $ref: '#/components/schemas/VoiceConnector'
          description: The details of the Voice Connectors.
        NextToken:
          type: string
          description: The token used to return the next page of results.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag's key.
        Value:
          type: string
          description: The tag's value.
      required:
      - Key
      - Value
    UpdateVoiceConnectorRequest:
      type: object
      properties:
        VoiceConnectorId:
          type: string
          description: The Voice Connector ID.
        Name:
          type: string
          description: The name of the Voice Connector.
        RequireEncryption:
          type: boolean
          description: When enabled, requires encryption for the Voice Connector.
      required:
      - VoiceConnectorId
      - Name
      - RequireEncryption
    UpdateVoiceConnectorResponse:
      type: object
      properties:
        VoiceConnector:
          $ref: '#/components/schemas/VoiceConnector'
    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
    VoiceConnector:
      type: object
      properties:
        VoiceConnectorId:
          type: string
          description: The Voice Connector's ID.
        AwsRegion:
          type: string
          enum:
          - us-east-1
          - us-west-2
          - ca-central-1
          - eu-central-1
          - eu-west-1
          - eu-west-2
          - ap-northeast-2
          - ap-northeast-1
          - ap-southeast-1
          - ap-southeast-2
          description: 'The AWS Region in which the Voice Connector is created. Default: us-east-1.'
        Name:
          type: string
          description: The Voice Connector's name.
        OutboundHostName:
          type: string
          description: The outbound host name for the Voice Connector.
        RequireEncryption:
          type: boolean
          description: Enables or disables encryption for the Voice Connector.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The Voice Connector's creation timestamp, in ISO 8601 format.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The Voice Connector's updated timestamp, in ISO 8601 format.
        VoiceConnectorArn:
          type: string
          description: The ARN of the Voice Connector.
        IntegrationType:
          type: string
          enum:
          - CONNECT_CALL_TRANSFER_CONNECTOR
          - CONNECT_ANALYTICS_CONNECTOR
          description: The connectors for use with Connect Customer.
        NetworkType:
          type: string
          enum:
          - IPV4_ONLY
          - DUAL_STACK
          description: The type of network for the Voice Connector.
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)