Update Phone Number

connect_update_phone_number

R Documentation

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region

Description

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

You can call describe_phone_number API to verify the status of a previous update_phone_number operation.

Usage

connect_update_phone_number(PhoneNumberId, TargetArn, InstanceId,
  ClientToken)

Arguments

PhoneNumberId

[required] A unique identifier for the phone number.

TargetArn

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

InstanceId

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

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$update_phone_number(
  PhoneNumberId = "string",
  TargetArn = "string",
  InstanceId = "string",
  ClientToken = "string"
)