flow-twilio-component

0.3.2 • Public • Published

Flow Twilio component

The component sends sms using Twilio and is designed to work with Flow SDK

To get started, install the package in your NodeJS project

npm i flow-twilio-component --save

Use the component as below

// require the component
const Component = require('flow-twilio-component');
 
// create instance of the component
const component = new Component();

Provide twilio credentials, account sid and authentication token

component.getProperty('ACCOUNT_SID').data = 'Your_Account_SID';
component.getProperty('AUTHENTICATION_TOKEN').data = 'Your_Authentication_Token';

Provide sms fields

// provide from and to phone numbers
component.getProperty('From').data = '+18646574367';
component.getProperty('To').data = '+17326950328';
 
// provide the message to send
component.getProperty('Body').data = 'Hello there, this is a test message.';

Listen in for port emit events

component.getPort('Sent').onEmit(function(){
  // sms was sent
  // the server response can be accessed through the 'Data' property of the port
  let response = component.getPort('Sent').getProperty('Data').data;
});
 
component.getPort('Error').onEmit(function(){
  // an error occured
  // the actual error can be accessed through the 'Data' property of the port
  let err = component.getPort('Error').getProperty('Data').data;
});

Execute the component

// add the component to a graph before executing it
const Graph = require('flow-platform-sdk').Graph;
new Graph("graph-1").addComponent(component);
 
component.execute();

Conclusion

If you are having trouble sending messages, check that you are using the correct Twilio credentials and the right sender number.

Readme

Keywords

Package Sidebar

Install

npm i flow-twilio-component

Weekly Downloads

2

Version

0.3.2

License

Apache-2.0

Unpacked Size

25.5 kB

Total Files

12

Last publish

Collaborators

  • hackerbayadmin