1.4.1 • Published 3 years ago
twilio-flogger v1.4.1
Flogger Library
This package provides you usefull methods to trigger the Flogger Lambda Endpoints programmatically, like:
sendMessage({ to, from, body, username, sendMessage })
Method to send or log messages into Flex Chat Channels. It receives an object with the following properties.
| Property | Type | Required | Description | Default |
|---|---|---|---|---|
| to | String | Yes | Customer's (recipient) phone number. | |
| from | String | Yes | Contact center's phone number. (Valid Twilio Number, capable to send SMS) | |
| body | String | Yes | Body of the message, it must have a length between 1 and 1600 characters. | |
| username | String | No | Username to display in Twilio Flex UI | system |
| sendMessage | Boolean | No | Send SMS to the customer or not | true |
| statusCallback | String | No | Twilio StatusCallBack The URL must contain a valid hostname and underscores are not allowed. The statusCallBack will be trigger only if you choose to send the SMS to the customer |
|
Returns a Promise, on success resolves with the Twilio Message Object.
Installation
npm install twilio-floggerUsage
import Flogger from 'twilio-flogger'
const floggerClient = new Flogger({
accessKeyId: 'YOUR_AWS_ACCESS_KEY',
secretAccessKey: 'YOUR_AWS_SECRET_KEY'
});
floggerClient.sendMessage({
to: '+123456789101',
from: '+1123456789101',
body: 'Message',
username: 'ALM',
sendMessage: true,
statusCallback: 'https://webhook.site/00318123-35ba-4942-8fc7-7a909a4b63b0'
})
.then((message) => console.log(message.sid))
.catch((err) => console.error(err))Test
Clone Repo
git clone https://github.com/refresh-construction/trades.org-flex-logger-sls
cd trades.org-flex-logger-slsInstall dependencies
npm installAdd the following keys to your .env file.
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=Run tests with
npm run testBuild
Build with
npm run build