SMS Sluzba

LAST UPDATED: 04/16/2024

Overview

The SMS Sluzba.cz platform enables users to send and receive SMS messages, as well as receive delivery notifications via the SMS Gate API. D3's integration sends text SMS messages via SMS Gate - API POST and uses SMS Gate - API XML 3.0 to check the service status of SMS Gate.

D3 SOAR is providing REST operations to function with SMS Sluzba.

SMS Sluzba is available for use in:

D3 SOAR	V16.9.0+
Category	Email & Messaging
Deployment Options	Option II, Option IV

Connection

To connect to SMS Sluzba from D3 SOAR, please follow this part to collect the required information below:

Parameter	Description	Example
Username	The login username to authenticate the API connection to https://smsgateapi.sms-sluzba.cz.	Username
Password	The password to authenticate the API connection.	Sample_password

Commands

SMS Sluzba includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the SMS Sluzba API, please refer to the SMS Sluzba API reference.

Note for Time-related parameters

The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:

Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose your desired date and time format.

After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.

Send SMS

Sends SMS via sluzba.cz.

Input

Input Parameter	Required/Optional	Description	Example
Phone Number	Required	The recipient's phone number for the SMS message should be in international format (+42**********); however, the 9-digit format (603123456) is also accepted for Czech numbers. Any other characters (e.g., spaces) are not allowed. If the number is not provided in an international format, the system will attempt to send the SMS using connectivity within the Czech Republic.	+42**********
Message	Required	The text of the SMS message should not exceed 459 characters, which corresponds to 3 connectable SMS messages. Longer text will be truncated. Please avoid using diacritical marks in the message, as they will be removed.	A test message.

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE

No Sample Data

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Send SMS failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the SMS Sluzba portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized.

Error Sample Data

Send SMS failed.

Status Code: 401.

Message: Unauthorized.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

SAMPLE DATA

CODE

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Test Connection failed. Failed to check the connector.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the SMS Sluzba portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 401.

Message: Unauthorized.