Send Otp Message

pinpoint_send_otp_message

R Documentation

Send an OTP message

Description

Send an OTP message

Usage

pinpoint_send_otp_message(ApplicationId,
  SendOTPMessageRequestParameters)

Arguments

ApplicationId

[required] The unique ID of your Amazon Pinpoint application.

SendOTPMessageRequestParameters

[required]

Value

A list with the following syntax:

list(
  MessageResponse = list(
    ApplicationId = "string",
    EndpointResult = list(
      list(
        Address = "string",
        DeliveryStatus = "SUCCESSFUL"|"THROTTLED"|"TEMPORARY_FAILURE"|"PERMANENT_FAILURE"|"UNKNOWN_FAILURE"|"OPT_OUT"|"DUPLICATE",
        MessageId = "string",
        StatusCode = 123,
        StatusMessage = "string",
        UpdatedToken = "string"
      )
    ),
    RequestId = "string",
    Result = list(
      list(
        DeliveryStatus = "SUCCESSFUL"|"THROTTLED"|"TEMPORARY_FAILURE"|"PERMANENT_FAILURE"|"UNKNOWN_FAILURE"|"OPT_OUT"|"DUPLICATE",
        MessageId = "string",
        StatusCode = 123,
        StatusMessage = "string",
        UpdatedToken = "string"
      )
    )
  )
)

Request syntax

svc$send_otp_message(
  ApplicationId = "string",
  SendOTPMessageRequestParameters = list(
    AllowedAttempts = 123,
    BrandName = "string",
    Channel = "string",
    CodeLength = 123,
    DestinationIdentity = "string",
    EntityId = "string",
    Language = "string",
    OriginationIdentity = "string",
    ReferenceId = "string",
    TemplateId = "string",
    ValidityPeriod = 123
  )
)