Skip to content

Request a new sender ID that doesn't require registration

Description

Request a new sender ID that doesn't require registration.

Usage

pinpointsmsvoicev2_request_sender_id(SenderId, IsoCountryCode,
  MessageTypes, DeletionProtectionEnabled, Tags, ClientToken)

Arguments

  • SenderId

    [required] The sender ID string to request. The sender ID can be 1-11 alphanumeric characters including letters (A-Z, a-z), numbers (0-9), or hyphens (-). The sender ID must contain at least one letter and cannot start or end with a hyphen.

  • IsoCountryCode

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

  • MessageTypes

    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.

  • DeletionProtectionEnabled

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

  • Tags

    An array of tags (key and value pairs) to associate with the sender ID.

  • 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(
  SenderIdArn = "string",
  SenderId = "string",
  IsoCountryCode = "string",
  MessageTypes = list(
    "TRANSACTIONAL"|"PROMOTIONAL"
  ),
  MonthlyLeasingPrice = "string",
  DeletionProtectionEnabled = TRUE|FALSE,
  Registered = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

svc$request_sender_id(
  SenderId = "string",
  IsoCountryCode = "string",
  MessageTypes = list(
    "TRANSACTIONAL"|"PROMOTIONAL"
  ),
  DeletionProtectionEnabled = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ClientToken = "string"
)