claim_phone_number

claim_phone_number(**kwargs)

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 .

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.claim_phone_number(
    TargetArn='string',
    PhoneNumber='string',
    PhoneNumberDescription='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)

Parameters

• TargetArn (string) --

  [REQUIRED]

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

• PhoneNumber (string) --

  [REQUIRED]

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

• PhoneNumberDescription (string) -- The description of the phone number.
• Tags (dict) --

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

  • (string) --
    • (string) --
• ClientToken (string) --

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

  This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'PhoneNumberId': 'string',
    'PhoneNumberArn': 'string'
}

Response Structure

• (dict) --

  • PhoneNumberId (string) --

    A unique identifier for the phone number.

  • PhoneNumberArn (string) --

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

Exceptions

• Connect.Client.exceptions.InvalidParameterException
• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.ThrottlingException
• Connect.Client.exceptions.InternalServiceException
• Connect.Client.exceptions.IdempotencyException
• Connect.Client.exceptions.AccessDeniedException