The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
ListPhoneNumbers
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
Request Syntax
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
The request uses the following URI parameters.
- FilterName
-
The filter to use to limit the number of results.
Valid Values:
AccountId | UserId | VoiceConnectorId | VoiceConnectorGroupId | SipRuleId
- FilterValue
-
The value to use for the filter.
- 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.
- ProductType
-
The phone number product type.
Valid Values:
BusinessCalling | VoiceConnector | SipMediaApplicationDialIn
- Status
-
The phone number status.
Valid Values:
AcquireInProgress | AcquireFailed | Unassigned | Assigned | ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed
Request Body
The request does not have a request body.
Response Syntax
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",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": "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
- PhoneNumbers
-
The phone number details.
Type: Array of PhoneNumber 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
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
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 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)
Example
This example lists the phone numbers for the account.
Sample Request
GET /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: 20191028T184455Z Authorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: c859a1d1-84ce-4cfc-a3ad-4dcde29d9265 Content-Type: application/json Content-Length: 1620 Date: Mon, 28 Oct 2019 18:44:55 GMT Connection: keep-alive {"NextToken":null,"PhoneNumbers":[{"Associations":[{"AssociatedTimestamp":"2019-10-28T18:40:37.453Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno3pqr4"}],"CallingName":null,"CallingNameStatus":"UpdateInProgress","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-12T22:10:20.521Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"Voice Connector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.964Z"},{"Associations":[{"AssociatedTimestamp":"2019-10-28T18:40:37.511Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno3pqr4"}],"CallingName":null,"CallingNameStatus":"UpdateInProgress","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-12T22:10:20.521Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550101","PhoneNumberId":"%2B12065550101","ProductType":"Voice Connector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.960Z"},{"Associations":[],"CallingName":null,"CallingNameStatus":"Unassigned","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-09T21:35:21.445Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550102","PhoneNumberId":"%2B12065550102","ProductType":"Voice Connector","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:31:55.339Z"}]}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: