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.
Pattern:
.*\S.*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": "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",
"Name": "string",
"OrderId": "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.
- 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.
HTTP Status Code: 403
- NotFoundException
-
The requested resource couldn't be found.
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 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:
