Put Opted Out Number

pinpointsmsvoicev2_put_opted_out_number

R Documentation

Creates an opted out destination phone number in the opt-out list¶

Description¶

Creates an opted out destination phone number in the opt-out list.

If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.

Usage¶

pinpointsmsvoicev2_put_opted_out_number(OptOutListName, OptedOutNumber)

Arguments¶

OptOutListName

[required] The OptOutListName or OptOutListArn to add the phone number to.

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

OptedOutNumber

[required] The phone number to add to the OptOutList in E.164 format.

Value¶

A list with the following syntax:

list(
  OptOutListArn = "string",
  OptOutListName = "string",
  OptedOutNumber = "string",
  OptedOutTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  EndUserOptedOut = TRUE|FALSE
)

Request syntax¶

svc$put_opted_out_number(
  OptOutListName = "string",
  OptedOutNumber = "string"
)