AssociatePhoneNumbersWithVoiceConnector - Amazon Chime SDK


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

Request Syntax

POST /voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers HTTP/1.1 Content-type: application/json { "E164PhoneNumbers": [ "string" ], "ForceAssociate": boolean }

URI Request Parameters

The request uses the following URI parameters.


The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.


List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes


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

HTTP/1.1 200 Content-type: application/json { "PhoneNumberErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "PhoneNumberId": "string" } ] }

Response Elements

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

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


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 objects


For information about the errors that are common to all actions, see Common Errors.


You don't have the permissions needed to run this action.

HTTP Status Code: 403


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


The client is permanently forbidden from making the request.

HTTP Status Code: 403


The requested resource couldn't be found.

HTTP Status Code: 404


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429


The client isn't authorized to request a resource.

HTTP Status Code: 401


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 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) or one of the AWS SDKs 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.


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

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4?operation=associate-phone-numbers HTTP/1.1 Host: 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

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

For more information about using this API in one of the language-specific AWS SDKs, see the following: