release_phone_number

Connect.Client.release_phone_number(**kwargs)

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

Warning

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect console.

After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

See also: AWS API Documentation

Request Syntax

response = client.release_phone_number(
    PhoneNumberId='string',
    ClientToken='string'
)

Parameters

• PhoneNumberId (string) --

  [REQUIRED]

  A unique identifier for the phone number.

• 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.

  This field is autopopulated if not provided.

Returns

None

Exceptions

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