tl_create_msg_profile: Create or update a messaging profile

In happycabbage/twilior: Use the Twilio API with R

Description

Create a Telnyx Messaging Profile via the Messgaging Profiles endpoint.

See here for more details.

Usage

tl_create_msg_profile(
  key,
  name = NULL,
  geomatch = TRUE,
  skip_unhealthy = FALSE,
  sticky_sender = TRUE,
  long_code_weight = 1,
  toll_free_weight = 1,
  whitelisted_destinations = "US",
  webhook_url = "",
  webhook_failover_url = "",
  params = NULL,
  ...
)

tl_update_msg_profile(key, profile_id, params)

Arguments

key	Required. Telnyx API key
name	Optional. A user friendly name for the messaging profile.
geomatch	Should numbers match area codes? Defaults to TRUE.
skip_unhealthy	Should numbers that are blocked not be used? Defaults to FALSE.
sticky_sender	Should contacts receive messages from the same number? Defaults to TRUE.
long_code_weight	Probability of using Long Code (as a share of the sum of the weights). Defaults to 1.
toll_free_weight	Probability of using Toll Free (as a share of the sum of the weights). Defaults to 1.
whitelisted_destinations	Vector of country codes numbers can send to. Defaults to 'US'. Should be ISO 3166-1 alpha-2 country codes.
webhook_url	Optional. URL for webhook response.
webhook_failover_url	Optional. Backup URL for webhook response.
params	Optional further arguments to pass into API body. Should be a named list. Required if using tl_update_msg_profile, use this to pass in updated values as a named list.
...	Unused at this time.
profile_id	The messaging profile to update. Required for tl_update_msg_profile.

happycabbage/twilior documentation built on July 5, 2021, 4:21 a.m.