ClaimPhoneNumber
Claims an available phone number to your Amazon Connect instance.
Request Syntax
POST /phone-number/claim HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"PhoneNumber": "string",
"PhoneNumberDescription": "string",
"Tags": {
"string" : "string"
},
"TargetArn": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Maximum length of 500.
Required: No
- PhoneNumber
-
The phone number you want to claim. Phone numbers are formatted
[+] [country code] [subscriber number including area code].Type: String
Pattern:
\\+[1-9]\\d{1,14}$Required: Yes
- PhoneNumberDescription
-
The description of the phone number.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
^[\W\S_]*Required: No
- Tags
-
The tags used to organize, track, or control access for this resource.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Maximum length of 256.
Required: No
- TargetArn
-
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"PhoneNumberArn": "string",
"PhoneNumberId": "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.
- PhoneNumberArn
-
The Amazon Resource Name (ARN) of the phone number.
Type: String
- PhoneNumberId
-
A unique identifier for the phone number.
Type: String
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
- IdempotencyException
-
An entity with the same name already exists.
HTTP Status Code: 409
- 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:
