Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

ClickSend is a cloud-based service that lets you send and receive SMS, Email, Voice, Fax, and Letters worldwide.

This document provides information about the ClickSend connector, which facilitates automated interactions with ClickSend using FortiSOAR™playbooks. Add the ClickSend connector as a step in FortiSOAR™playbooks and perform automated operations, such as sending SMS messages using ClickSend.

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-clicksend

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the URL of ClickSend server to which you will connect and perform automated operations and credentials to access that server.
  • 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, select the ClickSend connector and click Configure to configure the following parameters:

Parameter Description
Server URL Server URL of the ClickSend server.
Username Username to access ClickSend.
Password Password to access ClickSend.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

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 and onwards:

Function Description Annotation and Category
Send Message Send an SMS message to a given number. send_message
Miscellaneous

operation: Send Message

Input parameters

Parameter Description
To Specify the phone number of the recipient.
From Specify the phone number of the sender.
Schedule Specify the date and time when the message should be sent.
Message The body of the message to be sent.

Output

The output contains the following populated JSON schema:
{
     "response_msg": "",
     "data": {
         "queued_count": "",
         "messages": [],
         "total_count": "",
         "total_price": ""
     },
     "http_code": "",
     "response_code": ""
}

Included playbooks

The Sample - ClickSend - 1.0.0 playbook collection comes bundled with the ClickSend connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™after importing the ClickSend 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

ClickSend is a cloud-based service that lets you send and receive SMS, Email, Voice, Fax, and Letters worldwide.

This document provides information about the ClickSend connector, which facilitates automated interactions with ClickSend using FortiSOAR™playbooks. Add the ClickSend connector as a step in FortiSOAR™playbooks and perform automated operations, such as sending SMS messages using ClickSend.

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-clicksend

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, select the ClickSend connector and click Configure to configure the following parameters:

Parameter Description
Server URL Server URL of the ClickSend server.
Username Username to access ClickSend.
Password Password to access ClickSend.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

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 and onwards:

Function Description Annotation and Category
Send Message Send an SMS message to a given number. send_message
Miscellaneous

operation: Send Message

Input parameters

Parameter Description
To Specify the phone number of the recipient.
From Specify the phone number of the sender.
Schedule Specify the date and time when the message should be sent.
Message The body of the message to be sent.

Output

The output contains the following populated JSON schema:
{
     "response_msg": "",
     "data": {
         "queued_count": "",
         "messages": [],
         "total_count": "",
         "total_price": ""
     },
     "http_code": "",
     "response_code": ""
}

Included playbooks

The Sample - ClickSend - 1.0.0 playbook collection comes bundled with the ClickSend connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™after importing the ClickSend 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.