Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ClaimPhoneNumber

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same AWS Region where the Amazon Connect instance or traffic distribution group was created.

For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

Important

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an AWS support ticket.

Request Syntax


POST /phone-number/claim HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "InstanceId": "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. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Type: String

Length Constraints: Maximum length of 500.

Required: No

InstanceId

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

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. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

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 or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

Type: String

Required: No

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