ClaimPhoneNumberCommand

Suggest an Edit

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.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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 Amazon Web Services support ticket.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, ClaimPhoneNumberCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ClaimPhoneNumberCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ClaimPhoneNumberRequest
  TargetArn: "STRING_VALUE",
  InstanceId: "STRING_VALUE",
  PhoneNumber: "STRING_VALUE", // required
  PhoneNumberDescription: "STRING_VALUE",
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
  ClientToken: "STRING_VALUE",
};
const command = new ClaimPhoneNumberCommand(input);
const response = await client.send(command);
// { // ClaimPhoneNumberResponse
//   PhoneNumberId: "STRING_VALUE",
//   PhoneNumberArn: "STRING_VALUE",
// };

ClaimPhoneNumberCommand Input

See ClaimPhoneNumberCommandInput for more details

Parameter
Type
Description
PhoneNumber
Required
string | undefined

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

ClientToken
string | undefined

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 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}$

InstanceId
string | undefined

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.

PhoneNumberDescription
string | undefined

The description of the phone number.

Tags
Record<string, string> | undefined

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

TargetArn
string | undefined

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.

ClaimPhoneNumberCommand Output

See ClaimPhoneNumberCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
PhoneNumberArn
string | undefined

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

PhoneNumberId
string | undefined

A unique identifier for the phone number.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action.

IdempotencyException
client

An entity with the same name already exists.

InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidParameterException
client

One or more of the specified parameters are not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.