Skip to content

Import Phone Number

connect_import_phone_number R Documentation

Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance

Description

Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

Call the describe_phone_number API to verify the status of a previous import_phone_number operation.

If you plan to claim or import numbers and then 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 or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then 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 or importing any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed or imported 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_import_phone_number(InstanceId, SourcePhoneNumberArn,
  PhoneNumberDescription, Tags, ClientToken)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

SourcePhoneNumberArn

[required] The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to import from Amazon Pinpoint.

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.

Value

A list with the following syntax: 

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

Request syntax

svc$import_phone_number(
  InstanceId = "string",
  SourcePhoneNumberArn = "string",
  PhoneNumberDescription = "string",
  Tags = list(
    "string"
  ),
  ClientToken = "string"
)