Fortinet Document Library

Version:


Table of Contents

1.0.1
Copy Link

About the connector

MessageBird is a platform for communications and connecting companies to their customers on billions of devices.

This document provides information about the MessageBird connector, which facilitates automated interactions with your MessageBird server using FortiSOAR™ playbooks. Add the MessageBird connector, as a step in FortiSOAR™ playbooks and perform automated operations such as sending an SMS using the MessageBird platform and retrieving message details from the MessageBird platform

Version information

Connector Version: 1.0.1

Authored By: Community

Certified: No

Release Notes for version 1.0.1

Following enhancements have been made to the MessageBird connector in version 1.0.1:

  • Fixed the error that the connector "Health Check" was failing and showing "Disconnected" even when valid credentials were specified in the connector configuration. Now, if you enter valid credentials in the connector configuration, then the "Health Check" will not fail and will display "Available".

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-messagebird

Prerequisites to configuring the connector

  • You must have the URL of the MessageBird server to which you will connect and perform automated operations and the API key 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, click the MessageBird connector row (if you are in the Grid view on the Connectors page), and in the Configurations tab enter the required configuration details.

Parameter Description
Server URL URL of the MessageBird server to which you will connect and perform automated operations.
API Key API Token configured for your account to access the MessageBird server to which you will connect and perform automated operations.
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 version 4.10.0 onwards:

Function Description Annotation and Category
Send Message Sends an SMS message from one phone to other phones using the MessageBird platform based on the sender's and recipients' details and the message body you have specified. send_message
Investigation
Get Messages Retrieves all existing messages from the MessageBird platform. get_messages
Investigation
Get Specific Message Details Retrieves details of a specific message from the MessageBird platform based on the message ID you have specified. get_specific_message_details
Investigation
Delete Message Deletes an existing message from the MessageBird platform based on the message ID you have specified. delete_message
Investigation

operation: Send Message

Input parameters

Parameter Description
Originator Details of the sender of the message.
You can enter a telephone number (including country code) or an alphanumeric string in this field. A maximum of 11 characters is supported in an "alphanumeric" string.
SMS Message Body Content of the SMS message that you want to send using the MessageBird platform.
Recipients CSV list or array of recipients to whom you want to send the SMS using the MessageBird platform.
Note: You can enter a maximum of "50" recipients per request.

Output

The output contains the following populated JSON schema:
{
     "scheduledDatetime": "",
     "recipients": {
         "totalCount": "",
         "totalDeliveredCount": "",
         "totalSentCount": "",
         "totalDeliveryFailedCount": "",
         "items": [
             {
                 "recipient": "",
                 "status": "",
                 "statusDatetime": "",
                 "messagePartCount": ""
             }
         ]
     },
     "id": "",
     "originator": "",
     "reference": "",
     "mclass": "",
     "validity": "",
     "typeDetails": {},
     "createdDatetime": "",
     "body": "",
     "datacoding": "",
     "direction": "",
     "href": "",
     "type": "",
     "gateway": ""
}

operation: Get Messages

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "links": {
         "previous": "",
         "first": "",
         "last": "",
         "next": ""
     },
     "items": [
         {
             "scheduledDatetime": "",
             "recipients": {
                 "totalCount": "",
                 "totalDeliveredCount": "",
                 "totalSentCount": "",
                 "totalDeliveryFailedCount": "",
                 "items": [
                     {
                         "recipient": "",
                         "status": "",
                         "originator": "",
                         "statusDatetime": "",
                         "messagePartCount": ""
                     }
                 ]
             },
             "id": "",
             "originator": "",
             "reference": "",
             "mclass": "",
             "validity": "",
             "typeDetails": {},
             "createdDatetime": "",
             "body": "",
             "datacoding": "",
             "direction": "",
             "href": "",
             "type": "",
             "gateway": ""
         }
     ],
     "totalCount": "",
     "limit": "",
     "offset": "",
     "count": ""
}

operation: Get Specific Message Details

Input parameters

Parameter Description
Message ID ID of the message that is created on the MessageBird platform whose details you want to retrieve from MessageBird.

Output

The output contains the following populated JSON schema:
{
     "scheduledDatetime": "",
     "recipients": {
         "totalCount": "",
         "totalDeliveredCount": "",
         "totalSentCount": "",
         "totalDeliveryFailedCount": "",
         "items": [
             {
                 "recipient": "",
                 "status": "",
                 "statusDatetime": ""
             }
         ]
     },
     "id": "",
     "originator": "",
     "reference": "",
     "mclass": "",
     "validity": "",
     "typeDetails": "",
     "createdDatetime": "",
     "body": "",
     "datacoding": "",
     "direction": "",
     "href": "",
     "type": "",
     "gateway": ""
}

operation: Delete Message

Input parameters

Parameter Description
Message ID ID of the message that is created on the MessageBird platform that you want to delete from the MessageBird platform.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - MessageBird - 1.0.1 playbook collection comes bundled with the MessageBird 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 MessageBird connector.

  • Delete Message
  • Get Messages
  • Get Specific Message Details
  • 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 the connector upgrade and delete.

About the connector

MessageBird is a platform for communications and connecting companies to their customers on billions of devices.

This document provides information about the MessageBird connector, which facilitates automated interactions with your MessageBird server using FortiSOAR™ playbooks. Add the MessageBird connector, as a step in FortiSOAR™ playbooks and perform automated operations such as sending an SMS using the MessageBird platform and retrieving message details from the MessageBird platform

Version information

Connector Version: 1.0.1

Authored By: Community

Certified: No

Release Notes for version 1.0.1

Following enhancements have been made to the MessageBird connector in version 1.0.1:

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-messagebird

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 MessageBird connector row (if you are in the Grid view on the Connectors page), and in the Configurations tab enter the required configuration details.

Parameter Description
Server URL URL of the MessageBird server to which you will connect and perform automated operations.
API Key API Token configured for your account to access the MessageBird server to which you will connect and perform automated operations.
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 version 4.10.0 onwards:

Function Description Annotation and Category
Send Message Sends an SMS message from one phone to other phones using the MessageBird platform based on the sender's and recipients' details and the message body you have specified. send_message
Investigation
Get Messages Retrieves all existing messages from the MessageBird platform. get_messages
Investigation
Get Specific Message Details Retrieves details of a specific message from the MessageBird platform based on the message ID you have specified. get_specific_message_details
Investigation
Delete Message Deletes an existing message from the MessageBird platform based on the message ID you have specified. delete_message
Investigation

operation: Send Message

Input parameters

Parameter Description
Originator Details of the sender of the message.
You can enter a telephone number (including country code) or an alphanumeric string in this field. A maximum of 11 characters is supported in an "alphanumeric" string.
SMS Message Body Content of the SMS message that you want to send using the MessageBird platform.
Recipients CSV list or array of recipients to whom you want to send the SMS using the MessageBird platform.
Note: You can enter a maximum of "50" recipients per request.

Output

The output contains the following populated JSON schema:
{
     "scheduledDatetime": "",
     "recipients": {
         "totalCount": "",
         "totalDeliveredCount": "",
         "totalSentCount": "",
         "totalDeliveryFailedCount": "",
         "items": [
             {
                 "recipient": "",
                 "status": "",
                 "statusDatetime": "",
                 "messagePartCount": ""
             }
         ]
     },
     "id": "",
     "originator": "",
     "reference": "",
     "mclass": "",
     "validity": "",
     "typeDetails": {},
     "createdDatetime": "",
     "body": "",
     "datacoding": "",
     "direction": "",
     "href": "",
     "type": "",
     "gateway": ""
}

operation: Get Messages

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "links": {
         "previous": "",
         "first": "",
         "last": "",
         "next": ""
     },
     "items": [
         {
             "scheduledDatetime": "",
             "recipients": {
                 "totalCount": "",
                 "totalDeliveredCount": "",
                 "totalSentCount": "",
                 "totalDeliveryFailedCount": "",
                 "items": [
                     {
                         "recipient": "",
                         "status": "",
                         "originator": "",
                         "statusDatetime": "",
                         "messagePartCount": ""
                     }
                 ]
             },
             "id": "",
             "originator": "",
             "reference": "",
             "mclass": "",
             "validity": "",
             "typeDetails": {},
             "createdDatetime": "",
             "body": "",
             "datacoding": "",
             "direction": "",
             "href": "",
             "type": "",
             "gateway": ""
         }
     ],
     "totalCount": "",
     "limit": "",
     "offset": "",
     "count": ""
}

operation: Get Specific Message Details

Input parameters

Parameter Description
Message ID ID of the message that is created on the MessageBird platform whose details you want to retrieve from MessageBird.

Output

The output contains the following populated JSON schema:
{
     "scheduledDatetime": "",
     "recipients": {
         "totalCount": "",
         "totalDeliveredCount": "",
         "totalSentCount": "",
         "totalDeliveryFailedCount": "",
         "items": [
             {
                 "recipient": "",
                 "status": "",
                 "statusDatetime": ""
             }
         ]
     },
     "id": "",
     "originator": "",
     "reference": "",
     "mclass": "",
     "validity": "",
     "typeDetails": "",
     "createdDatetime": "",
     "body": "",
     "datacoding": "",
     "direction": "",
     "href": "",
     "type": "",
     "gateway": ""
}

operation: Delete Message

Input parameters

Parameter Description
Message ID ID of the message that is created on the MessageBird platform that you want to delete from the MessageBird platform.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - MessageBird - 1.0.1 playbook collection comes bundled with the MessageBird 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 MessageBird 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 the connector upgrade and delete.