SFTP to SMS

📘

Important: API Channel Activation for New Accounts and Sub-Accounts
When you create a new Account or Sub-Account, please be aware that by default, no API channels will be active. To enable API access and manage your Accounts and Sub-Accounts' API credentials and settings, please follow the steps outlined in the API Keys page.

Note for Accounts Created Before 6 June 2023:
If you have an Account that was created before 6 June 2023, the API channels would have been automatically enabled. However, if you wish to switch to an alternative API or use additional APIs, you will need to create an API Key for the desired API.

Overview

SFTP to SMS is ideal for high-volume message sending that is not time-sensitive, such as promotions.
The SFTP upload facility allows users to securely transfer files to an SFTP server. These files get processed, and messages are dispatched to all intended recipients.

Folder Structure

File Process Diagram

🚧

Limitations

• SFTP is a push-only mechanism for sending messages. Incoming data such as replies, and delivery statuses can be retrieved via legacy webhooks or the control panel website.
• It’s not easy to implement load balancing for the SFTP protocol, so you may experience downtime during maintenance windows.
• Although extremely simple to implement, SFTP to SMS has fewer features than the REST API. This is by design.
• The SFTP to SMS processes new files every 5 seconds. A faster alternative would be our RESTful API.
• Only GSM encoding/charset is supported.
• Only DOS/Windows, Mac, and Unix line endings are supported.

Login & Authentication

Login to one of the SFTP servers with an SFTP client such as FileZilla SFTP Client.
Use the following details to log in:

📘

In case you have forgotten your password, you can request a reminder here:
Password Reminder

Sending Messages

Sending messages is very simple. First, create your files in the correct file format and then transfer them to the SFTP server.

File Format

File Upload Process

1. Log in to the SFTP Server.
2. Transfer your file to the Send_SMS folder.
3. Within 5 seconds, the file will be processed automatically.
4. A file upload status will be sent to the email address specified in the file.
   If no email address is specified, the account email is used.

Main Body Parameters

Code Examples

version: 7
{
    "message_template": "Hello to the SMS world.",
    
    "contacts": [
        {"msisdn": "1111111111"},
        {"msisdn": "2222222222"},
        {"msisdn": "3333333333"},
        {"msisdn": "4444444444"}
    ]   
}

version: 7
{
    "start": "2017-11-02 06:19",
    "end": "2017-11-02 06:34",
    "senderId": "Fixed",
    "check_optouts": true,
    "email": "report-email@mybusiness.com",
    "max_errors": "1",
    "message_template": "Message sent to @@value1@@",
    
    "contacts": [
        {"msisdn": "1111111111", "customerId": "AccJohn237", "values" : { "value1" : "John"}},
        {"msisdn": "3333333333", "customerId": "TempAcc1032","message" : "Specific message for msisdn 3333333333"}
    ]   
}

version: 7
{
    "message_template": "Message sent to 1111111111, 2222222222 and 4444444444",
    
    "contacts": [
        {"msisdn": "1111111111"},
        {"msisdn": "2222222222"},
        {"msisdn": "3333333333", "message": "Specific message for msisdn 3333333333"},
        {"msisdn": "4444444444"}
    ]   
}

version: 7
{
    "message_template": "Message sent to @@value1@@,  Welcome @@value2@@ @@value3@@ @@value4@@",
    
    "contacts": [
{"msisdn": "1111111111", "values" : { "value1" : "1111111111", "value2" : "Title", "value3" : "1stName", "value4" : "Surname"}},
        {"msisdn": "2222222222", "values" : { "value1" : "2222222222", "value3" : "Jane", "value4" : "Doe" }},
        {"msisdn": "3333333333", "message" : "Specific message for msisdn 3333333333"}
    ]   
}

Error Codes