DescribePhoneNumber
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
Important
If the number is claimed to a traffic distribution group, and you are calling in the AWS Region
where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the
PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group
and you are calling this API in the alternate AWS Region associated with the
traffic distribution group, you must provide a full phone number ARN. If a UUID is provided
in
this scenario, you receive a ResourceNotFoundException.
Request Syntax
GET /phone-number/PhoneNumberId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- PhoneNumberId
-
A unique identifier for the phone number.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ClaimedPhoneNumberSummary": {
"InstanceId": "string",
"PhoneNumber": "string",
"PhoneNumberArn": "string",
"PhoneNumberCountryCode": "string",
"PhoneNumberDescription": "string",
"PhoneNumberId": "string",
"PhoneNumberStatus": {
"Message": "string",
"Status": "string"
},
"PhoneNumberType": "string",
"SourcePhoneNumberArn": "string",
"Tags": {
"string" : "string"
},
"TargetArn": "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.
- ClaimedPhoneNumberSummary
-
Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.
Type: ClaimedPhoneNumberSummary object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
