Skip to content

/AWS1/CL_CNTCLAIMEDPHONENOSUMM

Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_phonenumberid TYPE /AWS1/CNTPHONENUMBERID /AWS1/CNTPHONENUMBERID

A unique identifier for the phone number.

iv_phonenumberarn TYPE /AWS1/CNTARN /AWS1/CNTARN

The Amazon Resource Name (ARN) of the phone number.

iv_phonenumber TYPE /AWS1/CNTPHONENUMBER /AWS1/CNTPHONENUMBER

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

iv_phonenumbercountrycode TYPE /AWS1/CNTPHONENUMCOUNTRYCODE /AWS1/CNTPHONENUMCOUNTRYCODE

The ISO country code.

iv_phonenumbertype TYPE /AWS1/CNTPHONENUMBERTYPE /AWS1/CNTPHONENUMBERTYPE

The type of phone number.

iv_phonenumberdescription TYPE /AWS1/CNTPHONENUMBERDESC /AWS1/CNTPHONENUMBERDESC

The description of the phone number.

iv_targetarn TYPE /AWS1/CNTARN /AWS1/CNTARN

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

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

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.

it_tags TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

io_phonenumberstatus TYPE REF TO /AWS1/CL_CNTPHONENUMBERSTATUS /AWS1/CL_CNTPHONENUMBERSTATUS

The status of the phone number.

  • CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

  • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

  • FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

You will not be billed for the phone number during the 1-day period if number claiming fails.

iv_sourcephonenumberarn TYPE /AWS1/CNTARN /AWS1/CNTARN

The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.

Queryable Attributes

PhoneNumberId

A unique identifier for the phone number.

Accessible with the following methods

Method Description
GET_PHONENUMBERID() Getter for PHONENUMBERID, with configurable default
ASK_PHONENUMBERID() Getter for PHONENUMBERID w/ exceptions if field has no value
HAS_PHONENUMBERID() Determine if PHONENUMBERID has a value

PhoneNumberArn

The Amazon Resource Name (ARN) of the phone number.

Accessible with the following methods

Method Description
GET_PHONENUMBERARN() Getter for PHONENUMBERARN, with configurable default
ASK_PHONENUMBERARN() Getter for PHONENUMBERARN w/ exceptions if field has no valu
HAS_PHONENUMBERARN() Determine if PHONENUMBERARN has a value

PhoneNumber

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

Accessible with the following methods

Method Description
GET_PHONENUMBER() Getter for PHONENUMBER, with configurable default
ASK_PHONENUMBER() Getter for PHONENUMBER w/ exceptions if field has no value
HAS_PHONENUMBER() Determine if PHONENUMBER has a value

PhoneNumberCountryCode

The ISO country code.

Accessible with the following methods

Method Description
GET_PHONENUMBERCOUNTRYCODE() Getter for PHONENUMBERCOUNTRYCODE, with configurable default
ASK_PHONENUMBERCOUNTRYCODE() Getter for PHONENUMBERCOUNTRYCODE w/ exceptions if field has
HAS_PHONENUMBERCOUNTRYCODE() Determine if PHONENUMBERCOUNTRYCODE has a value

PhoneNumberType

The type of phone number.

Accessible with the following methods

Method Description
GET_PHONENUMBERTYPE() Getter for PHONENUMBERTYPE, with configurable default
ASK_PHONENUMBERTYPE() Getter for PHONENUMBERTYPE w/ exceptions if field has no val
HAS_PHONENUMBERTYPE() Determine if PHONENUMBERTYPE has a value

PhoneNumberDescription

The description of the phone number.

Accessible with the following methods

Method Description
GET_PHONENUMBERDESCRIPTION() Getter for PHONENUMBERDESCRIPTION, with configurable default
ASK_PHONENUMBERDESCRIPTION() Getter for PHONENUMBERDESCRIPTION w/ exceptions if field has
HAS_PHONENUMBERDESCRIPTION() Determine if PHONENUMBERDESCRIPTION has a value

TargetArn

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

Accessible with the following methods

Method Description
GET_TARGETARN() Getter for TARGETARN, with configurable default
ASK_TARGETARN() Getter for TARGETARN w/ exceptions if field has no value
HAS_TARGETARN() Determine if TARGETARN has a value

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.

Accessible with the following methods

Method Description
GET_INSTANCEID() Getter for INSTANCEID, with configurable default
ASK_INSTANCEID() Getter for INSTANCEID w/ exceptions if field has no value
HAS_INSTANCEID() Determine if INSTANCEID has a value

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

PhoneNumberStatus

The status of the phone number.

  • CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

  • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

  • FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

You will not be billed for the phone number during the 1-day period if number claiming fails.

Accessible with the following methods

Method Description
GET_PHONENUMBERSTATUS() Getter for PHONENUMBERSTATUS

SourcePhoneNumberArn

The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.

Accessible with the following methods

Method Description
GET_SOURCEPHONENUMBERARN() Getter for SOURCEPHONENUMBERARN, with configurable default
ASK_SOURCEPHONENUMBERARN() Getter for SOURCEPHONENUMBERARN w/ exceptions if field has n
HAS_SOURCEPHONENUMBERARN() Determine if SOURCEPHONENUMBERARN has a value