Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListVoiceConnectors

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Important

This API is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Request Syntax


GET /voice-connectors?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken

The token to use to retrieve the next page of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VoiceConnectors": [ 
      { 
         "AwsRegion": "string",
         "CreatedTimestamp": "string",
         "Name": "string",
         "OutboundHostName": "string",
         "RequireEncryption": boolean,
         "UpdatedTimestamp": "string",
         "VoiceConnectorArn": "string",
         "VoiceConnectorId": "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.

NextToken

The token to use to retrieve the next page of results.

Type: String

VoiceConnectors

The details of the Amazon Chime Voice Connectors.

Type: Array of VoiceConnector objects

Errors

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

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 client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples

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.

Example

This example lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Sample Request


GET /voice-connectors 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: 20190918T203740Z Authorization: AUTHPARAMS

Sample Response


HTTP/1.1 200 OK x-amzn-RequestId: 47fa6799-3b53-43c7-b80d-00fb064c55d8 Content-Type: application/json Content-Length: 603 Date: Wed, 18 Sep 2019 20:37:41 GMT Connection: keep-alive {"NextToken":null,"Voice Connectors":[{"AwsRegion":"us-east-1","CreatedTimestamp":"2019-06-04T18:46:56.508Z","Name":"myVoiceConnector","OutboundHostName":"abcdef1ghij2klmno3pqr5.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T16:33:00.806Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr5"},{"AwsRegion":"us-west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T20:34:01.352Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}]}