GetPhoneNumber - Amazon Chime

GetPhoneNumber

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Request Syntax

GET /phone-numbers/phoneNumberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId

The phone number ID.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "PhoneNumber": { "Associations": [ { "AssociatedTimestamp": number, "Name": "string", "Value": "string" } ], "CallingName": "string", "CallingNameStatus": "string", "Capabilities": { "InboundCall": boolean, "InboundMMS": boolean, "InboundSMS": boolean, "OutboundCall": boolean, "OutboundMMS": boolean, "OutboundSMS": boolean }, "CreatedTimestamp": number, "DeletionTimestamp": number, "E164PhoneNumber": "string", "PhoneNumberId": "string", "ProductType": "string", "Status": "string", "Type": "string", "UpdatedTimestamp": number } }

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.

PhoneNumber

The phone number details.

Type: PhoneNumber object

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. For example, when a user tries to create an account from an unsupported Region.

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

Example

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 retrieves details for the specified phone number ID.

Sample Request

GET /phone-numbers/%2B12065550100 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: 20191028T184310Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 4105c588-140d-4904-a0ed-80be2157ebcf Content-Type: application/json Content-Length: 581 Date: Mon, 28 Oct 2019 18:43:10 GMT Connection: keep-alive {"PhoneNumber":{"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":"VoiceConnector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.964Z"}}

See Also

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