Guides

SFTP Messaging Integration

Upload JSON files to your SFTP directory to send SMS and WhatsApp messages automatically.

SFTP (Secure File Transfer Protocol) encrypts file transfers and provides secure access to remote directories. The platform checks your directory every 2 minutes to detect, validate, and process new files.

SFTP messaging integration workflow

This integration supports:

  • JSON files, including multimedia messages, interactive components, and template-based communications.
  • SMS and WhatsApp delivery channels.
  • Automated, high-volume message processing.

Installation and setup

Complete these steps to connect an SFTP client and upload message files to your assigned remote directory.

  1. Request access. Contact your Account Manager to request SFTP credentials. Save the host address, port, username, and password you receive; you need these account-specific values to connect.

  2. Install an SFTP client. Use a command-line SFTP client available on most Linux and macOS systems, or install a graphical client such as FileZilla or WinSCP.

    To install FileZilla:

    1. Download FileZilla Client.
    2. Run the installer for your operating system.
    3. Open FileZilla.

  3. Connect to the SFTP directory. In FileZilla, configure a connection to the SFTP server.

    FileZilla SFTP connection settings
    1. Select the Site Manager icon in FileZilla's toolbar.
    2. Select New site.
    3. Set Protocol to SFTP – SSH File Transfer Protocol.
    4. Enter the Host, Port, Username, and Password provided by your Account Manager.
    5. Select Connect. After you connect, the Remote site panel displays your SFTP directories.

  4. Upload a JSON file.

    1. In the Remote site panel, open your assigned folder. It contains the following subdirectories:

      SMS and WhatsApp folders in the SFTP directory

      • sms: Upload SMS JSON files here. See SFTP SMS for the required JSON structure.
      • whatsapp: Upload WhatsApp JSON files here. See SFTP WhatsApp for the required JSON structure.

    2. In the local panel, select your prepared JSON file and drag it to the matching remote directory: sms for SMS messages or whatsapp for WhatsApp messages.

      📘

      NOTE

      Only the sms and whatsapp folders are visible when you connect to the SFTP server. Each folder includes an errors subfolder, where processing errors for uploaded files are listed.

    3. Wait up to 2 minutes for the platform to detect, validate, and process the uploaded file.

Updated 7 days ago