Request an origination phone number for use in your account¶

Description¶

Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the End User Messaging SMS User Guide.

Usage¶

pinpointsmsvoicev2_request_phone_number(IsoCountryCode, MessageType,
  NumberCapabilities, NumberType, OptOutListName, PoolId, RegistrationId,
  NumberPreference, InternationalSendingEnabled,
  DeletionProtectionEnabled, Tags, ClientToken)

Arguments¶

• IsoCountryCode

  [required] The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

• MessageType

  [required] 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.

• NumberCapabilities

  [required] Indicates if the phone number will be used for text messages, voice messages, or both.

• NumberType

  [required] The type of phone number to request.

  When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.

• OptOutListName

  The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.

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

• PoolId

  The pool to associated with the phone number. You can use the PoolId or PoolArn.

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

• RegistrationId

  Use this field to attach your phone number for an external registration process.

• NumberPreference

  An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern. You can specify at most one preference. Number preferences apply only to TEN_DLC requests in the US.

• InternationalSendingEnabled

  By default this is set to false. When set to true the international sending of phone number is Enabled.

• DeletionProtectionEnabled

  By default this is set to false. When set to true the phone number can't be deleted.

• Tags

  An array of tags (key and value pairs) to associate with the requested phone number.

• ClientToken

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

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"|"RCS"
  ),
  NumberType = "LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR",
  MonthlyLeasingPrice = "string",
  TwoWayEnabled = TRUE|FALSE,
  TwoWayChannelArn = "string",
  TwoWayChannelRole = "string",
  SelfManagedOptOutsEnabled = TRUE|FALSE,
  OptOutListName = "string",
  InternationalSendingEnabled = TRUE|FALSE,
  DeletionProtectionEnabled = TRUE|FALSE,
  PoolId = "string",
  RegistrationId = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$request_phone_number(
  IsoCountryCode = "string",
  MessageType = "TRANSACTIONAL"|"PROMOTIONAL",
  NumberCapabilities = list(
    "SMS"|"VOICE"|"MMS"|"RCS"
  ),
  NumberType = "LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR",
  OptOutListName = "string",
  PoolId = "string",
  RegistrationId = "string",
  NumberPreference = list(
    list(
      PreferenceType = list(
        "StartsWith"|"EndsWith"|"Contains"|"ExactMatch"
      ),
      Filter = list(
        "string"
      )
    )
  ),
  InternationalSendingEnabled = TRUE|FALSE,
  DeletionProtectionEnabled = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ClientToken = "string"
)