connect_claim_phone_number: Claims an available phone number to your Amazon Connect...

View source: R/connect_operations.R

connect_claim_phone_numberR Documentation

Claims an available phone number to your Amazon Connect instance or traffic distribution group

Description

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.

See https://www.paws-r-sdk.com/docs/connect_claim_phone_number/ for full documentation.

Usage

connect_claim_phone_number(
  TargetArn = NULL,
  InstanceId = NULL,
  PhoneNumber,
  PhoneNumberDescription = NULL,
  Tags = NULL,
  ClientToken = NULL
)

Arguments

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.

PhoneNumber

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

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.

Pattern: ⁠^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$⁠


paws.customer.engagement documentation built on Sept. 12, 2024, 6:34 a.m.