Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services 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.

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.

post/phone-number/claim

Request body

TargetArnstring required

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

PhoneNumberstring required

The phone number you want to claim. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.

PhoneNumberDescriptionstring

The description of the phone number.

Tagsobject

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

ClientTokenstring
<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p> <p>Pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code> </p>

Response

Success

PhoneNumberIdstring

A unique identifier for the phone number.

PhoneNumberArnstring

The Amazon Resource Name (ARN) of the phone number.