Amazon Chime SDK Chime Settings API
The Chime Settings API from Amazon Chime SDK — 4 operation(s) for chime settings.
The Chime Settings API from Amazon Chime SDK — 4 operation(s) for chime settings.
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-settings-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 Settings API
version: '2021-07-15'
description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 8 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:
/settings:
get:
operationId: GetGlobalSettings
summary: Get Global Settings
description: Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetGlobalSettingsResponse'
'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:
type: string
tags:
- Settings
put:
operationId: UpdateGlobalSettings
summary: Update Global Settings
description: Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
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'
'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/UpdateGlobalSettingsRequest'
tags:
- Settings
/settings/phone-number:
get:
operationId: GetPhoneNumberSettings
summary: Get Phone Number Settings
description: Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling
name.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPhoneNumberSettingsResponse'
'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:
type: string
tags:
- Settings
put:
operationId: UpdatePhoneNumberSettings
summary: Update Phone Number Settings
description: Updates the phone number settings for the administrator's AWS account, such as the default outbound calling
name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to
72 hours to update.
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'
'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/UpdatePhoneNumberSettingsRequest'
tags:
- Settings
/accounts/{AccountId}/settings:
get:
operationId: GetAccountSettings
summary: Get Account Settings
description: Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout
settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration
Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAccountSettingsResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetAccountSettingsRequest'
tags:
- Settings
servers:
- url: https://chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
put:
operationId: UpdateAccountSettings
summary: Update Account Settings
description: Updates the settings for the specified Amazon Chime account. You can update settings for remote control
of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page
in the Amazon Chime Administration Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAccountSettingsResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeBadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeConflictException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAccountSettingsRequest'
tags:
- Settings
servers:
- url: https://chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
/accounts/{AccountId}/users/{UserId}/settings:
get:
operationId: GetUserSettings
summary: Get User Settings
description: Retrieves settings for the specified user ID, such as any associated phone number settings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserSettingsResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserSettingsRequest'
tags:
- Settings
servers:
- url: https://chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
put:
operationId: UpdateUserSettings
summary: Update User Settings
description: Updates the settings for the specified user, such as phone number settings.
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserSettingsRequest'
tags:
- Settings
servers:
- url: https://chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
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:
AccountSettings:
type: object
properties:
DisableRemoteControl:
type: boolean
description: Setting that stops or starts remote control of shared screens during meetings.
EnableDialOut:
type: boolean
description: Setting that allows meeting participants to choose the Call me at a phone number option. For more information,
see Join a Meeting without the Amazon Chime App.
ChimeBadRequestException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
ChimeConflictException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
ChimeForbiddenException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
ChimeNotFoundException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
ChimeServiceFailureException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
ChimeServiceUnavailableException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
GetAccountSettingsRequest:
type: object
properties:
AccountId:
type: string
description: The Amazon Chime account ID.
required:
- AccountId
GetAccountSettingsResponse:
type: object
properties:
AccountSettings:
$ref: '#/components/schemas/AccountSettings'
GetGlobalSettingsResponse:
type: object
properties:
VoiceConnector:
$ref: '#/components/schemas/VoiceConnectorSettings'
GetPhoneNumberSettingsResponse:
type: object
properties:
CallingName:
type: string
description: The default outbound calling name for the account.
CallingNameUpdatedTimestamp:
type: string
format: date-time
description: The updated outbound calling name timestamp, in ISO 8601 format.
GetUserSettingsRequest:
type: object
properties:
AccountId:
type: string
description: The Amazon Chime account ID.
UserId:
type: string
description: The user ID.
required:
- AccountId
- UserId
GetUserSettingsResponse:
type: object
properties:
UserSettings:
$ref: '#/components/schemas/UserSettings'
TelephonySettings:
type: object
properties:
InboundCalling:
type: boolean
description: Allows or denies inbound calling.
OutboundCalling:
type: boolean
description: Allows or denies outbound calling.
SMS:
type: boolean
description: Allows or denies SMS messaging.
required:
- InboundCalling
- OutboundCalling
- SMS
ThrottledClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
UnauthorizedClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
UpdateAccountSettingsRequest:
type: object
properties:
AccountId:
type: string
description: The Amazon Chime account ID.
AccountSettings:
$ref: '#/components/schemas/AccountSettings'
required:
- AccountId
- AccountSettings
UpdateAccountSettingsResponse:
type: object
properties: {}
UpdateGlobalSettingsRequest:
type: object
properties:
VoiceConnector:
$ref: '#/components/schemas/VoiceConnectorSettings'
required:
- VoiceConnector
UpdatePhoneNumberSettingsRequest:
type: object
properties:
CallingName:
type: string
description: The default outbound calling name for the account.
required:
- CallingName
UpdateUserSettingsRequest:
type: object
properties:
AccountId:
type: string
description: The Amazon Chime account ID.
UserId:
type: string
description: The user ID.
UserSettings:
$ref: '#/components/schemas/UserSettings'
required:
- AccountId
- UserId
- UserSettings
UserSettings:
type: object
properties:
Telephony:
$ref: '#/components/schemas/TelephonySettings'
required:
- Telephony
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
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
VoiceConnectorSettings:
type: object
properties:
CdrBucket:
type: string
description: The S3 bucket that stores the Voice Connector's call detail records.
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)
sources:
- https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json
- https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime/service/2018-05-01/chime-2018-05-01.json