rsthn/rose-ext-twilio

Twilio Adapter for Rose

1.0.1 2022-03-12 08:42 UTC

Requires

• rsthn/rose-extension-installer: *
• twilio/sdk: ^6.24

Apache-2.0

• Jonathan Palencia

README

This extension adds expression functions to Rose to send SMS using Twilio.

Installation

composer require rsthn/rose-ext-twilio

Configuration Section: Twilio

The configuration section should have the default settings that the extension will use when using the twilio::send function. If you want to change these runtime, use twilio::config first.

Field	Type	Description	Default
sid	string	SID of Twilio API	Required
token	string	Access Token	Required
from	string	Phone number used as "send from".	Required

Expression Functions

twilio::send targetPhoneNumber:string message:string

Sends an SMS to the specified phone number.

Returns: { error:string, errorCode:string, sid:string, price:number }

Example:

(twilio::send "[phone]" "Hello World")

twilio::config settings:object

Changes one or more configuration settings. The settings object should have one or more fields just as the configuration section.

Returns: boolean

Example:

(twilio::config (& "sid" "SID_VALUE"))