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 and making calls from one phone to another using Twilio.
Connector Version: 2.0.0
FortiSOAR™ Version Tested on: 7.4.0-3024
Twilio Version Tested on: v2010-04-01
Authored By: Fortinet
Certified: Yes
The following enhancements are now a part of the Twilio connector in version 2.0.0:
Twilio
phone
to text
of following parameters and actions to facilitate passing of Jinja expression:
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum
command as a root user to install the connector:
yum install cyops-connector-twilio
For the procedure to configure a connector, click here.
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 to connect and perform the automated operations. |
Auth Token | Authorization token for the particular Twilio account to connect and perform the automated operations. |
Verify SSL | Specifies whether the SSL certificate for the server is to be verified or not. By default, this option is set to True |
You can include the following automated operations and also use the annotations to access these operations from FortiSOAR™:
Function | Description | Annotation and Category |
---|---|---|
Send Message | Sends an SMS message from one phone to another using Twilio. | send_sms Miscellaneous |
Make Outbound Call | Makes an outbound call from one phone to another using Twilio. | make_outbound_call Miscellaneous |
Parameter | Description |
---|---|
From Number (Include Country Code) | Specify an active number under your account from which Twilio can send the message. You must include the Country code with the phone number to send the SMS using Twilio. |
To Number (Include Country Code) | Specify the number to which Twilio can send the message. You must include the Country code with the phone number to send the SMS using Twilio. |
Message | Specify the message for Twilio to send. |
The output contains the following populated JSON schema:
{ "account_sid": "", "api_version": "", "body": "", "date_created": "", "date_sent": "", "date_updated": "", "direction": "", "error_code": "", "error_message": "", "from": "", "messaging_service_sid": "", "num_media": "", "num_segments": "", "price": "", "price_unit": "", "sid": "", "status": "", "subresource_uris": { "media": "" }, "to": "", "uri": "" }
Parameter | Description |
---|---|
From Number (Include Country Code) | Specify an active number under your account for Twilio to call from and convey the recorded message. You must include the Country code with the phone number to call using Twilio. |
To Number (Include Country Code) | Specify the number for Twilio to call and convey the recorded message. You must include the Country code with the phone number to call using Twilio. |
Language | Select the language in which to convey the message. |
Message to be conveyed | Specify the message that you want Twilio to convey. |
The output contains the following populated JSON schema:
{ "account_sid": "", "answered_by": "", "api_version": "", "caller_name": "", "date_created": "", "date_updated": "", "direction": "", "duration": "", "end_time": "", "forwarded_from": "", "from": "", "from_formatted": "", "group_sid": "", "parent_call_sid": "", "phone_number_sid": "", "price": "", "price_unit": "", "sid": "", "start_time": "", "status": "", "subresource_uris": { "notifications": "", "recordings": "", "feedback": "", "feedback_summaries": "", "payments": "", "events": "", "siprec": "", "streams": "", "user_defined_message_subscriptions": "", "user_defined_messages": "" }, "to": "", "to_formatted": "", "trunk_sid": "", "uri": "", "queue_time": "" }
The Sample - Twilio - 2.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.
NOTE: In the event the Make Outbound Call action fails after the connector upgrade, specify a value in the Language parameter.
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 and making calls from one phone to another using Twilio.
Connector Version: 2.0.0
FortiSOAR™ Version Tested on: 7.4.0-3024
Twilio Version Tested on: v2010-04-01
Authored By: Fortinet
Certified: Yes
The following enhancements are now a part of the Twilio connector in version 2.0.0:
Twilio
phone
to text
of following parameters and actions to facilitate passing of Jinja expression:
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum
command as a root user to install the connector:
yum install cyops-connector-twilio
For the procedure to configure a connector, click here.
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 to connect and perform the automated operations. |
Auth Token | Authorization token for the particular Twilio account to connect and perform the automated operations. |
Verify SSL | Specifies whether the SSL certificate for the server is to be verified or not. By default, this option is set to True |
You can include the following automated operations and also use the annotations to access these operations from FortiSOAR™:
Function | Description | Annotation and Category |
---|---|---|
Send Message | Sends an SMS message from one phone to another using Twilio. | send_sms Miscellaneous |
Make Outbound Call | Makes an outbound call from one phone to another using Twilio. | make_outbound_call Miscellaneous |
Parameter | Description |
---|---|
From Number (Include Country Code) | Specify an active number under your account from which Twilio can send the message. You must include the Country code with the phone number to send the SMS using Twilio. |
To Number (Include Country Code) | Specify the number to which Twilio can send the message. You must include the Country code with the phone number to send the SMS using Twilio. |
Message | Specify the message for Twilio to send. |
The output contains the following populated JSON schema:
{ "account_sid": "", "api_version": "", "body": "", "date_created": "", "date_sent": "", "date_updated": "", "direction": "", "error_code": "", "error_message": "", "from": "", "messaging_service_sid": "", "num_media": "", "num_segments": "", "price": "", "price_unit": "", "sid": "", "status": "", "subresource_uris": { "media": "" }, "to": "", "uri": "" }
Parameter | Description |
---|---|
From Number (Include Country Code) | Specify an active number under your account for Twilio to call from and convey the recorded message. You must include the Country code with the phone number to call using Twilio. |
To Number (Include Country Code) | Specify the number for Twilio to call and convey the recorded message. You must include the Country code with the phone number to call using Twilio. |
Language | Select the language in which to convey the message. |
Message to be conveyed | Specify the message that you want Twilio to convey. |
The output contains the following populated JSON schema:
{ "account_sid": "", "answered_by": "", "api_version": "", "caller_name": "", "date_created": "", "date_updated": "", "direction": "", "duration": "", "end_time": "", "forwarded_from": "", "from": "", "from_formatted": "", "group_sid": "", "parent_call_sid": "", "phone_number_sid": "", "price": "", "price_unit": "", "sid": "", "start_time": "", "status": "", "subresource_uris": { "notifications": "", "recordings": "", "feedback": "", "feedback_summaries": "", "payments": "", "events": "", "siprec": "", "streams": "", "user_defined_message_subscriptions": "", "user_defined_messages": "" }, "to": "", "to_formatted": "", "trunk_sid": "", "uri": "", "queue_time": "" }
The Sample - Twilio - 2.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.
NOTE: In the event the Make Outbound Call action fails after the connector upgrade, specify a value in the Language parameter.