create_number_pool_message: Send a message using number pool

Description Usage Arguments

View source: R/create_number_pool_message.R

Description

Send a message using number pool.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
create_number_pool_message(
  messaging_profile_id,
  to,
  text = NULL,
  media_urls = NULL,
  subject = NULL,
  auto_detect = FALSE,
  type = NULL,
  use_profile_webhooks = TRUE,
  webhook_failover_url = NULL,
  webhook_url = NULL
)

Arguments

messaging_profile_id

string Unique identifier for a messaging profile.

to

string (address) Receiving address (+18665552367 formatted phone number or short code). Example: "+18665552367"

text

string Message body (i.e., content) as a non-empty string. **Required for SMS**

media_urls

array of string A list of media URLs. The total media size must be less than 1 MB. **Required for MMS**

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.