Amazon Web Services, Inc.

Amazon Chime SDK Voice

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can
also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

Endpoints 90

  • GETGet voice connector/voice-connectors/:VoiceConnectorIdRetrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
  • PUTUpdate voice connector/voice-connectors/:VoiceConnectorIdUpdates the details for the specified Amazon Chime SDK Voice Connector.
  • POSTDisassociate phone numbers from voice connector/voice-connectors/:VoiceConnectorId?operation=disassociate-phone-numbersDisassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
  • DELETEDelete voice connector/voice-connectors/:VoiceConnectorIdDeletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it…
  • GETGet voice connector group/voice-connector-groups/:VoiceConnectorGroupIdRetrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .
  • PUTUpdate voice connector group/voice-connector-groups/:VoiceConnectorGroupIdUpdates the settings for the specified Amazon Chime SDK Voice Connector group.
  • POSTDisassociate phone numbers from voice connector group/voice-connector-groups/:VoiceConnectorGroupId?operation=disassociate-phone-numbersDisassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.
  • DELETEDelete voice connector group/voice-connector-groups/:VoiceConnectorGroupIdDeletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
  • GETList phone numbers/phone-numbers?status=string&product-type=string&filter-name=string&filter-value=string&max-results=0&next-token=stringLists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice…
  • POSTBatch update phone number/phone-numbers?operation=batch-updateUpdates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For…
  • GETList phone number orders/phone-number-orders?next-token=string&max-results=0Lists the phone numbers for an administrator's Amazon Chime SDK account.
  • POSTCreate phone number order/phone-number-ordersCreates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product…
  • GETList proxy sessions/voice-connectors/:VoiceConnectorId/proxy-sessions?status=string&next-token=string&max-results=0Deprecated. 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…
  • POSTCreate proxy session/voice-connectors/:VoiceConnectorId/proxy-sessionsDeprecated. Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers. End of support notice: On…
  • GETList sip media applications/sip-media-applications?max-results=0&next-token=stringLists the SIP media applications under the administrator's AWS account.
  • POSTCreate sip media application/sip-media-applicationsCreates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK…
  • POSTCreate sip media application call/sip-media-applications/:SipMediaApplicationId/callsCreates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId .
  • GETList sip rules/sip-rules?sip-media-application=string&max-results=0&next-token=stringLists the SIP rules under the administrator's AWS account.
  • POSTCreate sip rule/sip-rulesCreates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see…
  • GETList voice connectors/voice-connectors?next-token=string&max-results=0Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
  • POSTCreate voice connector/voice-connectorsCreates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon…
  • GETList voice connector groups/voice-connector-groups?next-token=string&max-results=0Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
  • POSTCreate voice connector group/voice-connector-groupsCreates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice…
  • GETList voice profiles/voice-profiles?voice-profile-domain-id=string&next-token=string&max-results=0Lists the voice profiles in a voice profile domain.
  • POSTCreate voice profile/voice-profilesCreates a voice profile, which consists of an enrolled user and their latest voice print. Before creating any voice profiles, you must provide all notices and…
  • GETList voice profile domains/voice-profile-domains?next-token=string&max-results=0Lists the specified voice profile domains in the administrator's AWS account.
  • POSTCreate voice profile domain/voice-profile-domainsCreates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio. Before creating any voice profiles, you…
  • GETGet phone number/phone-numbers/:PhoneNumberIdRetrieves details for the specified phone number ID, such as associations, capabilities, and product type.
  • POSTUpdate phone number/phone-numbers/:PhoneNumberIdUpdates phone number details, such as product type, calling name, or phone number name for the specified phone number ID. You can update one phone number…
  • DELETEDelete phone number/phone-numbers/:PhoneNumberIdMoves the specified phone number into the Deletion queue . A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it…
  • GETGet proxy session/voice-connectors/:VoiceConnectorId/proxy-sessions/:ProxySessionIdDeprecated. Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS…
  • POSTUpdate proxy session/voice-connectors/:VoiceConnectorId/proxy-sessions/:ProxySessionIdDeprecated. 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…
  • DELETEDelete proxy session/voice-connectors/:VoiceConnectorId/proxy-sessions/:ProxySessionIdDeprecated. Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end…
  • GETGet sip media application/sip-media-applications/:SipMediaApplicationIdRetrieves the information for a SIP media application, including name, AWS Region, and endpoints.
  • PUTUpdate sip media application/sip-media-applications/:SipMediaApplicationIdUpdates the details of the specified SIP media application.
  • DELETEDelete sip media application/sip-media-applications/:SipMediaApplicationIdDeletes a SIP media application.
  • GETGet sip rule/sip-rules/:SipRuleIdRetrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
  • PUTUpdate sip rule/sip-rules/:SipRuleIdUpdates the details of the specified SIP rule.
  • DELETEDelete sip rule/sip-rules/:SipRuleIdDeletes a SIP rule.
  • GETGet voice connector emergency calling configuration/voice-connectors/:VoiceConnectorId/emergency-calling-configurationRetrieves the emergency calling configuration details for the specified Voice Connector.
  • PUTPut voice connector emergency calling configuration/voice-connectors/:VoiceConnectorId/emergency-calling-configurationUpdates a Voice Connector's emergency calling configuration.
  • DELETEDelete voice connector emergency calling configuration/voice-connectors/:VoiceConnectorId/emergency-calling-configurationDeletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
  • GETGet voice connector external systems configuration/voice-connectors/:VoiceConnectorId/external-systems-configurationGets information about an external systems configuration for a Voice Connector.
  • PUTPut voice connector external systems configuration/voice-connectors/:VoiceConnectorId/external-systems-configurationAdds an external systems configuration to a Voice Connector.
  • DELETEDelete voice connector external systems configuration/voice-connectors/:VoiceConnectorId/external-systems-configurationDeletes the external systems configuration for a Voice Connector.
  • GETGet voice connector origination/voice-connectors/:VoiceConnectorId/originationRetrieves the origination settings for the specified Voice Connector.
  • PUTPut voice connector origination/voice-connectors/:VoiceConnectorId/originationUpdates a Voice Connector's origination settings.
  • DELETEDelete voice connector origination/voice-connectors/:VoiceConnectorId/originationDeletes the origination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be…
  • GETGet voice connector proxy/voice-connectors/:VoiceConnectorId/programmable-numbers/proxyDeprecated. Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will…
  • PUTPut voice connector proxy/voice-connectors/:VoiceConnectorId/programmable-numbers/proxyDeprecated. Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end…
  • DELETEDelete voice connector proxy/voice-connectors/:VoiceConnectorId/programmable-numbers/proxyDeprecated. Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support…
  • GETGet voice connector streaming configuration/voice-connectors/:VoiceConnectorId/streaming-configurationRetrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to…
  • PUTPut voice connector streaming configuration/voice-connectors/:VoiceConnectorId/streaming-configurationUpdates a Voice Connector's streaming configuration settings.
  • DELETEDelete voice connector streaming configuration/voice-connectors/:VoiceConnectorId/streaming-configurationDeletes a Voice Connector's streaming configuration.
  • GETGet voice connector termination/voice-connectors/:VoiceConnectorId/terminationRetrieves the termination setting details for the specified Voice Connector.
  • PUTPut voice connector termination/voice-connectors/:VoiceConnectorId/terminationUpdates a Voice Connector's termination settings.
  • DELETEDelete voice connector termination/voice-connectors/:VoiceConnectorId/terminationDeletes the termination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be…
  • GETList voice connector termination credentials/voice-connectors/:VoiceConnectorId/termination/credentialsLists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
  • POSTPut voice connector termination credentials/voice-connectors/:VoiceConnectorId/termination/credentials?operation=putUpdates a Voice Connector's termination credentials.
  • GETGet voice profile/voice-profiles/:VoiceProfileIdRetrieves the details of the specified voice profile.
  • PUTUpdate voice profile/voice-profiles/:VoiceProfileIdUpdates the specified voice profile’s voice print and refreshes its expiration timestamp. As a condition of using this feature, you acknowledge that the…
  • DELETEDelete voice profile/voice-profiles/:VoiceProfileIdDeletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.
  • GETGet voice profile domain/voice-profile-domains/:VoiceProfileDomainIdRetrieves the details of the specified voice profile domain.
  • PUTUpdate voice profile domain/voice-profile-domains/:VoiceProfileDomainIdUpdates the settings for the specified voice profile domain.
  • DELETEDelete voice profile domain/voice-profile-domains/:VoiceProfileDomainIdDeletes all voice profiles in the domain. WARNING: This action is not reversible.
  • GETGet global settings/settingsRetrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
  • PUTUpdate global settings/settingsUpdates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
  • GETGet phone number order/phone-number-orders/:PhoneNumberOrderIdRetrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
  • GETGet phone number settings/settings/phone-numberRetrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
  • PUTUpdate phone number settings/settings/phone-numberUpdates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling…
  • GETGet sip media application alexa skill configuration/sip-media-applications/:SipMediaApplicationId/alexa-skill-configurationDeprecated. Gets the Alexa Skill configuration for the SIP media application. Due to changes made by the Amazon Alexa service, this API is no longer available…
  • PUTPut sip media application alexa skill configuration/sip-media-applications/:SipMediaApplicationId/alexa-skill-configurationDeprecated. Updates the Alexa Skill configuration for the SIP media application. Due to changes made by the Amazon Alexa service, this API is no longer…
  • GETGet sip media application logging configuration/sip-media-applications/:SipMediaApplicationId/logging-configurationRetrieves the logging configuration for the specified SIP media application.
  • PUTPut sip media application logging configuration/sip-media-applications/:SipMediaApplicationId/logging-configurationUpdates the logging configuration for the specified SIP media application.
  • GETGet speaker search task/voice-connectors/:VoiceConnectorId/speaker-search-tasks/:SpeakerSearchTaskIdRetrieves the details of the specified speaker search task.
  • POSTStop speaker search task/voice-connectors/:VoiceConnectorId/speaker-search-tasks/:SpeakerSearchTaskId?operation=stopStops a speaker search task.
  • GETGet voice connector logging configuration/voice-connectors/:VoiceConnectorId/logging-configurationRetrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch…
  • PUTPut voice connector logging configuration/voice-connectors/:VoiceConnectorId/logging-configurationUpdates a Voice Connector's logging configuration.
  • GETGet voice connector termination health/voice-connectors/:VoiceConnectorId/termination/healthRetrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.
  • GETGet voice tone analysis task/voice-connectors/:VoiceConnectorId/voice-tone-analysis-tasks/:VoiceToneAnalysisTaskId?isCaller=trueRetrieves the details of a voice tone analysis task.
  • POSTStop voice tone analysis task/voice-connectors/:VoiceConnectorId/voice-tone-analysis-tasks/:VoiceToneAnalysisTaskId?operation=stopStops a voice tone analysis task.
  • GETList available voice connector regions/voice-connector-regionsLists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
  • GETList supported phone number countries/phone-number-countries?product-type=stringLists the countries that you can order phone numbers from.
  • GETList tags for resource/tags?arn=stringReturns a list of the tags in a given resource.
  • POSTUntag resource/tags?operation=untag-resourceRemoves tags from a resource.
  • GETSearch available phone numbers/search?type=phone-numbers&area-code=string&city=string&country=string&state=string&toll-free-prefix=string&phone-number-type=string&max-results=0&next-token=stringSearches the provisioned phone numbers in an organization.
  • POSTStart speaker search task/voice-connectors/:VoiceConnectorId/speaker-search-tasksStarts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required…
  • POSTStart voice tone analysis task/voice-connectors/:VoiceConnectorId/voice-tone-analysis-tasksStarts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK…
  • POSTUpdate sip media application call/sip-media-applications/:SipMediaApplicationId/calls/:TransactionIdInvokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new…
  • POSTValidate e911 address/emergency-calling/addressValidates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data…

API details

Base URL
https://voice-chime.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
90 operations on 42 pathsGET 37POST 22PUT 17DELETE 14
10 marked deprecated
Description format
AWS Smithy model, API version 2022-08-03

How to test the Amazon Chime SDK Voice in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Chime SDK Voice collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get voice connector” (GET /voice-connectors/:VoiceConnectorId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Chime SDK Voice?

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon… It is listed under Communication and has 90 endpoints.

Who publishes the Amazon Chime SDK Voice?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Chime SDK Voice?

Requests go to https://voice-chime.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Chime SDK Voice?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Chime SDK Voice have?

90 operations on 42 paths (37 GET, 22 POST, 17 PUT, 14 DELETE).

Is forking the Amazon Chime SDK Voice free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.