Amazon Chime SDK Chime Proxy Sessions API
The Chime Proxy Sessions API from Amazon Chime SDK — 2 operation(s) for chime proxy sessions.
The Chime Proxy Sessions API from Amazon Chime SDK — 2 operation(s) for chime proxy sessions.
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-proxy-sessions-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 Proxy Sessions 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/{VoiceConnectorId}/proxy-sessions:
post:
operationId: CreateProxySession
summary: Create Proxy Session
description: 'Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant
phone numbers. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProxySessionResponse'
'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'
deprecated: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProxySessionRequest'
tags:
- Proxy Sessions
get:
operationId: ListProxySessions
summary: List Proxy Sessions
description: 'Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector. End of support notice: On
April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListProxySessionsResponse'
'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'
deprecated: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListProxySessionsRequest'
tags:
- Proxy Sessions
/voice-connectors/{VoiceConnectorId}/proxy-sessions/{ProxySessionId}:
delete:
operationId: DeleteProxySession
summary: Delete Proxy Session
description: 'Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector. End of support
notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.'
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
'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'
deprecated: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProxySessionRequest'
tags:
- Proxy Sessions
get:
operationId: GetProxySession
summary: Get Proxy Session
description: 'Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector. End
of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetProxySessionResponse'
'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'
deprecated: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetProxySessionRequest'
tags:
- Proxy Sessions
post:
operationId: UpdateProxySession
summary: Update Proxy Session
description: 'Updates the specified proxy session details, such as voice or SMS capabilities. End of support notice:
On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProxySessionResponse'
'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'
deprecated: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProxySessionRequest'
tags:
- Proxy Sessions
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:
CreateProxySessionRequest:
type: object
properties:
VoiceConnectorId:
type: string
description: The Voice Connector ID.
ParticipantPhoneNumbers:
type: array
items:
type: string
description: The participant phone numbers.
Name:
type: string
description: The name of the proxy session.
ExpiryMinutes:
type: integer
description: The number of minutes allowed for the proxy session.
Capabilities:
type: array
items:
type: string
enum:
- Voice
- SMS
description: The proxy session's capabilities.
NumberSelectionBehavior:
type: string
enum:
- PreferSticky
- AvoidSticky
description: The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel:
type: string
enum:
- Country
- AreaCode
description: The preference for matching the country or area code of the proxy phone number with that of the first
participant.
GeoMatchParams:
$ref: '#/components/schemas/GeoMatchParams'
required:
- VoiceConnectorId
- ParticipantPhoneNumbers
- Capabilities
CreateProxySessionResponse:
type: object
properties:
ProxySession:
$ref: '#/components/schemas/ProxySession'
DeleteProxySessionRequest:
type: object
properties:
VoiceConnectorId:
type: string
description: The Voice Connector ID.
ProxySessionId:
type: string
description: The proxy session ID.
required:
- VoiceConnectorId
- ProxySessionId
GeoMatchParams:
type: object
properties:
Country:
type: string
description: The country.
AreaCode:
type: string
description: The area code.
required:
- Country
- AreaCode
GetProxySessionRequest:
type: object
properties:
VoiceConnectorId:
type: string
description: The Voice Connector ID.
ProxySessionId:
type: string
description: The proxy session ID.
required:
- VoiceConnectorId
- ProxySessionId
GetProxySessionResponse:
type: object
properties:
ProxySession:
$ref: '#/components/schemas/ProxySession'
ListProxySessionsRequest:
type: object
properties:
VoiceConnectorId:
type: string
description: The Voice Connector ID.
Status:
type: string
enum:
- Open
- InProgress
- Closed
description: The proxy session status.
NextToken:
type: string
description: The token used to retrieve the next page of results.
MaxResults:
type: integer
description: The maximum number of results to return in a single call.
required:
- VoiceConnectorId
ListProxySessionsResponse:
type: object
properties:
ProxySessions:
type: array
items:
$ref: '#/components/schemas/ProxySession'
description: The proxy sessions' details.
NextToken:
type: string
description: The token used to retrieve the next page of results.
Participant:
type: object
properties:
PhoneNumber:
type: string
description: The participant's phone number.
ProxyPhoneNumber:
type: string
description: The participant's proxy phone number.
ProxySession:
type: object
properties:
VoiceConnectorId:
type: string
description: The Voice Connector ID.
ProxySessionId:
type: string
description: The proxy session ID.
Name:
type: string
description: The proxy session name.
Status:
type: string
enum:
- Open
- InProgress
- Closed
description: The proxy session status.
ExpiryMinutes:
type: integer
description: The number of minutes allowed for the proxy session.
Capabilities:
type: array
items:
type: string
enum:
- Voice
- SMS
description: The proxy session capabilities.
CreatedTimestamp:
type: string
format: date-time
description: The created time stamp, in ISO 8601 format.
UpdatedTimestamp:
type: string
format: date-time
description: The updated time stamp, in ISO 8601 format.
EndedTimestamp:
type: string
format: date-time
description: The ended time stamp, in ISO 8601 format.
Participants:
type: array
items:
$ref: '#/components/schemas/Participant'
description: The proxy session participants.
NumberSelectionBehavior:
type: string
enum:
- PreferSticky
- AvoidSticky
description: The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel:
type: string
enum:
- Country
- AreaCode
description: The preference for matching the country or area code of the proxy phone number with that of the first
participant.
GeoMatchParams:
$ref: '#/components/schemas/GeoMatchParams'
UpdateProxySessionRequest:
type: object
properties:
VoiceConnectorId:
type: string
description: The Voice Connector ID.
ProxySessionId:
type: string
description: The proxy session ID.
Capabilities:
type: array
items:
type: string
enum:
- Voice
- SMS
description: The proxy session capabilities.
ExpiryMinutes:
type: integer
description: The number of minutes allowed for the proxy session.
required:
- VoiceConnectorId
- ProxySessionId
- Capabilities
UpdateProxySessionResponse:
type: object
properties:
ProxySession:
$ref: '#/components/schemas/ProxySession'
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
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
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)