ListVoiceConnectors
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
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 100.
- NextToken
-
The token used to return 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",
"IntegrationType": "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 used to return the next page of results.
Type: String
- VoiceConnectors
-
The details of the 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 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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
