Describe Phone Numbers

pinpointsmsvoicev2_describe_phone_numbers

R Documentation

Describes the specified origination phone number, or all the phone numbers in your account¶

Description¶

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an error is returned.

Usage¶

pinpointsmsvoicev2_describe_phone_numbers(PhoneNumberIds, Filters,
  NextToken, MaxResults, Owner)

Arguments¶

PhoneNumberIds

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Filters

An array of PhoneNumberFilter objects to filter the results.

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

MaxResults

The maximum number of results to return per each request.

Owner

Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.

Value¶

A list with the following syntax:

list(
  PhoneNumbers = list(
    list(
      PhoneNumberArn = "string",
      PhoneNumberId = "string",
      PhoneNumber = "string",
      Status = "PENDING"|"ACTIVE"|"ASSOCIATING"|"DISASSOCIATING"|"DELETED",
      IsoCountryCode = "string",
      MessageType = "TRANSACTIONAL"|"PROMOTIONAL",
      NumberCapabilities = list(
        "SMS"|"VOICE"|"MMS"
      ),
      NumberType = "SHORT_CODE"|"LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR",
      MonthlyLeasingPrice = "string",
      TwoWayEnabled = TRUE|FALSE,
      TwoWayChannelArn = "string",
      TwoWayChannelRole = "string",
      SelfManagedOptOutsEnabled = TRUE|FALSE,
      OptOutListName = "string",
      DeletionProtectionEnabled = TRUE|FALSE,
      PoolId = "string",
      RegistrationId = "string",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_phone_numbers(
  PhoneNumberIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "status"|"iso-country-code"|"message-type"|"number-capability"|"number-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"deletion-protection-enabled"|"two-way-channel-arn",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123,
  Owner = "SELF"|"SHARED"
)