# Amazon Chime SDK Voice
<a name="API_Operations_Amazon_Chime_SDK_Voice"></a>

The following actions are supported by Amazon Chime SDK Voice:
+  [AssociatePhoneNumbersWithVoiceConnector](API_voice-chime_AssociatePhoneNumbersWithVoiceConnector.md) 
+  [AssociatePhoneNumbersWithVoiceConnectorGroup](API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup.md) 
+  [BatchDeletePhoneNumber](API_voice-chime_BatchDeletePhoneNumber.md) 
+  [BatchUpdatePhoneNumber](API_voice-chime_BatchUpdatePhoneNumber.md) 
+  [CreatePhoneNumberOrder](API_voice-chime_CreatePhoneNumberOrder.md) 
+  [CreateProxySession](API_voice-chime_CreateProxySession.md) 
+  [CreateSipMediaApplication](API_voice-chime_CreateSipMediaApplication.md) 
+  [CreateSipMediaApplicationCall](API_voice-chime_CreateSipMediaApplicationCall.md) 
+  [CreateSipRule](API_voice-chime_CreateSipRule.md) 
+  [CreateVoiceConnector](API_voice-chime_CreateVoiceConnector.md) 
+  [CreateVoiceConnectorGroup](API_voice-chime_CreateVoiceConnectorGroup.md) 
+  [CreateVoiceProfile](API_voice-chime_CreateVoiceProfile.md) 
+  [CreateVoiceProfileDomain](API_voice-chime_CreateVoiceProfileDomain.md) 
+  [DeletePhoneNumber](API_voice-chime_DeletePhoneNumber.md) 
+  [DeleteProxySession](API_voice-chime_DeleteProxySession.md) 
+  [DeleteSipMediaApplication](API_voice-chime_DeleteSipMediaApplication.md) 
+  [DeleteSipRule](API_voice-chime_DeleteSipRule.md) 
+  [DeleteVoiceConnector](API_voice-chime_DeleteVoiceConnector.md) 
+  [DeleteVoiceConnectorEmergencyCallingConfiguration](API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration.md) 
+  [DeleteVoiceConnectorExternalSystemsConfiguration](API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration.md) 
+  [DeleteVoiceConnectorGroup](API_voice-chime_DeleteVoiceConnectorGroup.md) 
+  [DeleteVoiceConnectorOrigination](API_voice-chime_DeleteVoiceConnectorOrigination.md) 
+  [DeleteVoiceConnectorProxy](API_voice-chime_DeleteVoiceConnectorProxy.md) 
+  [DeleteVoiceConnectorStreamingConfiguration](API_voice-chime_DeleteVoiceConnectorStreamingConfiguration.md) 
+  [DeleteVoiceConnectorTermination](API_voice-chime_DeleteVoiceConnectorTermination.md) 
+  [DeleteVoiceConnectorTerminationCredentials](API_voice-chime_DeleteVoiceConnectorTerminationCredentials.md) 
+  [DeleteVoiceProfile](API_voice-chime_DeleteVoiceProfile.md) 
+  [DeleteVoiceProfileDomain](API_voice-chime_DeleteVoiceProfileDomain.md) 
+  [DisassociatePhoneNumbersFromVoiceConnector](API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector.md) 
+  [DisassociatePhoneNumbersFromVoiceConnectorGroup](API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup.md) 
+  [GetGlobalSettings](API_voice-chime_GetGlobalSettings.md) 
+  [GetPhoneNumber](API_voice-chime_GetPhoneNumber.md) 
+  [GetPhoneNumberOrder](API_voice-chime_GetPhoneNumberOrder.md) 
+  [GetPhoneNumberSettings](API_voice-chime_GetPhoneNumberSettings.md) 
+  [GetProxySession](API_voice-chime_GetProxySession.md) 
+  [GetSipMediaApplication](API_voice-chime_GetSipMediaApplication.md) 
+  [GetSipMediaApplicationAlexaSkillConfiguration](API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration.md) 
+  [GetSipMediaApplicationLoggingConfiguration](API_voice-chime_GetSipMediaApplicationLoggingConfiguration.md) 
+  [GetSipRule](API_voice-chime_GetSipRule.md) 
+  [GetSpeakerSearchTask](API_voice-chime_GetSpeakerSearchTask.md) 
+  [GetVoiceConnector](API_voice-chime_GetVoiceConnector.md) 
+  [GetVoiceConnectorEmergencyCallingConfiguration](API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration.md) 
+  [GetVoiceConnectorExternalSystemsConfiguration](API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration.md) 
+  [GetVoiceConnectorGroup](API_voice-chime_GetVoiceConnectorGroup.md) 
+  [GetVoiceConnectorLoggingConfiguration](API_voice-chime_GetVoiceConnectorLoggingConfiguration.md) 
+  [GetVoiceConnectorOrigination](API_voice-chime_GetVoiceConnectorOrigination.md) 
+  [GetVoiceConnectorProxy](API_voice-chime_GetVoiceConnectorProxy.md) 
+  [GetVoiceConnectorStreamingConfiguration](API_voice-chime_GetVoiceConnectorStreamingConfiguration.md) 
+  [GetVoiceConnectorTermination](API_voice-chime_GetVoiceConnectorTermination.md) 
+  [GetVoiceConnectorTerminationHealth](API_voice-chime_GetVoiceConnectorTerminationHealth.md) 
+  [GetVoiceProfile](API_voice-chime_GetVoiceProfile.md) 
+  [GetVoiceProfileDomain](API_voice-chime_GetVoiceProfileDomain.md) 
+  [GetVoiceToneAnalysisTask](API_voice-chime_GetVoiceToneAnalysisTask.md) 
+  [ListAvailableVoiceConnectorRegions](API_voice-chime_ListAvailableVoiceConnectorRegions.md) 
+  [ListPhoneNumberOrders](API_voice-chime_ListPhoneNumberOrders.md) 
+  [ListPhoneNumbers](API_voice-chime_ListPhoneNumbers.md) 
+  [ListProxySessions](API_voice-chime_ListProxySessions.md) 
+  [ListSipMediaApplications](API_voice-chime_ListSipMediaApplications.md) 
+  [ListSipRules](API_voice-chime_ListSipRules.md) 
+  [ListSupportedPhoneNumberCountries](API_voice-chime_ListSupportedPhoneNumberCountries.md) 
+  [ListTagsForResource](API_voice-chime_ListTagsForResource.md) 
+  [ListVoiceConnectorGroups](API_voice-chime_ListVoiceConnectorGroups.md) 
+  [ListVoiceConnectors](API_voice-chime_ListVoiceConnectors.md) 
+  [ListVoiceConnectorTerminationCredentials](API_voice-chime_ListVoiceConnectorTerminationCredentials.md) 
+  [ListVoiceProfileDomains](API_voice-chime_ListVoiceProfileDomains.md) 
+  [ListVoiceProfiles](API_voice-chime_ListVoiceProfiles.md) 
+  [PutSipMediaApplicationAlexaSkillConfiguration](API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration.md) 
+  [PutSipMediaApplicationLoggingConfiguration](API_voice-chime_PutSipMediaApplicationLoggingConfiguration.md) 
+  [PutVoiceConnectorEmergencyCallingConfiguration](API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration.md) 
+  [PutVoiceConnectorExternalSystemsConfiguration](API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration.md) 
+  [PutVoiceConnectorLoggingConfiguration](API_voice-chime_PutVoiceConnectorLoggingConfiguration.md) 
+  [PutVoiceConnectorOrigination](API_voice-chime_PutVoiceConnectorOrigination.md) 
+  [PutVoiceConnectorProxy](API_voice-chime_PutVoiceConnectorProxy.md) 
+  [PutVoiceConnectorStreamingConfiguration](API_voice-chime_PutVoiceConnectorStreamingConfiguration.md) 
+  [PutVoiceConnectorTermination](API_voice-chime_PutVoiceConnectorTermination.md) 
+  [PutVoiceConnectorTerminationCredentials](API_voice-chime_PutVoiceConnectorTerminationCredentials.md) 
+  [RestorePhoneNumber](API_voice-chime_RestorePhoneNumber.md) 
+  [SearchAvailablePhoneNumbers](API_voice-chime_SearchAvailablePhoneNumbers.md) 
+  [StartSpeakerSearchTask](API_voice-chime_StartSpeakerSearchTask.md) 
+  [StartVoiceToneAnalysisTask](API_voice-chime_StartVoiceToneAnalysisTask.md) 
+  [StopSpeakerSearchTask](API_voice-chime_StopSpeakerSearchTask.md) 
+  [StopVoiceToneAnalysisTask](API_voice-chime_StopVoiceToneAnalysisTask.md) 
+  [TagResource](API_voice-chime_TagResource.md) 
+  [UntagResource](API_voice-chime_UntagResource.md) 
+  [UpdateGlobalSettings](API_voice-chime_UpdateGlobalSettings.md) 
+  [UpdatePhoneNumber](API_voice-chime_UpdatePhoneNumber.md) 
+  [UpdatePhoneNumberSettings](API_voice-chime_UpdatePhoneNumberSettings.md) 
+  [UpdateProxySession](API_voice-chime_UpdateProxySession.md) 
+  [UpdateSipMediaApplication](API_voice-chime_UpdateSipMediaApplication.md) 
+  [UpdateSipMediaApplicationCall](API_voice-chime_UpdateSipMediaApplicationCall.md) 
+  [UpdateSipRule](API_voice-chime_UpdateSipRule.md) 
+  [UpdateVoiceConnector](API_voice-chime_UpdateVoiceConnector.md) 
+  [UpdateVoiceConnectorGroup](API_voice-chime_UpdateVoiceConnectorGroup.md) 
+  [UpdateVoiceProfile](API_voice-chime_UpdateVoiceProfile.md) 
+  [UpdateVoiceProfileDomain](API_voice-chime_UpdateVoiceProfileDomain.md) 
+  [ValidateE911Address](API_voice-chime_ValidateE911Address.md) 

# AssociatePhoneNumbersWithVoiceConnector
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector"></a>

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

## Request Syntax
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_RequestSyntax"></a>

```
POST /voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers HTTP/1.1
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ],
   "ForceAssociate": boolean
}
```

## URI Request Parameters
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnector-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [E164PhoneNumbers](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnector-request-E164PhoneNumbers"></a>
List of phone numbers, in E.164 format.  
Type: Array of strings  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

 ** [ForceAssociate](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnector-request-ForceAssociate"></a>
If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "PhoneNumberId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberErrors](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_ResponseSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnector-response-PhoneNumberErrors"></a>
If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.  
Type: Array of [PhoneNumberError](API_voice-chime_PhoneNumberError.md) objects

## Errors
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## Examples
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_Examples"></a>

In the following example or examples, the Authorization header contents(`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*. 

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. 

### Example
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_Example_1"></a>

This example associates the specified phone number with the specified Amazon Chime SDK Voice Connector.

#### Sample Request
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_Example_1_Request"></a>

```
POST /voice-connectors/abcdef1ghij2klmno3pqr4?operation=associate-phone-numbers HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T184037Z Authorization: AUTHPARAMS Content-Length: 78 {"E164PhoneNumbers": ["+12065550100", "+12065550101"], "ForceAssociate": true}
```

#### Sample Response
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_Example_1_Response"></a>

```
HTTP/1.1 200 OK x-amzn-RequestId: ac266ffd-3732-4a4a-b8dd-4b64399dde0c Content-Type: application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:40:37 GMT Connection: keep-alive {"PhoneNumberErrors":[]}
```

## See Also
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector) 

# AssociatePhoneNumbersWithVoiceConnectorGroup
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup"></a>

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

## Request Syntax
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_RequestSyntax"></a>

```
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers HTTP/1.1
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ],
   "ForceAssociate": boolean
}
```

## URI Request Parameters
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorGroupId](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup-request-uri-VoiceConnectorGroupId"></a>
The Amazon Chime SDK Voice Connector group ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [E164PhoneNumbers](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup-request-E164PhoneNumbers"></a>
List of phone numbers, in E.164 format.  
Type: Array of strings  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

 ** [ForceAssociate](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup-request-ForceAssociate"></a>
If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "PhoneNumberId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberErrors](#API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_ResponseSyntax) **   <a name="chimesdk-voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup-response-PhoneNumberErrors"></a>
If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.  
Type: Array of [PhoneNumberError](API_voice-chime_PhoneNumberError.md) objects

## Errors
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## Examples
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_Examples"></a>

In the following example or examples, the Authorization header contents( `AUTHPARAMS` ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

### Example
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_Example_1"></a>

This example associates the specified phone numbers with the specified Amazon Chime SDK Voice Connector group.

#### Sample Request
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_Example_1_Request"></a>

```
POST /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901?operation=associate-phone-numbers HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T185326Z Authorization: AUTHPARAMS Content-Length: 78 {"E164PhoneNumbers": ["+12065550100", "+12065550101"], "ForceAssociate": true}
```

#### Sample Response
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_Example_1_Response"></a>

```
HTTP/1.1 200 OK x-amzn-RequestId: 96f64ec4-db6a-41c9-9315-2517fb130c80 Content-Type: application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:53:27 GMT Connection: keep-alive {"PhoneNumberErrors":[]}
```

## See Also
<a name="API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup) 

# BatchDeletePhoneNumber
<a name="API_voice-chime_BatchDeletePhoneNumber"></a>

 Moves phone numbers into the **Deletion queue**. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted. 

 Phone numbers remain in the **Deletion queue** for 7 days before they are deleted permanently. 

## Request Syntax
<a name="API_voice-chime_BatchDeletePhoneNumber_RequestSyntax"></a>

```
POST /phone-numbers?operation=batch-delete HTTP/1.1
Content-type: application/json

{
   "PhoneNumberIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_BatchDeletePhoneNumber_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_BatchDeletePhoneNumber_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [PhoneNumberIds](#API_voice-chime_BatchDeletePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_BatchDeletePhoneNumber-request-PhoneNumberIds"></a>
List of phone number IDs.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_voice-chime_BatchDeletePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "PhoneNumberId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_BatchDeletePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberErrors](#API_voice-chime_BatchDeletePhoneNumber_ResponseSyntax) **   <a name="chimesdk-voice-chime_BatchDeletePhoneNumber-response-PhoneNumberErrors"></a>
If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.  
Type: Array of [PhoneNumberError](API_voice-chime_PhoneNumberError.md) objects

## Errors
<a name="API_voice-chime_BatchDeletePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## Examples
<a name="API_voice-chime_BatchDeletePhoneNumber_Examples"></a>

 In the following example or examples, the Authorization header contents( `AUTHPARAMS` ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

### Example
<a name="API_voice-chime_BatchDeletePhoneNumber_Example_1"></a>

 This example moves multiple phone numbers into the **Deletion queue** . 

#### Sample Request
<a name="API_voice-chime_BatchDeletePhoneNumber_Example_1_Request"></a>

```
POST /phone-numbers?operation=batch-delete HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T195348Z Authorization: AUTHPARAMS Content-Length: 56 {"PhoneNumberIds": ["%2B12065550100", "%2B12065550101"]}
```

#### Sample Response
<a name="API_voice-chime_BatchDeletePhoneNumber_Example_1_Response"></a>

```
HTTP/1.1 200 OK x-amzn-RequestId: f6ac5632-e71a-4755-997b-971c4dbff22c Content-Type: application/json Content-Length: 24 Date: Wed, 18 Sep 2019 19:53:49 GMT Connection: keep-alive {"PhoneNumberErrors":[]}
```

## See Also
<a name="API_voice-chime_BatchDeletePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber) 

# BatchUpdatePhoneNumber
<a name="API_voice-chime_BatchUpdatePhoneNumber"></a>

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each `UpdatePhoneNumberRequestItem`. For example, you can update the product type, the calling name, or phone name. 

**Note**  
You cannot have a duplicate `phoneNumberId` in a request.

## Request Syntax
<a name="API_voice-chime_BatchUpdatePhoneNumber_RequestSyntax"></a>

```
POST /phone-numbers?operation=batch-update HTTP/1.1
Content-type: application/json

{
   "UpdatePhoneNumberRequestItems": [ 
      { 
         "CallingName": "string",
         "Name": "string",
         "PhoneNumberId": "string",
         "ProductType": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_BatchUpdatePhoneNumber_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_BatchUpdatePhoneNumber_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [UpdatePhoneNumberRequestItems](#API_voice-chime_BatchUpdatePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_BatchUpdatePhoneNumber-request-UpdatePhoneNumberRequestItems"></a>
Lists the phone numbers in the update request.  
Type: Array of [UpdatePhoneNumberRequestItem](API_voice-chime_UpdatePhoneNumberRequestItem.md) objects  
Required: Yes

## Response Syntax
<a name="API_voice-chime_BatchUpdatePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "PhoneNumberId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_BatchUpdatePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberErrors](#API_voice-chime_BatchUpdatePhoneNumber_ResponseSyntax) **   <a name="chimesdk-voice-chime_BatchUpdatePhoneNumber-response-PhoneNumberErrors"></a>
A list of failed phone numbers and their error messages.  
Type: Array of [PhoneNumberError](API_voice-chime_PhoneNumberError.md) objects

## Errors
<a name="API_voice-chime_BatchUpdatePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_BatchUpdatePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber) 

# CreatePhoneNumberOrder
<a name="API_voice-chime_CreatePhoneNumberOrder"></a>

Creates 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 type.

## Request Syntax
<a name="API_voice-chime_CreatePhoneNumberOrder_RequestSyntax"></a>

```
POST /phone-number-orders HTTP/1.1
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ],
   "Name": "string",
   "ProductType": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_CreatePhoneNumberOrder_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_CreatePhoneNumberOrder_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [E164PhoneNumbers](#API_voice-chime_CreatePhoneNumberOrder_RequestSyntax) **   <a name="chimesdk-voice-chime_CreatePhoneNumberOrder-request-E164PhoneNumbers"></a>
List of phone numbers, in E.164 format.  
Type: Array of strings  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

 ** [Name](#API_voice-chime_CreatePhoneNumberOrder_RequestSyntax) **   <a name="chimesdk-voice-chime_CreatePhoneNumberOrder-request-Name"></a>
Specifies the name assigned to one or more phone numbers.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^$|^[a-zA-Z0-9\,\.\_\-]+(\s+[a-zA-Z0-9\,\.\_\-]+)*$`   
Required: No

 ** [ProductType](#API_voice-chime_CreatePhoneNumberOrder_RequestSyntax) **   <a name="chimesdk-voice-chime_CreatePhoneNumberOrder-request-ProductType"></a>
The phone number product type.  
Type: String  
Valid Values: `VoiceConnector | SipMediaApplicationDialIn`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_CreatePhoneNumberOrder_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "PhoneNumberOrder": { 
      "CreatedTimestamp": "string",
      "FocDate": "string",
      "OrderedPhoneNumbers": [ 
         { 
            "E164PhoneNumber": "string",
            "Status": "string"
         }
      ],
      "OrderType": "string",
      "PhoneNumberOrderId": "string",
      "ProductType": "string",
      "Status": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreatePhoneNumberOrder_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberOrder](#API_voice-chime_CreatePhoneNumberOrder_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreatePhoneNumberOrder-response-PhoneNumberOrder"></a>
The phone number order details.  
Type: [PhoneNumberOrder](API_voice-chime_PhoneNumberOrder.md) object

## Errors
<a name="API_voice-chime_CreatePhoneNumberOrder_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## Examples
<a name="API_voice-chime_CreatePhoneNumberOrder_Examples"></a>

In the following example or examples, the Authorization header contents( `AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

### Example
<a name="API_voice-chime_CreatePhoneNumberOrder_Example_1"></a>

This example creates an order for phone numbers to be provisioned.

#### Sample Request
<a name="API_voice-chime_CreatePhoneNumberOrder_Example_1_Request"></a>

```
POST /phone-number-orders HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T175735Z Authorization: AUTHPARAMS Content-Length: 88 {"ProductType": "BusinessCalling", "E164PhoneNumbers": ["+12065550100", "+12065550101"]}
```

#### Sample Response
<a name="API_voice-chime_CreatePhoneNumberOrder_Example_1_Response"></a>

```
HTTP/1.1 201 Created x-amzn-RequestId: 7ac7b213-6e5d-4b2a-a142-ce9a7bb7e455 Content-Type: application/json Content-Length: 366 Date: Wed, 18 Sep 2019 17:57:43 GMT Connection: keep-alive {"PhoneNumberOrder":{"CreatedTimestamp":"2019-09-18T17:57:36.280Z","OrderedPhoneNumbers":[{"E164PhoneNumber":"+12065550100","Status":"Processing"},{"E164PhoneNumber":"+12065550101","Status":"Processing"}],"PhoneNumberOrderId":"abc12345-de67-89f0-123g-h45i678j9012","ProductType":"BusinessCalling","Status":"Processing","UpdatedTimestamp":"2019-09-18T17:57:43.110Z"}}
```

## See Also
<a name="API_voice-chime_CreatePhoneNumberOrder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder) 

# CreateProxySession
<a name="API_voice-chime_CreateProxySession"></a>

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_CreateProxySession_RequestSyntax"></a>

```
POST /voice-connectors/voiceConnectorId/proxy-sessions HTTP/1.1
Content-type: application/json

{
   "Capabilities": [ "string" ],
   "ExpiryMinutes": number,
   "GeoMatchLevel": "string",
   "GeoMatchParams": { 
      "AreaCode": "string",
      "Country": "string"
   },
   "Name": "string",
   "NumberSelectionBehavior": "string",
   "ParticipantPhoneNumbers": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateProxySession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_CreateProxySession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Capabilities](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-Capabilities"></a>
The proxy session's capabilities.  
Type: Array of strings  
Valid Values: `Voice | SMS`   
Required: Yes

 ** [ExpiryMinutes](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-ExpiryMinutes"></a>
The number of minutes allowed for the proxy session.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [GeoMatchLevel](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-GeoMatchLevel"></a>
The preference for matching the country or area code of the proxy phone number with that of the first participant.  
Type: String  
Valid Values: `Country | AreaCode`   
Required: No

 ** [GeoMatchParams](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-GeoMatchParams"></a>
The country and area code for the proxy phone number.  
Type: [GeoMatchParams](API_voice-chime_GeoMatchParams.md) object  
Required: No

 ** [Name](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-Name"></a>
The name of the proxy session.  
Type: String  
Pattern: `^$|^[a-zA-Z0-9 ]{0,30}$`   
Required: No

 ** [NumberSelectionBehavior](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-NumberSelectionBehavior"></a>
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.  
Type: String  
Valid Values: `PreferSticky | AvoidSticky`   
Required: No

 ** [ParticipantPhoneNumbers](#API_voice-chime_CreateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-request-ParticipantPhoneNumbers"></a>
The participant phone numbers.  
Type: Array of strings  
Array Members: Fixed number of 2 items.  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_CreateProxySession_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "ProxySession": { 
      "Capabilities": [ "string" ],
      "CreatedTimestamp": "string",
      "EndedTimestamp": "string",
      "ExpiryMinutes": number,
      "GeoMatchLevel": "string",
      "GeoMatchParams": { 
         "AreaCode": "string",
         "Country": "string"
      },
      "Name": "string",
      "NumberSelectionBehavior": "string",
      "Participants": [ 
         { 
            "PhoneNumber": "string",
            "ProxyPhoneNumber": "string"
         }
      ],
      "ProxySessionId": "string",
      "Status": "string",
      "UpdatedTimestamp": "string",
      "VoiceConnectorId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateProxySession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ProxySession](#API_voice-chime_CreateProxySession_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateProxySession-response-ProxySession"></a>
The proxy session details.  
Type: [ProxySession](API_voice-chime_ProxySession.md) object

## Errors
<a name="API_voice-chime_CreateProxySession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateProxySession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateProxySession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateProxySession) 

# CreateSipMediaApplication
<a name="API_voice-chime_CreateSipMediaApplication"></a>

Creates a SIP media application. For more information about SIP media applications, see [Managing SIP media applications and rules](https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) in the *Amazon Chime SDK Administrator Guide*.

## Request Syntax
<a name="API_voice-chime_CreateSipMediaApplication_RequestSyntax"></a>

```
POST /sip-media-applications HTTP/1.1
Content-type: application/json

{
   "AwsRegion": "string",
   "Endpoints": [ 
      { 
         "LambdaArn": "string"
      }
   ],
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateSipMediaApplication_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_CreateSipMediaApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AwsRegion](#API_voice-chime_CreateSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplication-request-AwsRegion"></a>
The AWS Region assigned to the SIP media application.  
Type: String  
Required: Yes

 ** [Endpoints](#API_voice-chime_CreateSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplication-request-Endpoints"></a>
List of endpoints (Lambda ARNs) specified for the SIP media application.  
Type: Array of [SipMediaApplicationEndpoint](API_voice-chime_SipMediaApplicationEndpoint.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

 ** [Name](#API_voice-chime_CreateSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplication-request-Name"></a>
The SIP media application's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [Tags](#API_voice-chime_CreateSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplication-request-Tags"></a>
The tags assigned to the SIP media application.  
Type: Array of [Tag](API_voice-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_voice-chime_CreateSipMediaApplication_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "SipMediaApplication": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "Endpoints": [ 
         { 
            "LambdaArn": "string"
         }
      ],
      "Name": "string",
      "SipMediaApplicationArn": "string",
      "SipMediaApplicationId": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateSipMediaApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplication](#API_voice-chime_CreateSipMediaApplication_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplication-response-SipMediaApplication"></a>
The SIP media application details.  
Type: [SipMediaApplication](API_voice-chime_SipMediaApplication.md) object

## Errors
<a name="API_voice-chime_CreateSipMediaApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateSipMediaApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateSipMediaApplication) 

# CreateSipMediaApplicationCall
<a name="API_voice-chime_CreateSipMediaApplicationCall"></a>

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified `sipMediaApplicationId`.

## Request Syntax
<a name="API_voice-chime_CreateSipMediaApplicationCall_RequestSyntax"></a>

```
POST /sip-media-applications/sipMediaApplicationId/calls HTTP/1.1
Content-type: application/json

{
   "ArgumentsMap": { 
      "string" : "string" 
   },
   "FromPhoneNumber": "string",
   "SipHeaders": { 
      "string" : "string" 
   },
   "ToPhoneNumber": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateSipMediaApplicationCall_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_CreateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplicationCall-request-uri-SipMediaApplicationId"></a>
The ID of the SIP media application.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_CreateSipMediaApplicationCall_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ArgumentsMap](#API_voice-chime_CreateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplicationCall-request-ArgumentsMap"></a>
Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: `"FirstName": "John", "LastName": "Doe"`   
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** [FromPhoneNumber](#API_voice-chime_CreateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplicationCall-request-FromPhoneNumber"></a>
The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.  
Type: String  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

 ** [SipHeaders](#API_voice-chime_CreateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplicationCall-request-SipHeaders"></a>
The SIP headers added to an outbound call leg.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** [ToPhoneNumber](#API_voice-chime_CreateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplicationCall-request-ToPhoneNumber"></a>
The phone number that the service should call.  
Type: String  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_CreateSipMediaApplicationCall_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "SipMediaApplicationCall": { 
      "TransactionId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateSipMediaApplicationCall_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplicationCall](#API_voice-chime_CreateSipMediaApplicationCall_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateSipMediaApplicationCall-response-SipMediaApplicationCall"></a>
The actual call.  
Type: [SipMediaApplicationCall](API_voice-chime_SipMediaApplicationCall.md) object

## Errors
<a name="API_voice-chime_CreateSipMediaApplicationCall_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateSipMediaApplicationCall_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall) 

# CreateSipRule
<a name="API_voice-chime_CreateSipRule"></a>

Creates 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 [Managing SIP media applications and rules](https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) in the *Amazon Chime SDK Administrator Guide*.

## Request Syntax
<a name="API_voice-chime_CreateSipRule_RequestSyntax"></a>

```
POST /sip-rules HTTP/1.1
Content-type: application/json

{
   "Disabled": boolean,
   "Name": "string",
   "TargetApplications": [ 
      { 
         "AwsRegion": "string",
         "Priority": number,
         "SipMediaApplicationId": "string"
      }
   ],
   "TriggerType": "string",
   "TriggerValue": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateSipRule_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_CreateSipRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Disabled](#API_voice-chime_CreateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipRule-request-Disabled"></a>
Disables or enables a SIP rule. You must disable SIP rules before you can delete them.  
Type: Boolean  
Required: No

 ** [Name](#API_voice-chime_CreateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipRule-request-Name"></a>
The name of the SIP rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [TargetApplications](#API_voice-chime_CreateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipRule-request-TargetApplications"></a>
List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.  
Type: Array of [SipRuleTargetApplication](API_voice-chime_SipRuleTargetApplication.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Required: No

 ** [TriggerType](#API_voice-chime_CreateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipRule-request-TriggerType"></a>
The type of trigger assigned to the SIP rule in `TriggerValue`, currently `RequestUriHostname` or `ToPhoneNumber`.  
Type: String  
Valid Values: `ToPhoneNumber | RequestUriHostname`   
Required: Yes

 ** [TriggerValue](#API_voice-chime_CreateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateSipRule-request-TriggerValue"></a>
If `TriggerType` is `RequestUriHostname`, the value can be the outbound host name of a Voice Connector. If `TriggerType` is `ToPhoneNumber`, the value can be a customer-owned phone number in the E164 format. The `SipMediaApplication` specified in the `SipRule` is triggered if the request URI in an incoming SIP request matches the `RequestUriHostname`, or if the `To` header in the incoming SIP request matches the `ToPhoneNumber` value.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_CreateSipRule_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "SipRule": { 
      "CreatedTimestamp": "string",
      "Disabled": boolean,
      "Name": "string",
      "SipRuleId": "string",
      "TargetApplications": [ 
         { 
            "AwsRegion": "string",
            "Priority": number,
            "SipMediaApplicationId": "string"
         }
      ],
      "TriggerType": "string",
      "TriggerValue": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateSipRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [SipRule](#API_voice-chime_CreateSipRule_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateSipRule-response-SipRule"></a>
The SIP rule information, including the rule ID, triggers, and target applications.  
Type: [SipRule](API_voice-chime_SipRule.md) object

## Errors
<a name="API_voice-chime_CreateSipRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateSipRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateSipRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateSipRule) 

# CreateVoiceConnector
<a name="API_voice-chime_CreateVoiceConnector"></a>

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see [Managing Amazon Chime SDK Voice Connector groups](https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html) in the *Amazon Chime SDK Administrator Guide*.

## Request Syntax
<a name="API_voice-chime_CreateVoiceConnector_RequestSyntax"></a>

```
POST /voice-connectors HTTP/1.1
Content-type: application/json

{
   "AwsRegion": "string",
   "IntegrationType": "string",
   "Name": "string",
   "NetworkType": "string",
   "RequireEncryption": boolean,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateVoiceConnector_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_CreateVoiceConnector_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AwsRegion](#API_voice-chime_CreateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnector-request-AwsRegion"></a>
The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: `us-east-1` .  
Type: String  
Valid Values: `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`   
Required: No

 ** [IntegrationType](#API_voice-chime_CreateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnector-request-IntegrationType"></a>
The connectors for use with Amazon Connect.  
The following options are available:  
+  `CONNECT_CALL_TRANSFER_CONNECTOR` - Enables enterprises to integrate Amazon Connect with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Amazon Connect 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 Amazon Connect can start with Connect telephony and IVR for immediate modernization ahead of agent migration.
+  `CONNECT_ANALYTICS_CONNECTOR` - Enables enterprises to integrate Amazon Connect with other voice systems for real-time and post-call analytics. They can use Amazon Connect Contact Lens with their existing voice systems to provides call recordings, conversational analytics (including contact transcript, sensitive data redaction, content categorization, theme detection, sentiment analysis, real-time alerts, and post-contact summary), and agent performance evaluations (including evaluation forms, automated evaluation, supervisor review) with a rich user experience to display, search and filter customer interactions, and programmatic access to data streams and the data lake. Additionally, enterprises migrating their contact center to Amazon Connect can start with Contact Lens analytics and performance insights ahead of agent migration.
Type: String  
Valid Values: `CONNECT_CALL_TRANSFER_CONNECTOR | CONNECT_ANALYTICS_CONNECTOR`   
Required: No

 ** [Name](#API_voice-chime_CreateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnector-request-Name"></a>
The name of the Voice Connector.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [NetworkType](#API_voice-chime_CreateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnector-request-NetworkType"></a>
The type of network for the Voice Connector.  
Type: String  
Valid Values: `IPV4_ONLY | DUAL_STACK`   
Required: No

 ** [RequireEncryption](#API_voice-chime_CreateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnector-request-RequireEncryption"></a>
Enables or disables encryption for the Voice Connector.  
Type: Boolean  
Required: Yes

 ** [Tags](#API_voice-chime_CreateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnector-request-Tags"></a>
The tags assigned to the Voice Connector.  
Type: Array of [Tag](API_voice-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_voice-chime_CreateVoiceConnector_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "VoiceConnector": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "IntegrationType": "string",
      "Name": "string",
      "NetworkType": "string",
      "OutboundHostName": "string",
      "RequireEncryption": boolean,
      "UpdatedTimestamp": "string",
      "VoiceConnectorArn": "string",
      "VoiceConnectorId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateVoiceConnector_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnector](#API_voice-chime_CreateVoiceConnector_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnector-response-VoiceConnector"></a>
The details of the Voice Connector.  
Type: [VoiceConnector](API_voice-chime_VoiceConnector.md) object

## Errors
<a name="API_voice-chime_CreateVoiceConnector_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateVoiceConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateVoiceConnector) 

# CreateVoiceConnectorGroup
<a name="API_voice-chime_CreateVoiceConnectorGroup"></a>

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.

## Request Syntax
<a name="API_voice-chime_CreateVoiceConnectorGroup_RequestSyntax"></a>

```
POST /voice-connector-groups HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "VoiceConnectorItems": [ 
      { 
         "Priority": number,
         "VoiceConnectorId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateVoiceConnectorGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_CreateVoiceConnectorGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_voice-chime_CreateVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnectorGroup-request-Name"></a>
The name of the Voice Connector group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [VoiceConnectorItems](#API_voice-chime_CreateVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnectorGroup-request-VoiceConnectorItems"></a>
Lists the Voice Connectors that inbound calls are routed to.  
Type: Array of [VoiceConnectorItem](API_voice-chime_VoiceConnectorItem.md) objects  
Required: No

## Response Syntax
<a name="API_voice-chime_CreateVoiceConnectorGroup_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "VoiceConnectorGroup": { 
      "CreatedTimestamp": "string",
      "Name": "string",
      "UpdatedTimestamp": "string",
      "VoiceConnectorGroupArn": "string",
      "VoiceConnectorGroupId": "string",
      "VoiceConnectorItems": [ 
         { 
            "Priority": number,
            "VoiceConnectorId": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateVoiceConnectorGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnectorGroup](#API_voice-chime_CreateVoiceConnectorGroup_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceConnectorGroup-response-VoiceConnectorGroup"></a>
The details of the Voice Connector group.  
Type: [VoiceConnectorGroup](API_voice-chime_VoiceConnectorGroup.md) object

## Errors
<a name="API_voice-chime_CreateVoiceConnectorGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateVoiceConnectorGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup) 

# CreateVoiceProfile
<a name="API_voice-chime_CreateVoiceProfile"></a>

Creates a voice profile, which consists of an enrolled user and their latest voice print.

**Important**  
Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the [AWS service terms](https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see [Using Amazon Chime SDK Voice Analytics](https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in the *Amazon Chime SDK Developer Guide*.

## Request Syntax
<a name="API_voice-chime_CreateVoiceProfile_RequestSyntax"></a>

```
POST /voice-profiles HTTP/1.1
Content-type: application/json

{
   "SpeakerSearchTaskId": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateVoiceProfile_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_CreateVoiceProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SpeakerSearchTaskId](#API_voice-chime_CreateVoiceProfile_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfile-request-SpeakerSearchTaskId"></a>
The ID of the speaker search task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_CreateVoiceProfile_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "VoiceProfile": { 
      "CreatedTimestamp": "string",
      "ExpirationTimestamp": "string",
      "UpdatedTimestamp": "string",
      "VoiceProfileArn": "string",
      "VoiceProfileDomainId": "string",
      "VoiceProfileId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateVoiceProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [VoiceProfile](#API_voice-chime_CreateVoiceProfile_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfile-response-VoiceProfile"></a>
The requested voice profile.  
Type: [VoiceProfile](API_voice-chime_VoiceProfile.md) object

## Errors
<a name="API_voice-chime_CreateVoiceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** GoneException **   
Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.  
HTTP Status Code: 410

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateVoiceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateVoiceProfile) 

# CreateVoiceProfileDomain
<a name="API_voice-chime_CreateVoiceProfileDomain"></a>

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

**Important**  
Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the [AWS service terms](https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

For more information about voice profile domains, see [Using Amazon Chime SDK Voice Analytics](https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in the *Amazon Chime SDK Developer Guide*.

## Request Syntax
<a name="API_voice-chime_CreateVoiceProfileDomain_RequestSyntax"></a>

```
POST /voice-profile-domains HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "Description": "string",
   "Name": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyArn": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_CreateVoiceProfileDomain_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_CreateVoiceProfileDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientRequestToken](#API_voice-chime_CreateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfileDomain-request-ClientRequestToken"></a>
The unique identifier for the client request. Use a different token for different domain creation requests.  
Type: String  
Pattern: `^[-_a-zA-Z0-9]*${2,64}$`   
Required: No

 ** [Description](#API_voice-chime_CreateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfileDomain-request-Description"></a>
A description of the voice profile domain.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Name](#API_voice-chime_CreateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfileDomain-request-Name"></a>
The name of the voice profile domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [ServerSideEncryptionConfiguration](#API_voice-chime_CreateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfileDomain-request-ServerSideEncryptionConfiguration"></a>
The server-side encryption configuration for the request.  
Type: [ServerSideEncryptionConfiguration](API_voice-chime_ServerSideEncryptionConfiguration.md) object  
Required: Yes

 ** [Tags](#API_voice-chime_CreateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfileDomain-request-Tags"></a>
The tags assigned to the domain.  
Type: Array of [Tag](API_voice-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_voice-chime_CreateVoiceProfileDomain_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "VoiceProfileDomain": { 
      "CreatedTimestamp": "string",
      "Description": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyArn": "string"
      },
      "UpdatedTimestamp": "string",
      "VoiceProfileDomainArn": "string",
      "VoiceProfileDomainId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_CreateVoiceProfileDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [VoiceProfileDomain](#API_voice-chime_CreateVoiceProfileDomain_ResponseSyntax) **   <a name="chimesdk-voice-chime_CreateVoiceProfileDomain-response-VoiceProfileDomain"></a>
The requested voice profile domain.  
Type: [VoiceProfileDomain](API_voice-chime_VoiceProfileDomain.md) object

## Errors
<a name="API_voice-chime_CreateVoiceProfileDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_CreateVoiceProfileDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain) 

# DeletePhoneNumber
<a name="API_voice-chime_DeletePhoneNumber"></a>

Moves 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 can be deleted.

Deleted phone numbers remain in the **Deletion queue** queue for 7 days before they are deleted permanently.

## Request Syntax
<a name="API_voice-chime_DeletePhoneNumber_RequestSyntax"></a>

```
DELETE /phone-numbers/phoneNumberId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeletePhoneNumber_RequestParameters"></a>

The request uses the following URI parameters.

 ** [phoneNumberId](#API_voice-chime_DeletePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_DeletePhoneNumber-request-uri-PhoneNumberId"></a>
The phone number ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeletePhoneNumber_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeletePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeletePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeletePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeletePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeletePhoneNumber) 

# DeleteProxySession
<a name="API_voice-chime_DeleteProxySession"></a>

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_DeleteProxySession_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteProxySession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [proxySessionId](#API_voice-chime_DeleteProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteProxySession-request-uri-ProxySessionId"></a>
The proxy session ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

 ** [voiceConnectorId](#API_voice-chime_DeleteProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteProxySession-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteProxySession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteProxySession_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteProxySession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteProxySession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteProxySession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteProxySession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteProxySession) 

# DeleteSipMediaApplication
<a name="API_voice-chime_DeleteSipMediaApplication"></a>

Deletes a SIP media application.

## Request Syntax
<a name="API_voice-chime_DeleteSipMediaApplication_RequestSyntax"></a>

```
DELETE /sip-media-applications/sipMediaApplicationId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteSipMediaApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_DeleteSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteSipMediaApplication-request-uri-SipMediaApplicationId"></a>
The SIP media application ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteSipMediaApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteSipMediaApplication_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteSipMediaApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteSipMediaApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteSipMediaApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication) 

# DeleteSipRule
<a name="API_voice-chime_DeleteSipRule"></a>

Deletes a SIP rule.

## Request Syntax
<a name="API_voice-chime_DeleteSipRule_RequestSyntax"></a>

```
DELETE /sip-rules/sipRuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteSipRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipRuleId](#API_voice-chime_DeleteSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteSipRule-request-uri-SipRuleId"></a>
The SIP rule ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteSipRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteSipRule_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteSipRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteSipRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteSipRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteSipRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteSipRule) 

# DeleteVoiceConnector
<a name="API_voice-chime_DeleteVoiceConnector"></a>

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.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnector_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnector_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnector-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnector_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnector_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnector_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnector_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnector) 

# DeleteVoiceConnectorEmergencyCallingConfiguration
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration"></a>

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration) 

# DeleteVoiceConnectorExternalSystemsConfiguration
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration"></a>

Deletes the external systems configuration for a Voice Connector.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId/external-systems-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration-request-uri-VoiceConnectorId"></a>
The ID of the Voice Connector for which to delete the external system configuration.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorExternalSystemsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorExternalSystemsConfiguration) 

# DeleteVoiceConnectorGroup
<a name="API_voice-chime_DeleteVoiceConnectorGroup"></a>

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.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorGroup_RequestSyntax"></a>

```
DELETE /voice-connector-groups/voiceConnectorGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorGroupId](#API_voice-chime_DeleteVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorGroup-request-uri-VoiceConnectorGroupId"></a>
The Voice Connector Group ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorGroup_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup) 

# DeleteVoiceConnectorOrigination
<a name="API_voice-chime_DeleteVoiceConnectorOrigination"></a>

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector. 

**Note**  
If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorOrigination_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId/origination HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorOrigination_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnectorOrigination_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorOrigination-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorOrigination_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorOrigination_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorOrigination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorOrigination_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorOrigination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination) 

# DeleteVoiceConnectorProxy
<a name="API_voice-chime_DeleteVoiceConnectorProxy"></a>

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorProxy_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorProxy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnectorProxy_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorProxy-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorProxy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorProxy_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorProxy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy) 

# DeleteVoiceConnectorStreamingConfiguration
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration"></a>

Deletes a Voice Connector's streaming configuration.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorStreamingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorStreamingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration) 

# DeleteVoiceConnectorTermination
<a name="API_voice-chime_DeleteVoiceConnectorTermination"></a>

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.

**Note**  
If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorTermination_RequestSyntax"></a>

```
DELETE /voice-connectors/voiceConnectorId/termination HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorTermination_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnectorTermination_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorTermination-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorTermination_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorTermination_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorTermination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorTermination_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorTermination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination) 

# DeleteVoiceConnectorTerminationCredentials
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials"></a>

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials_RequestSyntax"></a>

```
POST /voice-connectors/voiceConnectorId/termination/credentials?operation=delete HTTP/1.1
Content-type: application/json

{
   "Usernames": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DeleteVoiceConnectorTerminationCredentials_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorTerminationCredentials-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Usernames](#API_voice-chime_DeleteVoiceConnectorTerminationCredentials_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceConnectorTerminationCredentials-request-Usernames"></a>
The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.  
Type: Array of strings  
Required: Yes

## Response Syntax
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceConnectorTerminationCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials) 

# DeleteVoiceProfile
<a name="API_voice-chime_DeleteVoiceProfile"></a>

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceProfile_RequestSyntax"></a>

```
DELETE /voice-profiles/VoiceProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceProfileId](#API_voice-chime_DeleteVoiceProfile_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceProfile-request-uri-VoiceProfileId"></a>
The voice profile ID.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceProfile_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceProfile) 

# DeleteVoiceProfileDomain
<a name="API_voice-chime_DeleteVoiceProfileDomain"></a>

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

## Request Syntax
<a name="API_voice-chime_DeleteVoiceProfileDomain_RequestSyntax"></a>

```
DELETE /voice-profile-domains/VoiceProfileDomainId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_DeleteVoiceProfileDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceProfileDomainId](#API_voice-chime_DeleteVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_DeleteVoiceProfileDomain-request-uri-VoiceProfileDomainId"></a>
The voice profile domain ID.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DeleteVoiceProfileDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_DeleteVoiceProfileDomain_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_DeleteVoiceProfileDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_DeleteVoiceProfileDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DeleteVoiceProfileDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain) 

# DisassociatePhoneNumbersFromVoiceConnector
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector"></a>

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

## Request Syntax
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_RequestSyntax"></a>

```
POST /voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers HTTP/1.1
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_DisassociatePhoneNumbersFromVoiceConnector-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [E164PhoneNumbers](#API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_DisassociatePhoneNumbersFromVoiceConnector-request-E164PhoneNumbers"></a>
List of phone numbers, in E.164 format.  
Type: Array of strings  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "PhoneNumberId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberErrors](#API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_ResponseSyntax) **   <a name="chimesdk-voice-chime_DisassociatePhoneNumbersFromVoiceConnector-response-PhoneNumberErrors"></a>
If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.  
Type: Array of [PhoneNumberError](API_voice-chime_PhoneNumberError.md) objects

## Errors
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector) 

# DisassociatePhoneNumbersFromVoiceConnectorGroup
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup"></a>

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

## Request Syntax
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_RequestSyntax"></a>

```
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers HTTP/1.1
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorGroupId](#API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup-request-uri-VoiceConnectorGroupId"></a>
The Voice Connector group ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [E164PhoneNumbers](#API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup-request-E164PhoneNumbers"></a>
The list of phone numbers, in E.164 format.  
Type: Array of strings  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "PhoneNumberId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberErrors](#API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_ResponseSyntax) **   <a name="chimesdk-voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup-response-PhoneNumberErrors"></a>
If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.  
Type: Array of [PhoneNumberError](API_voice-chime_PhoneNumberError.md) objects

## Errors
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup) 

# GetGlobalSettings
<a name="API_voice-chime_GetGlobalSettings"></a>

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

## Request Syntax
<a name="API_voice-chime_GetGlobalSettings_RequestSyntax"></a>

```
GET /settings HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetGlobalSettings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_GetGlobalSettings_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetGlobalSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceConnector": { 
      "CdrBucket": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetGlobalSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnector](#API_voice-chime_GetGlobalSettings_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetGlobalSettings-response-VoiceConnector"></a>
The Voice Connector settings.  
Type: [VoiceConnectorSettings](API_voice-chime_VoiceConnectorSettings.md) object

## Errors
<a name="API_voice-chime_GetGlobalSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetGlobalSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetGlobalSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetGlobalSettings) 

# GetPhoneNumber
<a name="API_voice-chime_GetPhoneNumber"></a>

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

## Request Syntax
<a name="API_voice-chime_GetPhoneNumber_RequestSyntax"></a>

```
GET /phone-numbers/phoneNumberId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetPhoneNumber_RequestParameters"></a>

The request uses the following URI parameters.

 ** [phoneNumberId](#API_voice-chime_GetPhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_GetPhoneNumber-request-uri-PhoneNumberId"></a>
The phone number ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetPhoneNumber_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetPhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumber": { 
      "Associations": [ 
         { 
            "AssociatedTimestamp": "string",
            "Name": "string",
            "Value": "string"
         }
      ],
      "CallingName": "string",
      "CallingNameStatus": "string",
      "Capabilities": { 
         "InboundCall": boolean,
         "InboundMMS": boolean,
         "InboundSMS": boolean,
         "OutboundCall": boolean,
         "OutboundMMS": boolean,
         "OutboundSMS": boolean
      },
      "Country": "string",
      "CreatedTimestamp": "string",
      "DeletionTimestamp": "string",
      "E164PhoneNumber": "string",
      "Name": "string",
      "OrderId": "string",
      "PhoneNumberId": "string",
      "ProductType": "string",
      "Status": "string",
      "Type": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetPhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumber](#API_voice-chime_GetPhoneNumber_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetPhoneNumber-response-PhoneNumber"></a>
The phone number details.  
Type: [PhoneNumber](API_voice-chime_PhoneNumber.md) object

## Errors
<a name="API_voice-chime_GetPhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetPhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetPhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetPhoneNumber) 

# GetPhoneNumberOrder
<a name="API_voice-chime_GetPhoneNumberOrder"></a>

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

## Request Syntax
<a name="API_voice-chime_GetPhoneNumberOrder_RequestSyntax"></a>

```
GET /phone-number-orders/phoneNumberOrderId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetPhoneNumberOrder_RequestParameters"></a>

The request uses the following URI parameters.

 ** [phoneNumberOrderId](#API_voice-chime_GetPhoneNumberOrder_RequestSyntax) **   <a name="chimesdk-voice-chime_GetPhoneNumberOrder-request-uri-PhoneNumberOrderId"></a>
The ID of the phone number order .  
Pattern: `[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetPhoneNumberOrder_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetPhoneNumberOrder_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberOrder": { 
      "CreatedTimestamp": "string",
      "FocDate": "string",
      "OrderedPhoneNumbers": [ 
         { 
            "E164PhoneNumber": "string",
            "Status": "string"
         }
      ],
      "OrderType": "string",
      "PhoneNumberOrderId": "string",
      "ProductType": "string",
      "Status": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetPhoneNumberOrder_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberOrder](#API_voice-chime_GetPhoneNumberOrder_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetPhoneNumberOrder-response-PhoneNumberOrder"></a>
The phone number order details.  
Type: [PhoneNumberOrder](API_voice-chime_PhoneNumberOrder.md) object

## Errors
<a name="API_voice-chime_GetPhoneNumberOrder_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetPhoneNumberOrder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder) 

# GetPhoneNumberSettings
<a name="API_voice-chime_GetPhoneNumberSettings"></a>

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

## Request Syntax
<a name="API_voice-chime_GetPhoneNumberSettings_RequestSyntax"></a>

```
GET /settings/phone-number HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetPhoneNumberSettings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_GetPhoneNumberSettings_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetPhoneNumberSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CallingName": "string",
   "CallingNameUpdatedTimestamp": "string"
}
```

## Response Elements
<a name="API_voice-chime_GetPhoneNumberSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CallingName](#API_voice-chime_GetPhoneNumberSettings_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetPhoneNumberSettings-response-CallingName"></a>
The default outbound calling name for the account.  
Type: String  
Pattern: `^$|^[a-zA-Z0-9 ]{2,15}$` 

 ** [CallingNameUpdatedTimestamp](#API_voice-chime_GetPhoneNumberSettings_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetPhoneNumberSettings-response-CallingNameUpdatedTimestamp"></a>
The updated outbound calling name timestamp, in ISO 8601 format.  
Type: Timestamp

## Errors
<a name="API_voice-chime_GetPhoneNumberSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetPhoneNumberSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings) 

# GetProxySession
<a name="API_voice-chime_GetProxySession"></a>

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_GetProxySession_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetProxySession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [proxySessionId](#API_voice-chime_GetProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_GetProxySession-request-uri-ProxySessionId"></a>
The proxy session ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

 ** [voiceConnectorId](#API_voice-chime_GetProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_GetProxySession-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetProxySession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetProxySession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ProxySession": { 
      "Capabilities": [ "string" ],
      "CreatedTimestamp": "string",
      "EndedTimestamp": "string",
      "ExpiryMinutes": number,
      "GeoMatchLevel": "string",
      "GeoMatchParams": { 
         "AreaCode": "string",
         "Country": "string"
      },
      "Name": "string",
      "NumberSelectionBehavior": "string",
      "Participants": [ 
         { 
            "PhoneNumber": "string",
            "ProxyPhoneNumber": "string"
         }
      ],
      "ProxySessionId": "string",
      "Status": "string",
      "UpdatedTimestamp": "string",
      "VoiceConnectorId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetProxySession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxySession](#API_voice-chime_GetProxySession_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetProxySession-response-ProxySession"></a>
The proxy session details.  
Type: [ProxySession](API_voice-chime_ProxySession.md) object

## Errors
<a name="API_voice-chime_GetProxySession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetProxySession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetProxySession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetProxySession) 

# GetSipMediaApplication
<a name="API_voice-chime_GetSipMediaApplication"></a>

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

## Request Syntax
<a name="API_voice-chime_GetSipMediaApplication_RequestSyntax"></a>

```
GET /sip-media-applications/sipMediaApplicationId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetSipMediaApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_GetSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_GetSipMediaApplication-request-uri-SipMediaApplicationId"></a>
The SIP media application ID .  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetSipMediaApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetSipMediaApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplication": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "Endpoints": [ 
         { 
            "LambdaArn": "string"
         }
      ],
      "Name": "string",
      "SipMediaApplicationArn": "string",
      "SipMediaApplicationId": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetSipMediaApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplication](#API_voice-chime_GetSipMediaApplication_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetSipMediaApplication-response-SipMediaApplication"></a>
The details of the SIP media application.  
Type: [SipMediaApplication](API_voice-chime_SipMediaApplication.md) object

## Errors
<a name="API_voice-chime_GetSipMediaApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetSipMediaApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetSipMediaApplication) 

# GetSipMediaApplicationAlexaSkillConfiguration
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration"></a>

Gets the Alexa Skill configuration for the SIP media application.

**Important**  
Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the [Alexa Smart Properties](https://developer.amazon.com/en-US/alexa/alexasmartproperties) page.

## Request Syntax
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_RequestSyntax"></a>

```
GET /sip-media-applications/sipMediaApplicationId/alexa-skill-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_GetSipMediaApplicationAlexaSkillConfiguration-request-uri-SipMediaApplicationId"></a>
The SIP media application ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplicationAlexaSkillConfiguration": { 
      "AlexaSkillIds": [ "string" ],
      "AlexaSkillStatus": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplicationAlexaSkillConfiguration](#API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetSipMediaApplicationAlexaSkillConfiguration-response-SipMediaApplicationAlexaSkillConfiguration"></a>
Returns the Alexa Skill configuration.  
Type: [SipMediaApplicationAlexaSkillConfiguration](API_voice-chime_SipMediaApplicationAlexaSkillConfiguration.md) object

## Errors
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetSipMediaApplicationAlexaSkillConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration) 

# GetSipMediaApplicationLoggingConfiguration
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration"></a>

Retrieves the logging configuration for the specified SIP media application.

## Request Syntax
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration_RequestSyntax"></a>

```
GET /sip-media-applications/sipMediaApplicationId/logging-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_GetSipMediaApplicationLoggingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_GetSipMediaApplicationLoggingConfiguration-request-uri-SipMediaApplicationId"></a>
The SIP media application ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplicationLoggingConfiguration": { 
      "EnableSipMediaApplicationMessageLogs": boolean
   }
}
```

## Response Elements
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplicationLoggingConfiguration](#API_voice-chime_GetSipMediaApplicationLoggingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetSipMediaApplicationLoggingConfiguration-response-SipMediaApplicationLoggingConfiguration"></a>
The actual logging configuration.  
Type: [SipMediaApplicationLoggingConfiguration](API_voice-chime_SipMediaApplicationLoggingConfiguration.md) object

## Errors
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetSipMediaApplicationLoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration) 

# GetSipRule
<a name="API_voice-chime_GetSipRule"></a>

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

## Request Syntax
<a name="API_voice-chime_GetSipRule_RequestSyntax"></a>

```
GET /sip-rules/sipRuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetSipRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipRuleId](#API_voice-chime_GetSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_GetSipRule-request-uri-SipRuleId"></a>
The SIP rule ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetSipRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetSipRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SipRule": { 
      "CreatedTimestamp": "string",
      "Disabled": boolean,
      "Name": "string",
      "SipRuleId": "string",
      "TargetApplications": [ 
         { 
            "AwsRegion": "string",
            "Priority": number,
            "SipMediaApplicationId": "string"
         }
      ],
      "TriggerType": "string",
      "TriggerValue": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetSipRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SipRule](#API_voice-chime_GetSipRule_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetSipRule-response-SipRule"></a>
The SIP rule details.  
Type: [SipRule](API_voice-chime_SipRule.md) object

## Errors
<a name="API_voice-chime_GetSipRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetSipRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetSipRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetSipRule) 

# GetSpeakerSearchTask
<a name="API_voice-chime_GetSpeakerSearchTask"></a>

Retrieves the details of the specified speaker search task.

## Request Syntax
<a name="API_voice-chime_GetSpeakerSearchTask_RequestSyntax"></a>

```
GET /voice-connectors/VoiceConnectorId/speaker-search-tasks/SpeakerSearchTaskId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetSpeakerSearchTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SpeakerSearchTaskId](#API_voice-chime_GetSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_GetSpeakerSearchTask-request-uri-SpeakerSearchTaskId"></a>
The ID of the speaker search task.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** [VoiceConnectorId](#API_voice-chime_GetSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_GetSpeakerSearchTask-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetSpeakerSearchTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetSpeakerSearchTask_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SpeakerSearchTask": { 
      "CallDetails": { 
         "IsCaller": boolean,
         "TransactionId": "string",
         "VoiceConnectorId": "string"
      },
      "CreatedTimestamp": "string",
      "SpeakerSearchDetails": { 
         "Results": [ 
            { 
               "ConfidenceScore": number,
               "VoiceProfileId": "string"
            }
         ],
         "VoiceprintGenerationStatus": "string"
      },
      "SpeakerSearchTaskId": "string",
      "SpeakerSearchTaskStatus": "string",
      "StartedTimestamp": "string",
      "StatusMessage": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetSpeakerSearchTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SpeakerSearchTask](#API_voice-chime_GetSpeakerSearchTask_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetSpeakerSearchTask-response-SpeakerSearchTask"></a>
The details of the speaker search task.  
Type: [SpeakerSearchTask](API_voice-chime_SpeakerSearchTask.md) object

## Errors
<a name="API_voice-chime_GetSpeakerSearchTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetSpeakerSearchTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask) 

# GetVoiceConnector
<a name="API_voice-chime_GetVoiceConnector"></a>

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnector_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnector_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnector-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnector_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnector_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceConnector": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "IntegrationType": "string",
      "Name": "string",
      "NetworkType": "string",
      "OutboundHostName": "string",
      "RequireEncryption": boolean,
      "UpdatedTimestamp": "string",
      "VoiceConnectorArn": "string",
      "VoiceConnectorId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnector_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnector](#API_voice-chime_GetVoiceConnector_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnector-response-VoiceConnector"></a>
The Voice Connector details.  
Type: [VoiceConnector](API_voice-chime_VoiceConnector.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnector_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnector) 

# GetVoiceConnectorEmergencyCallingConfiguration
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration"></a>

Retrieves the emergency calling configuration details for the specified Voice Connector.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorEmergencyCallingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EmergencyCallingConfiguration": { 
      "DNIS": [ 
         { 
            "CallingCountry": "string",
            "EmergencyPhoneNumber": "string",
            "TestPhoneNumber": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EmergencyCallingConfiguration](#API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorEmergencyCallingConfiguration-response-EmergencyCallingConfiguration"></a>
The details of the emergency calling configuration.  
Type: [EmergencyCallingConfiguration](API_voice-chime_EmergencyCallingConfiguration.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration) 

# GetVoiceConnectorExternalSystemsConfiguration
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration"></a>

Gets information about an external systems configuration for a Voice Connector.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/external-systems-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorExternalSystemsConfiguration-request-uri-VoiceConnectorId"></a>
The ID of the Voice Connector for which to return information about the external system configuration.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ExternalSystemsConfiguration": { 
      "ContactCenterSystemTypes": [ "string" ],
      "SessionBorderControllerTypes": [ "string" ]
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ExternalSystemsConfiguration](#API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorExternalSystemsConfiguration-response-ExternalSystemsConfiguration"></a>
An object that contains information about an external systems configuration for a Voice Connector.  
Type: [ExternalSystemsConfiguration](API_voice-chime_ExternalSystemsConfiguration.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorExternalSystemsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorExternalSystemsConfiguration) 

# GetVoiceConnectorGroup
<a name="API_voice-chime_GetVoiceConnectorGroup"></a>

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated `VoiceConnectorItems`.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorGroup_RequestSyntax"></a>

```
GET /voice-connector-groups/voiceConnectorGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorGroupId](#API_voice-chime_GetVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorGroup-request-uri-VoiceConnectorGroupId"></a>
The Voice Connector group ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceConnectorGroup": { 
      "CreatedTimestamp": "string",
      "Name": "string",
      "UpdatedTimestamp": "string",
      "VoiceConnectorGroupArn": "string",
      "VoiceConnectorGroupId": "string",
      "VoiceConnectorItems": [ 
         { 
            "Priority": number,
            "VoiceConnectorId": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnectorGroup](#API_voice-chime_GetVoiceConnectorGroup_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorGroup-response-VoiceConnectorGroup"></a>
The details of the Voice Connector group.  
Type: [VoiceConnectorGroup](API_voice-chime_VoiceConnectorGroup.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup) 

# GetVoiceConnectorLoggingConfiguration
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration"></a>

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorLoggingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorLoggingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LoggingConfiguration": { 
      "EnableMediaMetricLogs": boolean,
      "EnableSIPLogs": boolean
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LoggingConfiguration](#API_voice-chime_GetVoiceConnectorLoggingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorLoggingConfiguration-response-LoggingConfiguration"></a>
The logging configuration details .  
Type: [LoggingConfiguration](API_voice-chime_LoggingConfiguration.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorLoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration) 

# GetVoiceConnectorOrigination
<a name="API_voice-chime_GetVoiceConnectorOrigination"></a>

Retrieves the origination settings for the specified Voice Connector.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorOrigination_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/origination HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorOrigination_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorOrigination_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorOrigination-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorOrigination_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorOrigination_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Origination": { 
      "Disabled": boolean,
      "Routes": [ 
         { 
            "Host": "string",
            "Port": number,
            "Priority": number,
            "Protocol": "string",
            "Weight": number
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorOrigination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Origination](#API_voice-chime_GetVoiceConnectorOrigination_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorOrigination-response-Origination"></a>
The origination setting details.  
Type: [Origination](API_voice-chime_Origination.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorOrigination_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorOrigination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination) 

# GetVoiceConnectorProxy
<a name="API_voice-chime_GetVoiceConnectorProxy"></a>

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorProxy_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorProxy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorProxy_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorProxy-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorProxy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorProxy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Proxy": { 
      "DefaultSessionExpiryMinutes": number,
      "Disabled": boolean,
      "FallBackPhoneNumber": "string",
      "PhoneNumberCountries": [ "string" ]
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorProxy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Proxy](#API_voice-chime_GetVoiceConnectorProxy_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorProxy-response-Proxy"></a>
The proxy configuration details.  
Type: [Proxy](API_voice-chime_Proxy.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy) 

# GetVoiceConnectorStreamingConfiguration
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration"></a>

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorStreamingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorStreamingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamingConfiguration": { 
      "DataRetentionInHours": number,
      "Disabled": boolean,
      "MediaInsightsConfiguration": { 
         "ConfigurationArn": "string",
         "Disabled": boolean
      },
      "StreamingNotificationTargets": [ 
         { 
            "NotificationTarget": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StreamingConfiguration](#API_voice-chime_GetVoiceConnectorStreamingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorStreamingConfiguration-response-StreamingConfiguration"></a>
The details of the streaming configuration.  
Type: [StreamingConfiguration](API_voice-chime_StreamingConfiguration.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorStreamingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration) 

# GetVoiceConnectorTermination
<a name="API_voice-chime_GetVoiceConnectorTermination"></a>

Retrieves the termination setting details for the specified Voice Connector.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorTermination_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/termination HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorTermination_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorTermination_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorTermination-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorTermination_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorTermination_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Termination": { 
      "CallingRegions": [ "string" ],
      "CidrAllowedList": [ "string" ],
      "CpsLimit": number,
      "DefaultPhoneNumber": "string",
      "Disabled": boolean
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorTermination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Termination](#API_voice-chime_GetVoiceConnectorTermination_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorTermination-response-Termination"></a>
The termination setting details.  
Type: [Termination](API_voice-chime_Termination.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorTermination_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorTermination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination) 

# GetVoiceConnectorTerminationHealth
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth"></a>

Retrieves information about the last time a `SIP OPTIONS` ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

## Request Syntax
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/termination/health HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_GetVoiceConnectorTerminationHealth_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorTerminationHealth-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "TerminationHealth": { 
      "Source": "string",
      "Timestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TerminationHealth](#API_voice-chime_GetVoiceConnectorTerminationHealth_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceConnectorTerminationHealth-response-TerminationHealth"></a>
The termination health details.  
Type: [TerminationHealth](API_voice-chime_TerminationHealth.md) object

## Errors
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceConnectorTerminationHealth_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth) 

# GetVoiceProfile
<a name="API_voice-chime_GetVoiceProfile"></a>

Retrieves the details of the specified voice profile.

## Request Syntax
<a name="API_voice-chime_GetVoiceProfile_RequestSyntax"></a>

```
GET /voice-profiles/VoiceProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceProfileId](#API_voice-chime_GetVoiceProfile_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceProfile-request-uri-VoiceProfileId"></a>
The voice profile ID.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceProfile": { 
      "CreatedTimestamp": "string",
      "ExpirationTimestamp": "string",
      "UpdatedTimestamp": "string",
      "VoiceProfileArn": "string",
      "VoiceProfileDomainId": "string",
      "VoiceProfileId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceProfile](#API_voice-chime_GetVoiceProfile_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceProfile-response-VoiceProfile"></a>
The voice profile details.  
Type: [VoiceProfile](API_voice-chime_VoiceProfile.md) object

## Errors
<a name="API_voice-chime_GetVoiceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceProfile) 

# GetVoiceProfileDomain
<a name="API_voice-chime_GetVoiceProfileDomain"></a>

Retrieves the details of the specified voice profile domain.

## Request Syntax
<a name="API_voice-chime_GetVoiceProfileDomain_RequestSyntax"></a>

```
GET /voice-profile-domains/VoiceProfileDomainId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceProfileDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceProfileDomainId](#API_voice-chime_GetVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceProfileDomain-request-uri-VoiceProfileDomainId"></a>
The voice profile domain ID.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceProfileDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceProfileDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceProfileDomain": { 
      "CreatedTimestamp": "string",
      "Description": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyArn": "string"
      },
      "UpdatedTimestamp": "string",
      "VoiceProfileDomainArn": "string",
      "VoiceProfileDomainId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceProfileDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceProfileDomain](#API_voice-chime_GetVoiceProfileDomain_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceProfileDomain-response-VoiceProfileDomain"></a>
The details of the voice profile domain.  
Type: [VoiceProfileDomain](API_voice-chime_VoiceProfileDomain.md) object

## Errors
<a name="API_voice-chime_GetVoiceProfileDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceProfileDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain) 

# GetVoiceToneAnalysisTask
<a name="API_voice-chime_GetVoiceToneAnalysisTask"></a>

Retrieves the details of a voice tone analysis task.

## Request Syntax
<a name="API_voice-chime_GetVoiceToneAnalysisTask_RequestSyntax"></a>

```
GET /voice-connectors/VoiceConnectorId/voice-tone-analysis-tasks/VoiceToneAnalysisTaskId?isCaller=IsCaller HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_GetVoiceToneAnalysisTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IsCaller](#API_voice-chime_GetVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceToneAnalysisTask-request-uri-IsCaller"></a>
Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).  
Required: Yes

 ** [VoiceConnectorId](#API_voice-chime_GetVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceToneAnalysisTask-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

 ** [VoiceToneAnalysisTaskId](#API_voice-chime_GetVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_GetVoiceToneAnalysisTask-request-uri-VoiceToneAnalysisTaskId"></a>
The ID of the voice tone analysis task.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_GetVoiceToneAnalysisTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_GetVoiceToneAnalysisTask_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceToneAnalysisTask": { 
      "CallDetails": { 
         "IsCaller": boolean,
         "TransactionId": "string",
         "VoiceConnectorId": "string"
      },
      "CreatedTimestamp": "string",
      "StartedTimestamp": "string",
      "StatusMessage": "string",
      "UpdatedTimestamp": "string",
      "VoiceToneAnalysisTaskId": "string",
      "VoiceToneAnalysisTaskStatus": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_GetVoiceToneAnalysisTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceToneAnalysisTask](#API_voice-chime_GetVoiceToneAnalysisTask_ResponseSyntax) **   <a name="chimesdk-voice-chime_GetVoiceToneAnalysisTask-response-VoiceToneAnalysisTask"></a>
The details of the voice tone analysis task.  
Type: [VoiceToneAnalysisTask](API_voice-chime_VoiceToneAnalysisTask.md) object

## Errors
<a name="API_voice-chime_GetVoiceToneAnalysisTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_GetVoiceToneAnalysisTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask) 

# ListAvailableVoiceConnectorRegions
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions"></a>

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

## Request Syntax
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions_RequestSyntax"></a>

```
GET /voice-connector-regions HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceConnectorRegions": [ "string" ]
}
```

## Response Elements
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnectorRegions](#API_voice-chime_ListAvailableVoiceConnectorRegions_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListAvailableVoiceConnectorRegions-response-VoiceConnectorRegions"></a>
The list of AWS Regions.  
Type: Array of strings  
Valid Values: `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` 

## Errors
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListAvailableVoiceConnectorRegions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions) 

# ListPhoneNumberOrders
<a name="API_voice-chime_ListPhoneNumberOrders"></a>

Lists the phone numbers for an administrator's Amazon Chime SDK account.

## Request Syntax
<a name="API_voice-chime_ListPhoneNumberOrders_RequestSyntax"></a>

```
GET /phone-number-orders?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListPhoneNumberOrders_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListPhoneNumberOrders_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumberOrders-request-uri-MaxResults"></a>
The maximum number of results to return in a single call.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListPhoneNumberOrders_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumberOrders-request-uri-NextToken"></a>
The token used to retrieve the next page of results.

## Request Body
<a name="API_voice-chime_ListPhoneNumberOrders_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListPhoneNumberOrders_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PhoneNumberOrders": [ 
      { 
         "CreatedTimestamp": "string",
         "FocDate": "string",
         "OrderedPhoneNumbers": [ 
            { 
               "E164PhoneNumber": "string",
               "Status": "string"
            }
         ],
         "OrderType": "string",
         "PhoneNumberOrderId": "string",
         "ProductType": "string",
         "Status": "string",
         "UpdatedTimestamp": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListPhoneNumberOrders_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListPhoneNumberOrders_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumberOrders-response-NextToken"></a>
The token used to retrieve the next page of results.  
Type: String

 ** [PhoneNumberOrders](#API_voice-chime_ListPhoneNumberOrders_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumberOrders-response-PhoneNumberOrders"></a>
The phone number order details.  
Type: Array of [PhoneNumberOrder](API_voice-chime_PhoneNumberOrder.md) objects

## Errors
<a name="API_voice-chime_ListPhoneNumberOrders_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListPhoneNumberOrders_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders) 

# ListPhoneNumbers
<a name="API_voice-chime_ListPhoneNumbers"></a>

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

## Request Syntax
<a name="API_voice-chime_ListPhoneNumbers_RequestSyntax"></a>

```
GET /phone-numbers?filter-name=FilterName&filter-value=FilterValue&max-results=MaxResults&next-token=NextToken&product-type=ProductType&status=Status HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListPhoneNumbers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [FilterName](#API_voice-chime_ListPhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-request-uri-FilterName"></a>
The filter to limit the number of results.  
Valid Values: `VoiceConnectorId | VoiceConnectorGroupId | SipRuleId` 

 ** [FilterValue](#API_voice-chime_ListPhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-request-uri-FilterValue"></a>
The filter value.

 ** [MaxResults](#API_voice-chime_ListPhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-request-uri-MaxResults"></a>
The maximum number of results to return in a single call.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListPhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-request-uri-NextToken"></a>
The token used to return the next page of results.

 ** [ProductType](#API_voice-chime_ListPhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-request-uri-ProductType"></a>
The phone number product types.  
Valid Values: `VoiceConnector | SipMediaApplicationDialIn` 

 ** [Status](#API_voice-chime_ListPhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-request-uri-Status"></a>
The status of your organization's phone numbers.

## Request Body
<a name="API_voice-chime_ListPhoneNumbers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListPhoneNumbers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PhoneNumbers": [ 
      { 
         "Associations": [ 
            { 
               "AssociatedTimestamp": "string",
               "Name": "string",
               "Value": "string"
            }
         ],
         "CallingName": "string",
         "CallingNameStatus": "string",
         "Capabilities": { 
            "InboundCall": boolean,
            "InboundMMS": boolean,
            "InboundSMS": boolean,
            "OutboundCall": boolean,
            "OutboundMMS": boolean,
            "OutboundSMS": boolean
         },
         "Country": "string",
         "CreatedTimestamp": "string",
         "DeletionTimestamp": "string",
         "E164PhoneNumber": "string",
         "Name": "string",
         "OrderId": "string",
         "PhoneNumberId": "string",
         "ProductType": "string",
         "Status": "string",
         "Type": "string",
         "UpdatedTimestamp": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListPhoneNumbers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListPhoneNumbers_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-response-NextToken"></a>
The token used to return the next page of results.  
Type: String

 ** [PhoneNumbers](#API_voice-chime_ListPhoneNumbers_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListPhoneNumbers-response-PhoneNumbers"></a>
The phone number details.  
Type: Array of [PhoneNumber](API_voice-chime_PhoneNumber.md) objects

## Errors
<a name="API_voice-chime_ListPhoneNumbers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListPhoneNumbers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListPhoneNumbers) 

# ListProxySessions
<a name="API_voice-chime_ListProxySessions"></a>

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_ListProxySessions_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/proxy-sessions?max-results=MaxResults&next-token=NextToken&status=Status HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListProxySessions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListProxySessions_RequestSyntax) **   <a name="chimesdk-voice-chime_ListProxySessions-request-uri-MaxResults"></a>
The maximum number of results to return in a single call.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListProxySessions_RequestSyntax) **   <a name="chimesdk-voice-chime_ListProxySessions-request-uri-NextToken"></a>
The token used to retrieve the next page of results.  
Length Constraints: Maximum length of 65535.

 ** [Status](#API_voice-chime_ListProxySessions_RequestSyntax) **   <a name="chimesdk-voice-chime_ListProxySessions-request-uri-Status"></a>
The proxy session status.  
Valid Values: `Open | InProgress | Closed` 

 ** [voiceConnectorId](#API_voice-chime_ListProxySessions_RequestSyntax) **   <a name="chimesdk-voice-chime_ListProxySessions-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_ListProxySessions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListProxySessions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ProxySessions": [ 
      { 
         "Capabilities": [ "string" ],
         "CreatedTimestamp": "string",
         "EndedTimestamp": "string",
         "ExpiryMinutes": number,
         "GeoMatchLevel": "string",
         "GeoMatchParams": { 
            "AreaCode": "string",
            "Country": "string"
         },
         "Name": "string",
         "NumberSelectionBehavior": "string",
         "Participants": [ 
            { 
               "PhoneNumber": "string",
               "ProxyPhoneNumber": "string"
            }
         ],
         "ProxySessionId": "string",
         "Status": "string",
         "UpdatedTimestamp": "string",
         "VoiceConnectorId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListProxySessions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListProxySessions_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListProxySessions-response-NextToken"></a>
The token used to retrieve the next page of results.  
Type: String  
Length Constraints: Maximum length of 65535.

 ** [ProxySessions](#API_voice-chime_ListProxySessions_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListProxySessions-response-ProxySessions"></a>
The proxy sessions' details.  
Type: Array of [ProxySession](API_voice-chime_ProxySession.md) objects

## Errors
<a name="API_voice-chime_ListProxySessions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListProxySessions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListProxySessions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListProxySessions) 

# ListSipMediaApplications
<a name="API_voice-chime_ListSipMediaApplications"></a>

Lists the SIP media applications under the administrator's AWS account.

## Request Syntax
<a name="API_voice-chime_ListSipMediaApplications_RequestSyntax"></a>

```
GET /sip-media-applications?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListSipMediaApplications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListSipMediaApplications_RequestSyntax) **   <a name="chimesdk-voice-chime_ListSipMediaApplications-request-uri-MaxResults"></a>
The maximum number of results to return in a single call. Defaults to 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListSipMediaApplications_RequestSyntax) **   <a name="chimesdk-voice-chime_ListSipMediaApplications-request-uri-NextToken"></a>
The token used to return the next page of results.  
Length Constraints: Maximum length of 65535.

## Request Body
<a name="API_voice-chime_ListSipMediaApplications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListSipMediaApplications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SipMediaApplications": [ 
      { 
         "AwsRegion": "string",
         "CreatedTimestamp": "string",
         "Endpoints": [ 
            { 
               "LambdaArn": "string"
            }
         ],
         "Name": "string",
         "SipMediaApplicationArn": "string",
         "SipMediaApplicationId": "string",
         "UpdatedTimestamp": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListSipMediaApplications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListSipMediaApplications_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListSipMediaApplications-response-NextToken"></a>
The token used to return the next page of results.  
Type: String  
Length Constraints: Maximum length of 65535.

 ** [SipMediaApplications](#API_voice-chime_ListSipMediaApplications_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListSipMediaApplications-response-SipMediaApplications"></a>
The list of SIP media applications and application details.  
Type: Array of [SipMediaApplication](API_voice-chime_SipMediaApplication.md) objects

## Errors
<a name="API_voice-chime_ListSipMediaApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListSipMediaApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListSipMediaApplications) 

# ListSipRules
<a name="API_voice-chime_ListSipRules"></a>

Lists the SIP rules under the administrator's AWS account.

## Request Syntax
<a name="API_voice-chime_ListSipRules_RequestSyntax"></a>

```
GET /sip-rules?max-results=MaxResults&next-token=NextToken&sip-media-application=SipMediaApplicationId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListSipRules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListSipRules_RequestSyntax) **   <a name="chimesdk-voice-chime_ListSipRules-request-uri-MaxResults"></a>
The maximum number of results to return in a single call. Defaults to 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListSipRules_RequestSyntax) **   <a name="chimesdk-voice-chime_ListSipRules-request-uri-NextToken"></a>
The token used to return the next page of results.  
Length Constraints: Maximum length of 65535.

 ** [SipMediaApplicationId](#API_voice-chime_ListSipRules_RequestSyntax) **   <a name="chimesdk-voice-chime_ListSipRules-request-uri-SipMediaApplicationId"></a>
The SIP media application ID.  
Pattern: `.*\S.*` 

## Request Body
<a name="API_voice-chime_ListSipRules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListSipRules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SipRules": [ 
      { 
         "CreatedTimestamp": "string",
         "Disabled": boolean,
         "Name": "string",
         "SipRuleId": "string",
         "TargetApplications": [ 
            { 
               "AwsRegion": "string",
               "Priority": number,
               "SipMediaApplicationId": "string"
            }
         ],
         "TriggerType": "string",
         "TriggerValue": "string",
         "UpdatedTimestamp": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListSipRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListSipRules_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListSipRules-response-NextToken"></a>
The token used to return the next page of results.  
Type: String  
Length Constraints: Maximum length of 65535.

 ** [SipRules](#API_voice-chime_ListSipRules_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListSipRules-response-SipRules"></a>
The list of SIP rules and details.  
Type: Array of [SipRule](API_voice-chime_SipRule.md) objects

## Errors
<a name="API_voice-chime_ListSipRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListSipRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListSipRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListSipRules) 

# ListSupportedPhoneNumberCountries
<a name="API_voice-chime_ListSupportedPhoneNumberCountries"></a>

Lists the countries that you can order phone numbers from.

## Request Syntax
<a name="API_voice-chime_ListSupportedPhoneNumberCountries_RequestSyntax"></a>

```
GET /phone-number-countries?product-type=ProductType HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListSupportedPhoneNumberCountries_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ProductType](#API_voice-chime_ListSupportedPhoneNumberCountries_RequestSyntax) **   <a name="chimesdk-voice-chime_ListSupportedPhoneNumberCountries-request-uri-ProductType"></a>
The phone number product type.  
Valid Values: `VoiceConnector | SipMediaApplicationDialIn`   
Required: Yes

## Request Body
<a name="API_voice-chime_ListSupportedPhoneNumberCountries_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListSupportedPhoneNumberCountries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberCountries": [ 
      { 
         "CountryCode": "string",
         "SupportedPhoneNumberTypes": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListSupportedPhoneNumberCountries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberCountries](#API_voice-chime_ListSupportedPhoneNumberCountries_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListSupportedPhoneNumberCountries-response-PhoneNumberCountries"></a>
The supported phone number countries.  
Type: Array of [PhoneNumberCountry](API_voice-chime_PhoneNumberCountry.md) objects

## Errors
<a name="API_voice-chime_ListSupportedPhoneNumberCountries_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListSupportedPhoneNumberCountries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries) 

# ListTagsForResource
<a name="API_voice-chime_ListTagsForResource"></a>

Returns a list of the tags in a given resource.

## Request Syntax
<a name="API_voice-chime_ListTagsForResource_RequestSyntax"></a>

```
GET /tags?arn=ResourceARN HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceARN](#API_voice-chime_ListTagsForResource_RequestSyntax) **   <a name="chimesdk-voice-chime_ListTagsForResource-request-uri-ResourceARN"></a>
The resource ARN.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^arn[\/\:\-\_\.a-zA-Z0-9]+$`   
Required: Yes

## Request Body
<a name="API_voice-chime_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_voice-chime_ListTagsForResource_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListTagsForResource-response-Tags"></a>
The tags in the list.  
Type: Array of [Tag](API_voice-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

## Errors
<a name="API_voice-chime_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListTagsForResource) 

# ListVoiceConnectorGroups
<a name="API_voice-chime_ListVoiceConnectorGroups"></a>

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

## Request Syntax
<a name="API_voice-chime_ListVoiceConnectorGroups_RequestSyntax"></a>

```
GET /voice-connector-groups?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListVoiceConnectorGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListVoiceConnectorGroups_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectorGroups-request-uri-MaxResults"></a>
The maximum number of results to return in a single call.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListVoiceConnectorGroups_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectorGroups-request-uri-NextToken"></a>
The token used to return the next page of results.

## Request Body
<a name="API_voice-chime_ListVoiceConnectorGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListVoiceConnectorGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VoiceConnectorGroups": [ 
      { 
         "CreatedTimestamp": "string",
         "Name": "string",
         "UpdatedTimestamp": "string",
         "VoiceConnectorGroupArn": "string",
         "VoiceConnectorGroupId": "string",
         "VoiceConnectorItems": [ 
            { 
               "Priority": number,
               "VoiceConnectorId": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListVoiceConnectorGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListVoiceConnectorGroups_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectorGroups-response-NextToken"></a>
The token used to return the next page of results.  
Type: String

 ** [VoiceConnectorGroups](#API_voice-chime_ListVoiceConnectorGroups_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectorGroups-response-VoiceConnectorGroups"></a>
The details of the Voice Connector groups.  
Type: Array of [VoiceConnectorGroup](API_voice-chime_VoiceConnectorGroup.md) objects

## Errors
<a name="API_voice-chime_ListVoiceConnectorGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListVoiceConnectorGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups) 

# ListVoiceConnectors
<a name="API_voice-chime_ListVoiceConnectors"></a>

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

## Request Syntax
<a name="API_voice-chime_ListVoiceConnectors_RequestSyntax"></a>

```
GET /voice-connectors?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListVoiceConnectors_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListVoiceConnectors_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectors-request-uri-MaxResults"></a>
The maximum number of results to return in a single call.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListVoiceConnectors_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectors-request-uri-NextToken"></a>
The token used to return the next page of results.

## Request Body
<a name="API_voice-chime_ListVoiceConnectors_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListVoiceConnectors_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VoiceConnectors": [ 
      { 
         "AwsRegion": "string",
         "CreatedTimestamp": "string",
         "IntegrationType": "string",
         "Name": "string",
         "NetworkType": "string",
         "OutboundHostName": "string",
         "RequireEncryption": boolean,
         "UpdatedTimestamp": "string",
         "VoiceConnectorArn": "string",
         "VoiceConnectorId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListVoiceConnectors_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListVoiceConnectors_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectors-response-NextToken"></a>
The token used to return the next page of results.  
Type: String

 ** [VoiceConnectors](#API_voice-chime_ListVoiceConnectors_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectors-response-VoiceConnectors"></a>
The details of the Voice Connectors.  
Type: Array of [VoiceConnector](API_voice-chime_VoiceConnector.md) objects

## Errors
<a name="API_voice-chime_ListVoiceConnectors_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListVoiceConnectors_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListVoiceConnectors) 

# ListVoiceConnectorTerminationCredentials
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials"></a>

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

## Request Syntax
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials_RequestSyntax"></a>

```
GET /voice-connectors/voiceConnectorId/termination/credentials HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_ListVoiceConnectorTerminationCredentials_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectorTerminationCredentials-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Usernames": [ "string" ]
}
```

## Response Elements
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Usernames](#API_voice-chime_ListVoiceConnectorTerminationCredentials_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceConnectorTerminationCredentials-response-Usernames"></a>
A list of user names.  
Type: Array of strings

## Errors
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListVoiceConnectorTerminationCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials) 

# ListVoiceProfileDomains
<a name="API_voice-chime_ListVoiceProfileDomains"></a>

Lists the specified voice profile domains in the administrator's AWS account. 

## Request Syntax
<a name="API_voice-chime_ListVoiceProfileDomains_RequestSyntax"></a>

```
GET /voice-profile-domains?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListVoiceProfileDomains_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListVoiceProfileDomains_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfileDomains-request-uri-MaxResults"></a>
The maximum number of results to return in a single call.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListVoiceProfileDomains_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfileDomains-request-uri-NextToken"></a>
The token used to return the next page of results.

## Request Body
<a name="API_voice-chime_ListVoiceProfileDomains_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListVoiceProfileDomains_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VoiceProfileDomains": [ 
      { 
         "CreatedTimestamp": "string",
         "Description": "string",
         "Name": "string",
         "UpdatedTimestamp": "string",
         "VoiceProfileDomainArn": "string",
         "VoiceProfileDomainId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListVoiceProfileDomains_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListVoiceProfileDomains_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfileDomains-response-NextToken"></a>
The token used to return the next page of results.  
Type: String

 ** [VoiceProfileDomains](#API_voice-chime_ListVoiceProfileDomains_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfileDomains-response-VoiceProfileDomains"></a>
The list of voice profile domains.  
Type: Array of [VoiceProfileDomainSummary](API_voice-chime_VoiceProfileDomainSummary.md) objects

## Errors
<a name="API_voice-chime_ListVoiceProfileDomains_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListVoiceProfileDomains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains) 

# ListVoiceProfiles
<a name="API_voice-chime_ListVoiceProfiles"></a>

Lists the voice profiles in a voice profile domain.

## Request Syntax
<a name="API_voice-chime_ListVoiceProfiles_RequestSyntax"></a>

```
GET /voice-profiles?max-results=MaxResults&next-token=NextToken&voice-profile-domain-id=VoiceProfileDomainId HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_ListVoiceProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_voice-chime_ListVoiceProfiles_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfiles-request-uri-MaxResults"></a>
The maximum number of results in the request.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_voice-chime_ListVoiceProfiles_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfiles-request-uri-NextToken"></a>
The token used to retrieve the next page of results.

 ** [VoiceProfileDomainId](#API_voice-chime_ListVoiceProfiles_RequestSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfiles-request-uri-VoiceProfileDomainId"></a>
The ID of the voice profile domain.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_ListVoiceProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_ListVoiceProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VoiceProfiles": [ 
      { 
         "CreatedTimestamp": "string",
         "ExpirationTimestamp": "string",
         "UpdatedTimestamp": "string",
         "VoiceProfileArn": "string",
         "VoiceProfileDomainId": "string",
         "VoiceProfileId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_voice-chime_ListVoiceProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_voice-chime_ListVoiceProfiles_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfiles-response-NextToken"></a>
The token used to retrieve the next page of results.  
Type: String

 ** [VoiceProfiles](#API_voice-chime_ListVoiceProfiles_ResponseSyntax) **   <a name="chimesdk-voice-chime_ListVoiceProfiles-response-VoiceProfiles"></a>
The list of voice profiles.  
Type: Array of [VoiceProfileSummary](API_voice-chime_VoiceProfileSummary.md) objects

## Errors
<a name="API_voice-chime_ListVoiceProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ListVoiceProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ListVoiceProfiles) 

# PutSipMediaApplicationAlexaSkillConfiguration
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration"></a>

Updates the Alexa Skill configuration for the SIP media application.

**Important**  
Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the [Alexa Smart Properties](https://developer.amazon.com/en-US/alexa/alexasmartproperties) page.

## Request Syntax
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_RequestSyntax"></a>

```
PUT /sip-media-applications/sipMediaApplicationId/alexa-skill-configuration HTTP/1.1
Content-type: application/json

{
   "SipMediaApplicationAlexaSkillConfiguration": { 
      "AlexaSkillIds": [ "string" ],
      "AlexaSkillStatus": "string"
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutSipMediaApplicationAlexaSkillConfiguration-request-uri-SipMediaApplicationId"></a>
The SIP media application ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SipMediaApplicationAlexaSkillConfiguration](#API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutSipMediaApplicationAlexaSkillConfiguration-request-SipMediaApplicationAlexaSkillConfiguration"></a>
The Alexa Skill configuration.  
Type: [SipMediaApplicationAlexaSkillConfiguration](API_voice-chime_SipMediaApplicationAlexaSkillConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplicationAlexaSkillConfiguration": { 
      "AlexaSkillIds": [ "string" ],
      "AlexaSkillStatus": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplicationAlexaSkillConfiguration](#API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutSipMediaApplicationAlexaSkillConfiguration-response-SipMediaApplicationAlexaSkillConfiguration"></a>
Returns the Alexa Skill configuration.  
Type: [SipMediaApplicationAlexaSkillConfiguration](API_voice-chime_SipMediaApplicationAlexaSkillConfiguration.md) object

## Errors
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutSipMediaApplicationAlexaSkillConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration) 

# PutSipMediaApplicationLoggingConfiguration
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration"></a>

Updates the logging configuration for the specified SIP media application.

## Request Syntax
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration_RequestSyntax"></a>

```
PUT /sip-media-applications/sipMediaApplicationId/logging-configuration HTTP/1.1
Content-type: application/json

{
   "SipMediaApplicationLoggingConfiguration": { 
      "EnableSipMediaApplicationMessageLogs": boolean
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_PutSipMediaApplicationLoggingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutSipMediaApplicationLoggingConfiguration-request-uri-SipMediaApplicationId"></a>
The SIP media application ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SipMediaApplicationLoggingConfiguration](#API_voice-chime_PutSipMediaApplicationLoggingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutSipMediaApplicationLoggingConfiguration-request-SipMediaApplicationLoggingConfiguration"></a>
The logging configuration for the specified SIP media application.  
Type: [SipMediaApplicationLoggingConfiguration](API_voice-chime_SipMediaApplicationLoggingConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplicationLoggingConfiguration": { 
      "EnableSipMediaApplicationMessageLogs": boolean
   }
}
```

## Response Elements
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplicationLoggingConfiguration](#API_voice-chime_PutSipMediaApplicationLoggingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutSipMediaApplicationLoggingConfiguration-response-SipMediaApplicationLoggingConfiguration"></a>
The updated logging configuration for the specified SIP media application.  
Type: [SipMediaApplicationLoggingConfiguration](API_voice-chime_SipMediaApplicationLoggingConfiguration.md) object

## Errors
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutSipMediaApplicationLoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration) 

# PutVoiceConnectorEmergencyCallingConfiguration
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration"></a>

Updates a Voice Connector's emergency calling configuration.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1
Content-type: application/json

{
   "EmergencyCallingConfiguration": { 
      "DNIS": [ 
         { 
            "CallingCountry": "string",
            "EmergencyPhoneNumber": "string",
            "TestPhoneNumber": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorEmergencyCallingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EmergencyCallingConfiguration](#API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorEmergencyCallingConfiguration-request-EmergencyCallingConfiguration"></a>
The configuration being updated.  
Type: [EmergencyCallingConfiguration](API_voice-chime_EmergencyCallingConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EmergencyCallingConfiguration": { 
      "DNIS": [ 
         { 
            "CallingCountry": "string",
            "EmergencyPhoneNumber": "string",
            "TestPhoneNumber": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EmergencyCallingConfiguration](#API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorEmergencyCallingConfiguration-response-EmergencyCallingConfiguration"></a>
The updated configuration.  
Type: [EmergencyCallingConfiguration](API_voice-chime_EmergencyCallingConfiguration.md) object

## Errors
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration) 

# PutVoiceConnectorExternalSystemsConfiguration
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration"></a>

Adds an external systems configuration to a Voice Connector.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId/external-systems-configuration HTTP/1.1
Content-type: application/json

{
   "ContactCenterSystemTypes": [ "string" ],
   "SessionBorderControllerTypes": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorExternalSystemsConfiguration-request-uri-VoiceConnectorId"></a>
The ID of the Voice Connector for which to add the external system configuration.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactCenterSystemTypes](#API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorExternalSystemsConfiguration-request-ContactCenterSystemTypes"></a>
The contact center system to use.  
Type: Array of strings  
Valid Values: `GENESYS_ENGAGE_ON_PREMISES | AVAYA_AURA_CALL_CENTER_ELITE | AVAYA_AURA_CONTACT_CENTER | CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE`   
Required: No

 ** [SessionBorderControllerTypes](#API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorExternalSystemsConfiguration-request-SessionBorderControllerTypes"></a>
The session border controllers to use.  
Type: Array of strings  
Valid Values: `RIBBON_SBC | ORACLE_ACME_PACKET_SBC | AVAYA_SBCE | CISCO_UNIFIED_BORDER_ELEMENT | AUDIOCODES_MEDIANT_SBC`   
Required: No

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ExternalSystemsConfiguration": { 
      "ContactCenterSystemTypes": [ "string" ],
      "SessionBorderControllerTypes": [ "string" ]
   }
}
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ExternalSystemsConfiguration](#API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorExternalSystemsConfiguration-response-ExternalSystemsConfiguration"></a>
An object that contains information about an external systems configuration for a Voice Connector.  
Type: [ExternalSystemsConfiguration](API_voice-chime_ExternalSystemsConfiguration.md) object

## Errors
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorExternalSystemsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorExternalSystemsConfiguration) 

# PutVoiceConnectorLoggingConfiguration
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration"></a>

Updates a Voice Connector's logging configuration.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1
Content-type: application/json

{
   "LoggingConfiguration": { 
      "EnableMediaMetricLogs": boolean,
      "EnableSIPLogs": boolean
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorLoggingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorLoggingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [LoggingConfiguration](#API_voice-chime_PutVoiceConnectorLoggingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorLoggingConfiguration-request-LoggingConfiguration"></a>
The logging configuration being updated.  
Type: [LoggingConfiguration](API_voice-chime_LoggingConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LoggingConfiguration": { 
      "EnableMediaMetricLogs": boolean,
      "EnableSIPLogs": boolean
   }
}
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LoggingConfiguration](#API_voice-chime_PutVoiceConnectorLoggingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorLoggingConfiguration-response-LoggingConfiguration"></a>
The updated logging configuration.  
Type: [LoggingConfiguration](API_voice-chime_LoggingConfiguration.md) object

## Errors
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorLoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration) 

# PutVoiceConnectorOrigination
<a name="API_voice-chime_PutVoiceConnectorOrigination"></a>

Updates a Voice Connector's origination settings.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorOrigination_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId/origination HTTP/1.1
Content-type: application/json

{
   "Origination": { 
      "Disabled": boolean,
      "Routes": [ 
         { 
            "Host": "string",
            "Port": number,
            "Priority": number,
            "Protocol": "string",
            "Weight": number
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorOrigination_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorOrigination_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorOrigination-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorOrigination_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Origination](#API_voice-chime_PutVoiceConnectorOrigination_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorOrigination-request-Origination"></a>
The origination settings being updated.  
Type: [Origination](API_voice-chime_Origination.md) object  
Required: Yes

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorOrigination_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Origination": { 
      "Disabled": boolean,
      "Routes": [ 
         { 
            "Host": "string",
            "Port": number,
            "Priority": number,
            "Protocol": "string",
            "Weight": number
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorOrigination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Origination](#API_voice-chime_PutVoiceConnectorOrigination_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorOrigination-response-Origination"></a>
The updated origination settings.  
Type: [Origination](API_voice-chime_Origination.md) object

## Errors
<a name="API_voice-chime_PutVoiceConnectorOrigination_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorOrigination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination) 

# PutVoiceConnectorProxy
<a name="API_voice-chime_PutVoiceConnectorProxy"></a>

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorProxy_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1
Content-type: application/json

{
   "DefaultSessionExpiryMinutes": number,
   "Disabled": boolean,
   "FallBackPhoneNumber": "string",
   "PhoneNumberPoolCountries": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorProxy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorProxy_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorProxy-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorProxy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DefaultSessionExpiryMinutes](#API_voice-chime_PutVoiceConnectorProxy_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorProxy-request-DefaultSessionExpiryMinutes"></a>
The default number of minutes allowed for proxy session.  
Type: Integer  
Required: Yes

 ** [Disabled](#API_voice-chime_PutVoiceConnectorProxy_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorProxy-request-Disabled"></a>
When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.  
Type: Boolean  
Required: No

 ** [FallBackPhoneNumber](#API_voice-chime_PutVoiceConnectorProxy_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorProxy-request-FallBackPhoneNumber"></a>
The phone number to route calls to after a proxy session expires.  
Type: String  
Pattern: `^\+?[1-9]\d{1,14}$`   
Required: No

 ** [PhoneNumberPoolCountries](#API_voice-chime_PutVoiceConnectorProxy_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorProxy-request-PhoneNumberPoolCountries"></a>
The countries for proxy phone numbers to be selected from.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Pattern: `^$|^[A-Z]{2,2}$`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorProxy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Proxy": { 
      "DefaultSessionExpiryMinutes": number,
      "Disabled": boolean,
      "FallBackPhoneNumber": "string",
      "PhoneNumberCountries": [ "string" ]
   }
}
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorProxy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Proxy](#API_voice-chime_PutVoiceConnectorProxy_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorProxy-response-Proxy"></a>
The proxy configuration details.  
Type: [Proxy](API_voice-chime_Proxy.md) object

## Errors
<a name="API_voice-chime_PutVoiceConnectorProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy) 

# PutVoiceConnectorStreamingConfiguration
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration"></a>

Updates a Voice Connector's streaming configuration settings.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
Content-type: application/json

{
   "StreamingConfiguration": { 
      "DataRetentionInHours": number,
      "Disabled": boolean,
      "MediaInsightsConfiguration": { 
         "ConfigurationArn": "string",
         "Disabled": boolean
      },
      "StreamingNotificationTargets": [ 
         { 
            "NotificationTarget": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorStreamingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorStreamingConfiguration-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [StreamingConfiguration](#API_voice-chime_PutVoiceConnectorStreamingConfiguration_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorStreamingConfiguration-request-StreamingConfiguration"></a>
The streaming settings being updated.  
Type: [StreamingConfiguration](API_voice-chime_StreamingConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamingConfiguration": { 
      "DataRetentionInHours": number,
      "Disabled": boolean,
      "MediaInsightsConfiguration": { 
         "ConfigurationArn": "string",
         "Disabled": boolean
      },
      "StreamingNotificationTargets": [ 
         { 
            "NotificationTarget": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StreamingConfiguration](#API_voice-chime_PutVoiceConnectorStreamingConfiguration_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorStreamingConfiguration-response-StreamingConfiguration"></a>
The updated streaming settings.  
Type: [StreamingConfiguration](API_voice-chime_StreamingConfiguration.md) object

## Errors
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorStreamingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration) 

# PutVoiceConnectorTermination
<a name="API_voice-chime_PutVoiceConnectorTermination"></a>

Updates a Voice Connector's termination settings.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorTermination_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId/termination HTTP/1.1
Content-type: application/json

{
   "Termination": { 
      "CallingRegions": [ "string" ],
      "CidrAllowedList": [ "string" ],
      "CpsLimit": number,
      "DefaultPhoneNumber": "string",
      "Disabled": boolean
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorTermination_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorTermination_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorTermination-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorTermination_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Termination](#API_voice-chime_PutVoiceConnectorTermination_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorTermination-request-Termination"></a>
The termination settings to be updated.  
Type: [Termination](API_voice-chime_Termination.md) object  
Required: Yes

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorTermination_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Termination": { 
      "CallingRegions": [ "string" ],
      "CidrAllowedList": [ "string" ],
      "CpsLimit": number,
      "DefaultPhoneNumber": "string",
      "Disabled": boolean
   }
}
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorTermination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Termination](#API_voice-chime_PutVoiceConnectorTermination_ResponseSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorTermination-response-Termination"></a>
The updated termination settings.  
Type: [Termination](API_voice-chime_Termination.md) object

## Errors
<a name="API_voice-chime_PutVoiceConnectorTermination_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorTermination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination) 

# PutVoiceConnectorTerminationCredentials
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials"></a>

Updates a Voice Connector's termination credentials.

## Request Syntax
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials_RequestSyntax"></a>

```
POST /voice-connectors/voiceConnectorId/termination/credentials?operation=put HTTP/1.1
Content-type: application/json

{
   "Credentials": [ 
      { 
         "Password": "string",
         "Username": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_PutVoiceConnectorTerminationCredentials_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorTerminationCredentials-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Credentials](#API_voice-chime_PutVoiceConnectorTerminationCredentials_RequestSyntax) **   <a name="chimesdk-voice-chime_PutVoiceConnectorTerminationCredentials-request-Credentials"></a>
The termination credentials being updated.  
Type: Array of [Credential](API_voice-chime_Credential.md) objects  
Required: No

## Response Syntax
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_PutVoiceConnectorTerminationCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials) 

# RestorePhoneNumber
<a name="API_voice-chime_RestorePhoneNumber"></a>

Restores a deleted phone number.

## Request Syntax
<a name="API_voice-chime_RestorePhoneNumber_RequestSyntax"></a>

```
POST /phone-numbers/{phoneNumberId}?operation=restore HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_RestorePhoneNumber_RequestParameters"></a>

The request uses the following URI parameters.

 ** [phoneNumberId](#API_voice-chime_RestorePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_RestorePhoneNumber-request-uri-PhoneNumberId"></a>
The ID of the phone number being restored.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_RestorePhoneNumber_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_RestorePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumber": { 
      "Associations": [ 
         { 
            "AssociatedTimestamp": "string",
            "Name": "string",
            "Value": "string"
         }
      ],
      "CallingName": "string",
      "CallingNameStatus": "string",
      "Capabilities": { 
         "InboundCall": boolean,
         "InboundMMS": boolean,
         "InboundSMS": boolean,
         "OutboundCall": boolean,
         "OutboundMMS": boolean,
         "OutboundSMS": boolean
      },
      "Country": "string",
      "CreatedTimestamp": "string",
      "DeletionTimestamp": "string",
      "E164PhoneNumber": "string",
      "Name": "string",
      "OrderId": "string",
      "PhoneNumberId": "string",
      "ProductType": "string",
      "Status": "string",
      "Type": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_RestorePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumber](#API_voice-chime_RestorePhoneNumber_ResponseSyntax) **   <a name="chimesdk-voice-chime_RestorePhoneNumber-response-PhoneNumber"></a>
The restored phone number.  
Type: [PhoneNumber](API_voice-chime_PhoneNumber.md) object

## Errors
<a name="API_voice-chime_RestorePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_RestorePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/RestorePhoneNumber) 

# SearchAvailablePhoneNumbers
<a name="API_voice-chime_SearchAvailablePhoneNumbers"></a>

Searches the provisioned phone numbers in an organization.

## Request Syntax
<a name="API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax"></a>

```
GET /search?type=phone-numbers&area-code=AreaCode&city=City&country=Country&max-results=MaxResults&next-token=NextToken&phone-number-type=PhoneNumberType&state=State&toll-free-prefix=TollFreePrefix HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_SearchAvailablePhoneNumbers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AreaCode](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-AreaCode"></a>
Confines a search to just the phone numbers associated with the specified area code.

 ** [City](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-City"></a>
Confines a search to just the phone numbers associated with the specified city.

 ** [Country](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-Country"></a>
Confines a search to just the phone numbers associated with the specified country.  
Pattern: `[A-Z]{2}` 

 ** [MaxResults](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-MaxResults"></a>
The maximum number of results to return.  
Valid Range: Minimum value of 1. Maximum value of 500.

 ** [NextToken](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-NextToken"></a>
The token used to return the next page of results.

 ** [PhoneNumberType](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-PhoneNumberType"></a>
Confines a search to just the phone numbers associated with the specified phone number type, either **local** or **toll-free**.  
Valid Values: `Local | TollFree` 

 ** [State](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-State"></a>
Confines a search to just the phone numbers associated with the specified state.

 ** [TollFreePrefix](#API_voice-chime_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-request-uri-TollFreePrefix"></a>
Confines a search to just the phone numbers associated with the specified toll-free prefix.  
Length Constraints: Fixed length of 3.  
Pattern: `^8(00|33|44|55|66|77|88)$` 

## Request Body
<a name="API_voice-chime_SearchAvailablePhoneNumbers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_SearchAvailablePhoneNumbers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_voice-chime_SearchAvailablePhoneNumbers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [E164PhoneNumbers](#API_voice-chime_SearchAvailablePhoneNumbers_ResponseSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-response-E164PhoneNumbers"></a>
Confines a search to just the phone numbers in the E.164 format.  
Type: Array of strings  
Pattern: `^\+?[1-9]\d{1,14}$` 

 ** [NextToken](#API_voice-chime_SearchAvailablePhoneNumbers_ResponseSyntax) **   <a name="chimesdk-voice-chime_SearchAvailablePhoneNumbers-response-NextToken"></a>
The token used to return the next page of results.  
Type: String

## Errors
<a name="API_voice-chime_SearchAvailablePhoneNumbers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_SearchAvailablePhoneNumbers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers) 

# StartSpeakerSearchTask
<a name="API_voice-chime_StartSpeakerSearchTask"></a>

Starts a speaker search task.

**Important**  
Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the [AWS service terms](https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

## Request Syntax
<a name="API_voice-chime_StartSpeakerSearchTask_RequestSyntax"></a>

```
POST /voice-connectors/VoiceConnectorId/speaker-search-tasks HTTP/1.1
Content-type: application/json

{
   "CallLeg": "string",
   "ClientRequestToken": "string",
   "TransactionId": "string",
   "VoiceProfileDomainId": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_StartSpeakerSearchTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceConnectorId](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_StartSpeakerSearchTask_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CallLeg](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-CallLeg"></a>
Specifies which call leg to stream for speaker search.  
Type: String  
Valid Values: `Caller | Callee`   
Required: No

 ** [ClientRequestToken](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-ClientRequestToken"></a>
The unique identifier for the client request. Use a different token for different speaker search tasks.  
Type: String  
Pattern: `^[-_a-zA-Z0-9]*${2,64}$`   
Required: No

 ** [TransactionId](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-TransactionId"></a>
The transaction ID of the call being analyzed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** [VoiceProfileDomainId](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-VoiceProfileDomainId"></a>
The ID of the voice profile domain that will store the voice profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_StartSpeakerSearchTask_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "SpeakerSearchTask": { 
      "CallDetails": { 
         "IsCaller": boolean,
         "TransactionId": "string",
         "VoiceConnectorId": "string"
      },
      "CreatedTimestamp": "string",
      "SpeakerSearchDetails": { 
         "Results": [ 
            { 
               "ConfidenceScore": number,
               "VoiceProfileId": "string"
            }
         ],
         "VoiceprintGenerationStatus": "string"
      },
      "SpeakerSearchTaskId": "string",
      "SpeakerSearchTaskStatus": "string",
      "StartedTimestamp": "string",
      "StatusMessage": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_StartSpeakerSearchTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [SpeakerSearchTask](#API_voice-chime_StartSpeakerSearchTask_ResponseSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-response-SpeakerSearchTask"></a>
The details of the speaker search task.  
Type: [SpeakerSearchTask](API_voice-chime_SpeakerSearchTask.md) object

## Errors
<a name="API_voice-chime_StartSpeakerSearchTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** GoneException **   
Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.  
HTTP Status Code: 410

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

 ** UnprocessableEntityException **   
A well-formed request couldn't be followed due to semantic errors.  
HTTP Status Code: 422

## See Also
<a name="API_voice-chime_StartSpeakerSearchTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 

# StartVoiceToneAnalysisTask
<a name="API_voice-chime_StartVoiceToneAnalysisTask"></a>

Starts a voice tone analysis task. For more information about voice tone analysis, see [Using Amazon Chime SDK voice analytics](https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in the *Amazon Chime SDK Developer Guide*.

**Important**  
Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the [AWS service terms](https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

## Request Syntax
<a name="API_voice-chime_StartVoiceToneAnalysisTask_RequestSyntax"></a>

```
POST /voice-connectors/VoiceConnectorId/voice-tone-analysis-tasks HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "LanguageCode": "string",
   "TransactionId": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_StartVoiceToneAnalysisTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceConnectorId](#API_voice-chime_StartVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartVoiceToneAnalysisTask-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_StartVoiceToneAnalysisTask_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientRequestToken](#API_voice-chime_StartVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartVoiceToneAnalysisTask-request-ClientRequestToken"></a>
The unique identifier for the client request. Use a different token for different voice tone analysis tasks.  
Type: String  
Pattern: `^[-_a-zA-Z0-9]*${2,64}$`   
Required: No

 ** [LanguageCode](#API_voice-chime_StartVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartVoiceToneAnalysisTask-request-LanguageCode"></a>
The language code.  
Type: String  
Valid Values: `en-US`   
Required: Yes

 ** [TransactionId](#API_voice-chime_StartVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartVoiceToneAnalysisTask-request-TransactionId"></a>
The transaction ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_StartVoiceToneAnalysisTask_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "VoiceToneAnalysisTask": { 
      "CallDetails": { 
         "IsCaller": boolean,
         "TransactionId": "string",
         "VoiceConnectorId": "string"
      },
      "CreatedTimestamp": "string",
      "StartedTimestamp": "string",
      "StatusMessage": "string",
      "UpdatedTimestamp": "string",
      "VoiceToneAnalysisTaskId": "string",
      "VoiceToneAnalysisTaskStatus": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_StartVoiceToneAnalysisTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [VoiceToneAnalysisTask](#API_voice-chime_StartVoiceToneAnalysisTask_ResponseSyntax) **   <a name="chimesdk-voice-chime_StartVoiceToneAnalysisTask-response-VoiceToneAnalysisTask"></a>
The details of the voice tone analysis task.  
Type: [VoiceToneAnalysisTask](API_voice-chime_VoiceToneAnalysisTask.md) object

## Errors
<a name="API_voice-chime_StartVoiceToneAnalysisTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** GoneException **   
Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.  
HTTP Status Code: 410

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

 ** UnprocessableEntityException **   
A well-formed request couldn't be followed due to semantic errors.  
HTTP Status Code: 422

## See Also
<a name="API_voice-chime_StartVoiceToneAnalysisTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask) 

# StopSpeakerSearchTask
<a name="API_voice-chime_StopSpeakerSearchTask"></a>

Stops a speaker search task.

## Request Syntax
<a name="API_voice-chime_StopSpeakerSearchTask_RequestSyntax"></a>

```
POST /voice-connectors/VoiceConnectorId/speaker-search-tasks/{SpeakerSearchTaskId}?operation=stop HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_StopSpeakerSearchTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SpeakerSearchTaskId](#API_voice-chime_StopSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StopSpeakerSearchTask-request-uri-SpeakerSearchTaskId"></a>
The speaker search task ID.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** [VoiceConnectorId](#API_voice-chime_StopSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StopSpeakerSearchTask-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_StopSpeakerSearchTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_StopSpeakerSearchTask_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_StopSpeakerSearchTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_StopSpeakerSearchTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

 ** UnprocessableEntityException **   
A well-formed request couldn't be followed due to semantic errors.  
HTTP Status Code: 422

## See Also
<a name="API_voice-chime_StopSpeakerSearchTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask) 

# StopVoiceToneAnalysisTask
<a name="API_voice-chime_StopVoiceToneAnalysisTask"></a>

Stops a voice tone analysis task.

## Request Syntax
<a name="API_voice-chime_StopVoiceToneAnalysisTask_RequestSyntax"></a>

```
POST /voice-connectors/VoiceConnectorId/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}?operation=stop HTTP/1.1
```

## URI Request Parameters
<a name="API_voice-chime_StopVoiceToneAnalysisTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceConnectorId](#API_voice-chime_StopVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StopVoiceToneAnalysisTask-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

 ** [VoiceToneAnalysisTaskId](#API_voice-chime_StopVoiceToneAnalysisTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StopVoiceToneAnalysisTask-request-uri-VoiceToneAnalysisTaskId"></a>
The ID of the voice tone analysis task.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_StopVoiceToneAnalysisTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_voice-chime_StopVoiceToneAnalysisTask_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_StopVoiceToneAnalysisTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_StopVoiceToneAnalysisTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

 ** UnprocessableEntityException **   
A well-formed request couldn't be followed due to semantic errors.  
HTTP Status Code: 422

## See Also
<a name="API_voice-chime_StopVoiceToneAnalysisTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask) 

# TagResource
<a name="API_voice-chime_TagResource"></a>

Adds a tag to the specified resource.

## Request Syntax
<a name="API_voice-chime_TagResource_RequestSyntax"></a>

```
POST /tags?operation=tag-resource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_TagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_voice-chime_TagResource_RequestSyntax) **   <a name="chimesdk-voice-chime_TagResource-request-ResourceARN"></a>
The ARN of the resource being tagged.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^arn[\/\:\-\_\.a-zA-Z0-9]+$`   
Required: Yes

 ** [Tags](#API_voice-chime_TagResource_RequestSyntax) **   <a name="chimesdk-voice-chime_TagResource-request-Tags"></a>
A list of the tags being added to the resource.  
Type: Array of [Tag](API_voice-chime_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_voice-chime_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/TagResource) 

# UntagResource
<a name="API_voice-chime_UntagResource"></a>

Removes tags from a resource.

## Request Syntax
<a name="API_voice-chime_UntagResource_RequestSyntax"></a>

```
POST /tags?operation=untag-resource HTTP/1.1
Content-type: application/json

{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## URI Request Parameters
<a name="API_voice-chime_UntagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_UntagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_voice-chime_UntagResource_RequestSyntax) **   <a name="chimesdk-voice-chime_UntagResource-request-ResourceARN"></a>
The ARN of the resource having its tags removed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^arn[\/\:\-\_\.a-zA-Z0-9]+$`   
Required: Yes

 ** [TagKeys](#API_voice-chime_UntagResource_RequestSyntax) **   <a name="chimesdk-voice-chime_UntagResource-request-TagKeys"></a>
The keys of the tags being removed from the resource.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Syntax
<a name="API_voice-chime_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UntagResource) 

# UpdateGlobalSettings
<a name="API_voice-chime_UpdateGlobalSettings"></a>

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

## Request Syntax
<a name="API_voice-chime_UpdateGlobalSettings_RequestSyntax"></a>

```
PUT /settings HTTP/1.1
Content-type: application/json

{
   "VoiceConnector": { 
      "CdrBucket": "string"
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateGlobalSettings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_UpdateGlobalSettings_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [VoiceConnector](#API_voice-chime_UpdateGlobalSettings_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateGlobalSettings-request-VoiceConnector"></a>
The Voice Connector settings.  
Type: [VoiceConnectorSettings](API_voice-chime_VoiceConnectorSettings.md) object  
Required: No

## Response Syntax
<a name="API_voice-chime_UpdateGlobalSettings_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_UpdateGlobalSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_UpdateGlobalSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateGlobalSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateGlobalSettings) 

# UpdatePhoneNumber
<a name="API_voice-chime_UpdatePhoneNumber"></a>

Updates 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 detail at a time. For example, you can update either the product type, calling name, or phone number name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

## Request Syntax
<a name="API_voice-chime_UpdatePhoneNumber_RequestSyntax"></a>

```
POST /phone-numbers/phoneNumberId HTTP/1.1
Content-type: application/json

{
   "CallingName": "string",
   "Name": "string",
   "ProductType": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdatePhoneNumber_RequestParameters"></a>

The request uses the following URI parameters.

 ** [phoneNumberId](#API_voice-chime_UpdatePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdatePhoneNumber-request-uri-PhoneNumberId"></a>
The phone number ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdatePhoneNumber_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CallingName](#API_voice-chime_UpdatePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdatePhoneNumber-request-CallingName"></a>
The outbound calling name associated with the phone number.  
Type: String  
Pattern: `^$|^[a-zA-Z0-9 ]{2,15}$`   
Required: No

 ** [Name](#API_voice-chime_UpdatePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdatePhoneNumber-request-Name"></a>
Specifies the updated name assigned to one or more phone numbers.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^$|^[a-zA-Z0-9\,\.\_\-]+(\s+[a-zA-Z0-9\,\.\_\-]+)*$`   
Required: No

 ** [ProductType](#API_voice-chime_UpdatePhoneNumber_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdatePhoneNumber-request-ProductType"></a>
The product type.  
Type: String  
Valid Values: `VoiceConnector | SipMediaApplicationDialIn`   
Required: No

## Response Syntax
<a name="API_voice-chime_UpdatePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumber": { 
      "Associations": [ 
         { 
            "AssociatedTimestamp": "string",
            "Name": "string",
            "Value": "string"
         }
      ],
      "CallingName": "string",
      "CallingNameStatus": "string",
      "Capabilities": { 
         "InboundCall": boolean,
         "InboundMMS": boolean,
         "InboundSMS": boolean,
         "OutboundCall": boolean,
         "OutboundMMS": boolean,
         "OutboundSMS": boolean
      },
      "Country": "string",
      "CreatedTimestamp": "string",
      "DeletionTimestamp": "string",
      "E164PhoneNumber": "string",
      "Name": "string",
      "OrderId": "string",
      "PhoneNumberId": "string",
      "ProductType": "string",
      "Status": "string",
      "Type": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdatePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumber](#API_voice-chime_UpdatePhoneNumber_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdatePhoneNumber-response-PhoneNumber"></a>
The updated phone number details.  
Type: [PhoneNumber](API_voice-chime_PhoneNumber.md) object

## Errors
<a name="API_voice-chime_UpdatePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdatePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdatePhoneNumber) 

# UpdatePhoneNumberSettings
<a name="API_voice-chime_UpdatePhoneNumberSettings"></a>

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.

## Request Syntax
<a name="API_voice-chime_UpdatePhoneNumberSettings_RequestSyntax"></a>

```
PUT /settings/phone-number HTTP/1.1
Content-type: application/json

{
   "CallingName": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdatePhoneNumberSettings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_UpdatePhoneNumberSettings_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CallingName](#API_voice-chime_UpdatePhoneNumberSettings_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdatePhoneNumberSettings-request-CallingName"></a>
The default outbound calling name for the account.  
Type: String  
Pattern: `^$|^[a-zA-Z0-9 ]{2,15}$`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_UpdatePhoneNumberSettings_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_voice-chime_UpdatePhoneNumberSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_voice-chime_UpdatePhoneNumberSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdatePhoneNumberSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings) 

# UpdateProxySession
<a name="API_voice-chime_UpdateProxySession"></a>

Updates the specified proxy session details, such as voice or SMS capabilities.

**Important**  
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

## Request Syntax
<a name="API_voice-chime_UpdateProxySession_RequestSyntax"></a>

```
POST /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
Content-type: application/json

{
   "Capabilities": [ "string" ],
   "ExpiryMinutes": number
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateProxySession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [proxySessionId](#API_voice-chime_UpdateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateProxySession-request-uri-ProxySessionId"></a>
The proxy session ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

 ** [voiceConnectorId](#API_voice-chime_UpdateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateProxySession-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateProxySession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Capabilities](#API_voice-chime_UpdateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateProxySession-request-Capabilities"></a>
The proxy session capabilities.  
Type: Array of strings  
Valid Values: `Voice | SMS`   
Required: Yes

 ** [ExpiryMinutes](#API_voice-chime_UpdateProxySession_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateProxySession-request-ExpiryMinutes"></a>
The number of minutes allowed for the proxy session.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## Response Syntax
<a name="API_voice-chime_UpdateProxySession_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "ProxySession": { 
      "Capabilities": [ "string" ],
      "CreatedTimestamp": "string",
      "EndedTimestamp": "string",
      "ExpiryMinutes": number,
      "GeoMatchLevel": "string",
      "GeoMatchParams": { 
         "AreaCode": "string",
         "Country": "string"
      },
      "Name": "string",
      "NumberSelectionBehavior": "string",
      "Participants": [ 
         { 
            "PhoneNumber": "string",
            "ProxyPhoneNumber": "string"
         }
      ],
      "ProxySessionId": "string",
      "Status": "string",
      "UpdatedTimestamp": "string",
      "VoiceConnectorId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateProxySession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ProxySession](#API_voice-chime_UpdateProxySession_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateProxySession-response-ProxySession"></a>
The updated proxy session details.  
Type: [ProxySession](API_voice-chime_ProxySession.md) object

## Errors
<a name="API_voice-chime_UpdateProxySession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateProxySession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateProxySession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateProxySession) 

# UpdateSipMediaApplication
<a name="API_voice-chime_UpdateSipMediaApplication"></a>

Updates the details of the specified SIP media application.

## Request Syntax
<a name="API_voice-chime_UpdateSipMediaApplication_RequestSyntax"></a>

```
PUT /sip-media-applications/sipMediaApplicationId HTTP/1.1
Content-type: application/json

{
   "Endpoints": [ 
      { 
         "LambdaArn": "string"
      }
   ],
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateSipMediaApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_UpdateSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplication-request-uri-SipMediaApplicationId"></a>
The SIP media application ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateSipMediaApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Endpoints](#API_voice-chime_UpdateSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplication-request-Endpoints"></a>
The new set of endpoints for the specified SIP media application.  
Type: Array of [SipMediaApplicationEndpoint](API_voice-chime_SipMediaApplicationEndpoint.md) objects  
Array Members: Fixed number of 1 item.  
Required: No

 ** [Name](#API_voice-chime_UpdateSipMediaApplication_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplication-request-Name"></a>
The new name for the specified SIP media application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: No

## Response Syntax
<a name="API_voice-chime_UpdateSipMediaApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplication": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "Endpoints": [ 
         { 
            "LambdaArn": "string"
         }
      ],
      "Name": "string",
      "SipMediaApplicationArn": "string",
      "SipMediaApplicationId": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateSipMediaApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplication](#API_voice-chime_UpdateSipMediaApplication_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplication-response-SipMediaApplication"></a>
The updated SIP media application’s details.  
Type: [SipMediaApplication](API_voice-chime_SipMediaApplication.md) object

## Errors
<a name="API_voice-chime_UpdateSipMediaApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateSipMediaApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication) 

# UpdateSipMediaApplicationCall
<a name="API_voice-chime_UpdateSipMediaApplicationCall"></a>

Invokes 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 set of actions.

## Request Syntax
<a name="API_voice-chime_UpdateSipMediaApplicationCall_RequestSyntax"></a>

```
POST /sip-media-applications/sipMediaApplicationId/calls/transactionId HTTP/1.1
Content-type: application/json

{
   "Arguments": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateSipMediaApplicationCall_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipMediaApplicationId](#API_voice-chime_UpdateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplicationCall-request-uri-SipMediaApplicationId"></a>
The ID of the SIP media application handling the call.  
Pattern: `.*\S.*`   
Required: Yes

 ** [transactionId](#API_voice-chime_UpdateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplicationCall-request-uri-TransactionId"></a>
The ID of the call transaction.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateSipMediaApplicationCall_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Arguments](#API_voice-chime_UpdateSipMediaApplicationCall_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplicationCall-request-Arguments"></a>
Arguments made available to the Lambda function as part of the `CALL_UPDATE_REQUESTED` event. Can contain 0-20 key-value pairs.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 20 items.  
Required: Yes

## Response Syntax
<a name="API_voice-chime_UpdateSipMediaApplicationCall_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "SipMediaApplicationCall": { 
      "TransactionId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateSipMediaApplicationCall_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [SipMediaApplicationCall](#API_voice-chime_UpdateSipMediaApplicationCall_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateSipMediaApplicationCall-response-SipMediaApplicationCall"></a>
A `Call` instance for a SIP media application.  
Type: [SipMediaApplicationCall](API_voice-chime_SipMediaApplicationCall.md) object

## Errors
<a name="API_voice-chime_UpdateSipMediaApplicationCall_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateSipMediaApplicationCall_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall) 

# UpdateSipRule
<a name="API_voice-chime_UpdateSipRule"></a>

Updates the details of the specified SIP rule.

## Request Syntax
<a name="API_voice-chime_UpdateSipRule_RequestSyntax"></a>

```
PUT /sip-rules/sipRuleId HTTP/1.1
Content-type: application/json

{
   "Disabled": boolean,
   "Name": "string",
   "TargetApplications": [ 
      { 
         "AwsRegion": "string",
         "Priority": number,
         "SipMediaApplicationId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateSipRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sipRuleId](#API_voice-chime_UpdateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipRule-request-uri-SipRuleId"></a>
The SIP rule ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateSipRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Disabled](#API_voice-chime_UpdateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipRule-request-Disabled"></a>
The new value that indicates whether the rule is disabled.  
Type: Boolean  
Required: No

 ** [Name](#API_voice-chime_UpdateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipRule-request-Name"></a>
The new name for the specified SIP rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [TargetApplications](#API_voice-chime_UpdateSipRule_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateSipRule-request-TargetApplications"></a>
The new list of target applications.  
Type: Array of [SipRuleTargetApplication](API_voice-chime_SipRuleTargetApplication.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Required: No

## Response Syntax
<a name="API_voice-chime_UpdateSipRule_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "SipRule": { 
      "CreatedTimestamp": "string",
      "Disabled": boolean,
      "Name": "string",
      "SipRuleId": "string",
      "TargetApplications": [ 
         { 
            "AwsRegion": "string",
            "Priority": number,
            "SipMediaApplicationId": "string"
         }
      ],
      "TriggerType": "string",
      "TriggerValue": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateSipRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [SipRule](#API_voice-chime_UpdateSipRule_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateSipRule-response-SipRule"></a>
The updated SIP rule details.  
Type: [SipRule](API_voice-chime_SipRule.md) object

## Errors
<a name="API_voice-chime_UpdateSipRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateSipRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateSipRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateSipRule) 

# UpdateVoiceConnector
<a name="API_voice-chime_UpdateVoiceConnector"></a>

Updates the details for the specified Amazon Chime SDK Voice Connector.

## Request Syntax
<a name="API_voice-chime_UpdateVoiceConnector_RequestSyntax"></a>

```
PUT /voice-connectors/voiceConnectorId HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "RequireEncryption": boolean
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateVoiceConnector_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorId](#API_voice-chime_UpdateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnector-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateVoiceConnector_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_voice-chime_UpdateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnector-request-Name"></a>
The name of the Voice Connector.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [RequireEncryption](#API_voice-chime_UpdateVoiceConnector_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnector-request-RequireEncryption"></a>
When enabled, requires encryption for the Voice Connector.  
Type: Boolean  
Required: Yes

## Response Syntax
<a name="API_voice-chime_UpdateVoiceConnector_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceConnector": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "IntegrationType": "string",
      "Name": "string",
      "NetworkType": "string",
      "OutboundHostName": "string",
      "RequireEncryption": boolean,
      "UpdatedTimestamp": "string",
      "VoiceConnectorArn": "string",
      "VoiceConnectorId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateVoiceConnector_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnector](#API_voice-chime_UpdateVoiceConnector_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnector-response-VoiceConnector"></a>
The updated Voice Connector details.  
Type: [VoiceConnector](API_voice-chime_VoiceConnector.md) object

## Errors
<a name="API_voice-chime_UpdateVoiceConnector_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateVoiceConnector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateVoiceConnector) 

# UpdateVoiceConnectorGroup
<a name="API_voice-chime_UpdateVoiceConnectorGroup"></a>

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

## Request Syntax
<a name="API_voice-chime_UpdateVoiceConnectorGroup_RequestSyntax"></a>

```
PUT /voice-connector-groups/voiceConnectorGroupId HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "VoiceConnectorItems": [ 
      { 
         "Priority": number,
         "VoiceConnectorId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateVoiceConnectorGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [voiceConnectorGroupId](#API_voice-chime_UpdateVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnectorGroup-request-uri-VoiceConnectorGroupId"></a>
The Voice Connector ID.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateVoiceConnectorGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_voice-chime_UpdateVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnectorGroup-request-Name"></a>
The name of the Voice Connector group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: Yes

 ** [VoiceConnectorItems](#API_voice-chime_UpdateVoiceConnectorGroup_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnectorGroup-request-VoiceConnectorItems"></a>
The `VoiceConnectorItems` to associate with the Voice Connector group.  
Type: Array of [VoiceConnectorItem](API_voice-chime_VoiceConnectorItem.md) objects  
Required: Yes

## Response Syntax
<a name="API_voice-chime_UpdateVoiceConnectorGroup_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "VoiceConnectorGroup": { 
      "CreatedTimestamp": "string",
      "Name": "string",
      "UpdatedTimestamp": "string",
      "VoiceConnectorGroupArn": "string",
      "VoiceConnectorGroupId": "string",
      "VoiceConnectorItems": [ 
         { 
            "Priority": number,
            "VoiceConnectorId": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateVoiceConnectorGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [VoiceConnectorGroup](#API_voice-chime_UpdateVoiceConnectorGroup_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceConnectorGroup-response-VoiceConnectorGroup"></a>
The updated Voice Connector group.  
Type: [VoiceConnectorGroup](API_voice-chime_VoiceConnectorGroup.md) object

## Errors
<a name="API_voice-chime_UpdateVoiceConnectorGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateVoiceConnectorGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup) 

# UpdateVoiceProfile
<a name="API_voice-chime_UpdateVoiceProfile"></a>

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

**Important**  
As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.  
You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

## Request Syntax
<a name="API_voice-chime_UpdateVoiceProfile_RequestSyntax"></a>

```
PUT /voice-profiles/VoiceProfileId HTTP/1.1
Content-type: application/json

{
   "SpeakerSearchTaskId": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateVoiceProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceProfileId](#API_voice-chime_UpdateVoiceProfile_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceProfile-request-uri-VoiceProfileId"></a>
The profile ID.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateVoiceProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SpeakerSearchTaskId](#API_voice-chime_UpdateVoiceProfile_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceProfile-request-SpeakerSearchTaskId"></a>
The ID of the speaker search task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_UpdateVoiceProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceProfile": { 
      "CreatedTimestamp": "string",
      "ExpirationTimestamp": "string",
      "UpdatedTimestamp": "string",
      "VoiceProfileArn": "string",
      "VoiceProfileDomainId": "string",
      "VoiceProfileId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateVoiceProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceProfile](#API_voice-chime_UpdateVoiceProfile_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceProfile-response-VoiceProfile"></a>
The updated voice profile settings.  
Type: [VoiceProfile](API_voice-chime_VoiceProfile.md) object

## Errors
<a name="API_voice-chime_UpdateVoiceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** GoneException **   
Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.  
HTTP Status Code: 410

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateVoiceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateVoiceProfile) 

# UpdateVoiceProfileDomain
<a name="API_voice-chime_UpdateVoiceProfileDomain"></a>

Updates the settings for the specified voice profile domain.

## Request Syntax
<a name="API_voice-chime_UpdateVoiceProfileDomain_RequestSyntax"></a>

```
PUT /voice-profile-domains/VoiceProfileDomainId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_UpdateVoiceProfileDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [VoiceProfileDomainId](#API_voice-chime_UpdateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceProfileDomain-request-uri-VoiceProfileDomainId"></a>
The domain ID.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_voice-chime_UpdateVoiceProfileDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_voice-chime_UpdateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceProfileDomain-request-Description"></a>
The description of the voice profile domain.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Name](#API_voice-chime_UpdateVoiceProfileDomain_RequestSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceProfileDomain-request-Name"></a>
The name of the voice profile domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.-]+`   
Required: No

## Response Syntax
<a name="API_voice-chime_UpdateVoiceProfileDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "VoiceProfileDomain": { 
      "CreatedTimestamp": "string",
      "Description": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyArn": "string"
      },
      "UpdatedTimestamp": "string",
      "VoiceProfileDomainArn": "string",
      "VoiceProfileDomainId": "string"
   }
}
```

## Response Elements
<a name="API_voice-chime_UpdateVoiceProfileDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VoiceProfileDomain](#API_voice-chime_UpdateVoiceProfileDomain_ResponseSyntax) **   <a name="chimesdk-voice-chime_UpdateVoiceProfileDomain-response-VoiceProfileDomain"></a>
The updated details of the voice profile domain.  
Type: [VoiceProfileDomain](API_voice-chime_VoiceProfileDomain.md) object

## Errors
<a name="API_voice-chime_UpdateVoiceProfileDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_UpdateVoiceProfileDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain) 

# ValidateE911Address
<a name="API_voice-chime_ValidateE911Address"></a>

Validates 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 Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

## Request Syntax
<a name="API_voice-chime_ValidateE911Address_RequestSyntax"></a>

```
POST /emergency-calling/address HTTP/1.1
Content-type: application/json

{
   "AwsAccountId": "string",
   "City": "string",
   "Country": "string",
   "PostalCode": "string",
   "State": "string",
   "StreetInfo": "string",
   "StreetNumber": "string"
}
```

## URI Request Parameters
<a name="API_voice-chime_ValidateE911Address_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_voice-chime_ValidateE911Address_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AwsAccountId](#API_voice-chime_ValidateE911Address_RequestSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-request-AwsAccountId"></a>
The AWS account ID.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

 ** [City](#API_voice-chime_ValidateE911Address_RequestSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-request-City"></a>
The address city, such as `Portland`.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

 ** [Country](#API_voice-chime_ValidateE911Address_RequestSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-request-Country"></a>
The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as `US`. For more information, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) in Wikipedia.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

 ** [PostalCode](#API_voice-chime_ValidateE911Address_RequestSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-request-PostalCode"></a>
The dress postal code, such `04352`.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

 ** [State](#API_voice-chime_ValidateE911Address_RequestSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-request-State"></a>
The address state, such as `ME`.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

 ** [StreetInfo](#API_voice-chime_ValidateE911Address_RequestSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-request-StreetInfo"></a>
The address street information, such as `8th Avenue`.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

 ** [StreetNumber](#API_voice-chime_ValidateE911Address_RequestSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-request-StreetNumber"></a>
The address street number, such as `200` or `2121`.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

## Response Syntax
<a name="API_voice-chime_ValidateE911Address_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "Address": { 
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "postalCodePlus4": "string",
      "postDirectional": "string",
      "preDirectional": "string",
      "state": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetSuffix": "string"
   },
   "AddressExternalId": "string",
   "CandidateAddressList": [ 
      { 
         "city": "string",
         "country": "string",
         "postalCode": "string",
         "postalCodePlus4": "string",
         "state": "string",
         "streetInfo": "string",
         "streetNumber": "string"
      }
   ],
   "ValidationResult": number
}
```

## Response Elements
<a name="API_voice-chime_ValidateE911Address_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [Address](#API_voice-chime_ValidateE911Address_ResponseSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-response-Address"></a>
The validated address.  
Type: [Address](API_voice-chime_Address.md) object

 ** [AddressExternalId](#API_voice-chime_ValidateE911Address_ResponseSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-response-AddressExternalId"></a>
The ID that represents the address.  
Type: String

 ** [CandidateAddressList](#API_voice-chime_ValidateE911Address_ResponseSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-response-CandidateAddressList"></a>
The list of address suggestions..  
Type: Array of [CandidateAddress](API_voice-chime_CandidateAddress.md) objects

 ** [ValidationResult](#API_voice-chime_ValidateE911Address_ResponseSyntax) **   <a name="chimesdk-voice-chime_ValidateE911Address-response-ValidationResult"></a>
Number indicating the result of address validation.  
Each possible result is defined as follows:  
+  `0` - Address validation succeeded.
+  `1` - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.
+  `2` - Address validation failed. You should re-submit the validation request with candidates from the `CandidateAddressList` result, if it's a close match.
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

## Errors
<a name="API_voice-chime_ValidateE911Address_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

## See Also
<a name="API_voice-chime_ValidateE911Address_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/ValidateE911Address) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/ValidateE911Address)