create_message: Send a message

In CannabisMDA/telnyxr: An Interface to the Telnyx API for R

Description

Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool. This endpoint allows you to send a message with any messaging resource. Current messaging resources include: long-code, short-code, number-pool, and alphanumeric-sender-id.

Usage

create_message(
  to,
  text = NULL,
  from = NULL,
  media_urls = NULL,
  messaging_profile_id = NULL,
  subject = NULL,
  auto_detect = FALSE,
  type = NULL,
  use_profile_webhooks = TRUE,
  webhook_failover_url = NULL,
  webhook_url = NULL
)

Arguments

to	string (address) Receiving address ([phone] formatted phone number or short code). Example: "[phone]"
text	string Message body (i.e., content) as a non-empty string. **Required for SMS**
from	string (address) Sending address ([phone] formatted phone number, alphanumeric sender ID, or short code). **Required if sending with a phone number, short code, or alphanumeric sender ID.**
media_urls	array of string A list of media URLs. The total media size must be less than 1 MB. **Required for MMS**
messaging_profile_id	string Unique identifier for a messaging profile. **Required if sending via number pool or with an alphanumeric sender ID.**
subject	string Subject of multimedia message.
auto_detect	boolean Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.
type	string The protocol for sending the message, either SMS or MMS. Options: ["SMS", "MMS"]
use_profile_webhooks	boolean If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.
webhook_failover_url	string (url) The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
webhook_url	string (url) The URL where webhooks related to this message will be sent.

CannabisMDA/telnyxr documentation built on Dec. 17, 2021, 1:56 p.m.