Release Phone Number

pinpointsmsvoicev2_release_phone_number

R Documentation

Releases an existing origination phone number in your account¶

Description¶

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.

Usage¶

pinpointsmsvoicev2_release_phone_number(PhoneNumberId)

Arguments¶

PhoneNumberId: [required] The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use describe_phone_numbers to get the values for PhoneNumberId and PhoneNumberArn.

Value¶

A list with the following syntax:

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",
  RegistrationId = "string",
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$release_phone_number(
  PhoneNumberId = "string"
)