AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginClaimPhoneNumber and EndClaimPhoneNumber.

Namespace: Amazon.Connect
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<ClaimPhoneNumberResponse> ClaimPhoneNumberAsync(
         ClaimPhoneNumberRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Connect.Model.ClaimPhoneNumberRequest

Container for the necessary parameters to execute the ClaimPhoneNumber service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ClaimPhoneNumber service method, as returned by Connect.

Exceptions

ExceptionCondition
AccessDeniedException You do not have sufficient permissions to perform this action.
IdempotencyException An entity with the same name already exists.
InternalServiceException Request processing failed because of an error or failure with the service.
InvalidParameterException One or more of the specified parameters are not valid.
ResourceNotFoundException The specified resource was not found.
ThrottlingException The throttling limit has been exceeded.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also