Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Twilio provides its users with a platform and a robust API capable of sending messages using the carrier network all over the world, while also exposing a globally available cloud API that developers can interact with to build intelligent and complex communications systems.

This document provides information about the Twilio connector, which facilitates automated interactions with a Twilio server using FortiSOAR™ playbooks. Add the Twilio connector as a step in FortiSOAR™ playbooks and perform automated operations, such as sending an SMS message from one phone to another using Twilio.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-twilio

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

  • You must have the account SID and authorization token that has been configured for your account to use Twilio.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Twilio connector row, and in the Configuration tab enter the required configuration details.

Parameter Description
Account SID Identification string for the particular Twilio account that you will use to connect and perform the automated operations.
Auth Token Authorization token for the particular Twilio account that you will use to connect and perform the automated operations.

 

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

Function Description Annotation and Category
Send SMS Sends an SMS message from one phone to another using Twilio. send_sms
Miscellaneous

operation: Send SMS

Input parameters

Parameter Description
From Number (Include Country Code) Number from which Twilio will send the message. You must include the Country code with the phone number to send the SMS using Twilio.
To Number Include Country Code) Number to which Twilio will send the message. You must include the Country code with the phone number to send the SMS using Twilio.
Message Message that you want to send using Twilio.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Twilio - 1.0.0 playbook collection comes bundled with the Twilio connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Twilio connector.

  • Send Message

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

Twilio provides its users with a platform and a robust API capable of sending messages using the carrier network all over the world, while also exposing a globally available cloud API that developers can interact with to build intelligent and complex communications systems.

This document provides information about the Twilio connector, which facilitates automated interactions with a Twilio server using FortiSOAR™ playbooks. Add the Twilio connector as a step in FortiSOAR™ playbooks and perform automated operations, such as sending an SMS message from one phone to another using Twilio.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-twilio

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Twilio connector row, and in the Configuration tab enter the required configuration details.

Parameter Description
Account SID Identification string for the particular Twilio account that you will use to connect and perform the automated operations.
Auth Token Authorization token for the particular Twilio account that you will use to connect and perform the automated operations.

 

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

Function Description Annotation and Category
Send SMS Sends an SMS message from one phone to another using Twilio. send_sms
Miscellaneous

operation: Send SMS

Input parameters

Parameter Description
From Number (Include Country Code) Number from which Twilio will send the message. You must include the Country code with the phone number to send the SMS using Twilio.
To Number Include Country Code) Number to which Twilio will send the message. You must include the Country code with the phone number to send the SMS using Twilio.
Message Message that you want to send using Twilio.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Twilio - 1.0.0 playbook collection comes bundled with the Twilio connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Twilio connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.