Skip to content

Claim Phone Number

connect_claim_phone_number R Documentation

Claims an available phone number to your Amazon Connect instance or traffic distribution group

Description

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 search_available_phone_numbers API for available phone numbers that you can claim. Call the describe_phone_number API to verify the status of a previous claim_phone_number 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.

Usage

connect_claim_phone_number(TargetArn, InstanceId, PhoneNumber,
  PhoneNumberDescription, Tags, ClientToken)

Arguments

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.

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.

PhoneNumber

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

PhoneNumberDescription

The description of the phone number.

Tags

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

ClientToken

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

Value

A list with the following syntax: 

list(
  PhoneNumberId = "string",
  PhoneNumberArn = "string"
)

Request syntax

svc$claim_phone_number(
  TargetArn = "string",
  InstanceId = "string",
  PhoneNumber = "string",
  PhoneNumberDescription = "string",
  Tags = list(
    "string"
  ),
  ClientToken = "string"
)