Chat Flow User Guide
User GuidesRelease NotesFAQsSupport
5.52.0
5.52.0
  • 🏠Return to Home Page
  • 🔎Overview
    • Chat Flow Overview
    • Quick Start
  • 🪛Configuration
    • Access Chat Flow
    • Configure a route
    • Add an API integration
    • Set up keywords
    • Set up session timeout events
    • Manage your workflow assets
  • ✅Channel Capabilities
    • Configure channel display type
    • Use WhatsApp with Chat Flow
      • Initiate WhatsApp conversations
      • Send WhatsApp message templates
      • WhatsApp Interactive Messages
      • WhatsApp Commerce Messages
    • Use Apple Messaging for Business with Chat Flow
      • Apple Interactive Messages
      • Apple User-Facing Nodes
  • 🔃Workflow management
    • Build a workflow
      • Add a workflow
      • Delete and restore nodes
      • Repeat a step in a workflow
      • Dynamic API Workflows
    • Edit/delete a workflow
    • Search, Find & Replace in a workflow
    • Duplicate, rename, or move a workflow
    • Preview workflows
      • Preview flow on different channels
      • Preview logs
    • Approve and deploy workflows
      • View flow details
      • Submit a workflow for approval
      • Approve/decline a workflow
      • Deploy a workflow to production
  • 😎User-Facing Nodes
    • Display nodes
      • Contact Sending
      • External Link
      • Location sharing
      • Media
      • OTP Menu
      • Rich Link
      • Text Display
    • Product nodes
      • Clickatell AI node
      • Chat Desk node
    • Input nodes
      • Contact Receiving
      • OAuth Request
      • Request Input
      • Send Form
      • Time Picker
    • Commerce
      • Chat 2 Pay
      • Multi Product
    • Branch/logic split
      • Dynamic List
        • Apply patterns, custom indexes, filtering, and exclusions
      • Menu
      • Multiple Choice Input
  • 🎬Action Nodes
    • API Integration node
    • Calculate
    • Date Format
    • Display List
    • Encrypt
    • Is Empty
    • Is Null
    • Number Format
    • Regular Expression
    • Remap
    • Send Template
    • Set Variable
    • Switch Case
    • Wait For Callback
    • Opt-Out nodes
  • 🔗Integrations
    • Integration nodes
  • 🔡Variable management
  • Using system variables
  • Referring to variables
  • 📊Reporting & Analytics
    • Analytics Settings
    • Collections & reporting labels
    • Clickatell Portal Reports
  • ❗System error codes
    • System Error Codes
  • 💡Help & Information
    • What's New? 🎈
    • Release Notes
    • FAQs
    • Return to Home Page
Powered by GitBook
LogoLogo

© Copyright 2024 Clickatell. All rights reserved.

On this page
  • Inbound media
  • Outbound media
  • Supported media formats and sizes

Was this helpful?

  1. User-Facing Nodes
  2. Display nodes

Media

Was this helpful?

Use the Media node to or media files by the channels you have set up in Chat Flow.

Inbound media

When selecting the inbound media direction, you are receiving a media file from your customer.

You have to add a Media node for each media file you want to receive from your customers.

IMPORTANT: The request content type for this API integration must be set to multipart/form-data. The response type can be application/json, but is dependent on your API.

Example 1:

You want the customer to send you one media file.

  • Add one Media node to your flow followed by one API Integration node.

Example 2:

You want the customer to send you three media files.

  • Add three Media nodes to your flow, each one followed by an API Integration node (i.e., three API Integration nodes in total).

Flow construct for Example 2:

Media node --> API Integration node --> Media node --> API Integration node --> Media node --> API Integration node

Outbound media

When selecting the outbound media direction, you are sending a media file to your customers.

You can select to:

You have the option to either:

  1. End the session after sending the media file to the customer; or

  2. Continue the flow after sending a media file to the customer and specify the next step/flow to automatically follow. The workflow can immediately continue to the next step without requiring input from the customer first.

API Integration

Selecting this option requires you to download the media file from your system first before sending it to your customers.

The request content type for this API integration may be set to application/json or multipart/form-data.

Example 1:

You want to send one media file to the customer.

  • Add one API Integration node to your flow followed by one Media node.

Example 2:

You want the customer to send you three media files.

  • Add three API Integration nodes to your flow, each one followed by a Media node (i.e., three Media nodes in total).

Flow construct for Example 2:

API Integration node --> Media node --> API Integration node --> Media node --> API Integration node --> Media node

‌Assets

A thumbnail of the selected media file appears on the node:

View in the canvas:

Supported media formats and sizes

The file types supported by this node have format and size limitations. The table below indicates the supported formats and their size limits.

File Type
Supported Formats
File Size Limit

Documents

pdf, doc, docx, xls, xlsx, ppt, pptx

20MB

Images

jpeg, jpg, png, udsz

5MB

Audio files

aac, amr, mp4, mp3, opus

16MB

Video files

mp4

5MB

  • Captions are only applicable for image and video types.

  • For any document type, the handset will display the original filename (and not the caption) when you download the document onto your handset.

  • Audio files: no caption or filename is displayed on the handset.

Once received, you need a mechanism to upload these files onto your own system. Each Media node must be followed by an node utilizing an to upload the file to your system/database once received from the customer.

Use an to download the file you want to send to your customers from your system/database; or

Upload an /use an existing asset to send to your customer

You need to add a Media node for each outbound media file you want to send to your customer. Each Media node must be preceded by an node utilizing an to download the file from your system/database before it can be sent to the customer.

Selecting this option opens another call to action, + Add file. Clicking this opens a pop-up modal where the flow-builder can add new media files, or select from ones. After selecting +Add File on the node, you can upload a new media file or select from existing ones.

😎
API Integration
API integration
API Integration
API integration
previously uploaded
API integration
asset
send
receive
supported
Setup of a Media node (inbound)
For each media node an API Integration node is used to upload the file to an external source.
Example of what the customer sees on WhatsApp when your business sent a media file to them
Setup of a Media node (outbound; API)
Setup of a Media node (outbound; asset library)
After selecting "+Add File" on the node, you can upload a new media file, or select from existing ones