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.

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"
)