/AWS1/CL_PP2REQPHONENUMBERRSLT¶
RequestPhoneNumberResult
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_phonenumberarn TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The Amazon Resource Name (ARN) of the requested phone number.
iv_phonenumberid TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The unique identifier of the new phone number.
iv_phonenumber TYPE /AWS1/PP2PHONENUMBER /AWS1/PP2PHONENUMBER¶
The new phone number that was requested.
iv_status TYPE /AWS1/PP2NUMBERSTATUS /AWS1/PP2NUMBERSTATUS¶
The current status of the request.
iv_isocountrycode TYPE /AWS1/PP2ISOCOUNTRYCODE /AWS1/PP2ISOCOUNTRYCODE¶
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
iv_messagetype TYPE /AWS1/PP2MESSAGETYPE /AWS1/PP2MESSAGETYPE¶
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
it_numbercapabilities TYPE /AWS1/CL_PP2NUMCAPABILITYLST_W=>TT_NUMBERCAPABILITYLIST TT_NUMBERCAPABILITYLIST¶
Indicates if the phone number will be used for text messages, voice messages or both.
iv_numbertype TYPE /AWS1/PP2REQUESTABLENUMBERTYPE /AWS1/PP2REQUESTABLENUMBERTYPE¶
The type of number that was released.
iv_monthlyleasingprice TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The monthly price, in US dollars, to lease the phone number.
iv_twowayenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
iv_twowaychannelarn TYPE /AWS1/PP2TWOWAYCHANNELARN /AWS1/PP2TWOWAYCHANNELARN¶
The ARN used to identify the two way channel.
iv_twowaychannelrole TYPE /AWS1/PP2IAMROLEARN /AWS1/PP2IAMROLEARN¶
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
iv_selfmanagedoptoutsenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
iv_optoutlistname TYPE /AWS1/PP2OPTOUTLISTNAME /AWS1/PP2OPTOUTLISTNAME¶
The name of the OptOutList that is associated with the requested phone number.
iv_deletionprotectionenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
By default this is set to false. When set to true the phone number can't be deleted.
iv_poolid TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The unique identifier of the pool associated with the phone number
iv_registrationid TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The unique identifier for the registration.
it_tags TYPE /AWS1/CL_PP2TAG=>TT_TAGLIST TT_TAGLIST¶
An array of key and value pair tags that are associated with the phone number.
iv_createdtimestamp TYPE /AWS1/PP2TIMESTAMP /AWS1/PP2TIMESTAMP¶
The time when the phone number was created, in UNIX epoch time format.
Queryable Attributes¶
PhoneNumberArn¶
The Amazon Resource Name (ARN) of the requested 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 |
PhoneNumberId¶
The unique identifier of the new 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 |
PhoneNumber¶
The new phone number that was requested.
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 |
Status¶
The current status of the request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
IsoCountryCode¶
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISOCOUNTRYCODE() |
Getter for ISOCOUNTRYCODE, with configurable default |
ASK_ISOCOUNTRYCODE() |
Getter for ISOCOUNTRYCODE w/ exceptions if field has no valu |
HAS_ISOCOUNTRYCODE() |
Determine if ISOCOUNTRYCODE has a value |
MessageType¶
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGETYPE() |
Getter for MESSAGETYPE, with configurable default |
ASK_MESSAGETYPE() |
Getter for MESSAGETYPE w/ exceptions if field has no value |
HAS_MESSAGETYPE() |
Determine if MESSAGETYPE has a value |
NumberCapabilities¶
Indicates if the phone number will be used for text messages, voice messages or both.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NUMBERCAPABILITIES() |
Getter for NUMBERCAPABILITIES, with configurable default |
ASK_NUMBERCAPABILITIES() |
Getter for NUMBERCAPABILITIES w/ exceptions if field has no |
HAS_NUMBERCAPABILITIES() |
Determine if NUMBERCAPABILITIES has a value |
NumberType¶
The type of number that was released.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NUMBERTYPE() |
Getter for NUMBERTYPE, with configurable default |
ASK_NUMBERTYPE() |
Getter for NUMBERTYPE w/ exceptions if field has no value |
HAS_NUMBERTYPE() |
Determine if NUMBERTYPE has a value |
MonthlyLeasingPrice¶
The monthly price, in US dollars, to lease the phone number.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MONTHLYLEASINGPRICE() |
Getter for MONTHLYLEASINGPRICE, with configurable default |
ASK_MONTHLYLEASINGPRICE() |
Getter for MONTHLYLEASINGPRICE w/ exceptions if field has no |
HAS_MONTHLYLEASINGPRICE() |
Determine if MONTHLYLEASINGPRICE has a value |
TwoWayEnabled¶
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYENABLED() |
Getter for TWOWAYENABLED |
TwoWayChannelArn¶
The ARN used to identify the two way channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYCHANNELARN() |
Getter for TWOWAYCHANNELARN, with configurable default |
ASK_TWOWAYCHANNELARN() |
Getter for TWOWAYCHANNELARN w/ exceptions if field has no va |
HAS_TWOWAYCHANNELARN() |
Determine if TWOWAYCHANNELARN has a value |
TwoWayChannelRole¶
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYCHANNELROLE() |
Getter for TWOWAYCHANNELROLE, with configurable default |
ASK_TWOWAYCHANNELROLE() |
Getter for TWOWAYCHANNELROLE w/ exceptions if field has no v |
HAS_TWOWAYCHANNELROLE() |
Determine if TWOWAYCHANNELROLE has a value |
SelfManagedOptOutsEnabled¶
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SELFMANAGEDOPTOUTSENBD() |
Getter for SELFMANAGEDOPTOUTSENABLED |
OptOutListName¶
The name of the OptOutList that is associated with the requested phone number.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OPTOUTLISTNAME() |
Getter for OPTOUTLISTNAME, with configurable default |
ASK_OPTOUTLISTNAME() |
Getter for OPTOUTLISTNAME w/ exceptions if field has no valu |
HAS_OPTOUTLISTNAME() |
Determine if OPTOUTLISTNAME has a value |
DeletionProtectionEnabled¶
By default this is set to false. When set to true the phone number can't be deleted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELETIONPROTECTIONENBD() |
Getter for DELETIONPROTECTIONENABLED |
PoolId¶
The unique identifier of the pool associated with the phone number
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POOLID() |
Getter for POOLID, with configurable default |
ASK_POOLID() |
Getter for POOLID w/ exceptions if field has no value |
HAS_POOLID() |
Determine if POOLID has a value |
RegistrationId¶
The unique identifier for the registration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REGISTRATIONID() |
Getter for REGISTRATIONID, with configurable default |
ASK_REGISTRATIONID() |
Getter for REGISTRATIONID w/ exceptions if field has no valu |
HAS_REGISTRATIONID() |
Determine if REGISTRATIONID has a value |
Tags¶
An array of key and value pair tags that are associated with the phone number.
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 |
CreatedTimestamp¶
The time when the phone number was created, in UNIX epoch time format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDTIMESTAMP() |
Getter for CREATEDTIMESTAMP, with configurable default |
ASK_CREATEDTIMESTAMP() |
Getter for CREATEDTIMESTAMP w/ exceptions if field has no va |
HAS_CREATEDTIMESTAMP() |
Determine if CREATEDTIMESTAMP has a value |