Skip to main content

Passthrough

note

This feature is only available for accounts on the Enterprise plan. Want access? Contact our sales team to learn more.

The passthrough feature allows you to send custom payloads directly to messaging channels without Moveo's standard message processing. This extends the capabilities of your AI Agent

by leveraging platform-specific features to their full potential.

Overview​

When you need to utilize platform-specific features or send specialized message formats, the passthrough feature enables you to bypass Moveo's standard message processing and send payloads directly to the channel.

Supported channels​

The passthrough feature is currently available for the following messaging channels:

  • Viber
  • WhatsApp
  • Sunshine Conversations

Schema​

To use the passthrough feature, add a passthrough field to your text or carousel response. The field contains a list of objects with the following structure:

FieldTypeDescription
channelstringThe target messaging channel ("whatsapp", "sunco" (Sunshine Conversations) or "viber")
payloadstringA JSON stringified string containing the channel-specific message format
important

Ensure your payload matches the target channel's message format requirements.

Example Structure:

{
  "passthrough": [
    {
      "channel": "string",
      "payload": "string" // JSON stringified payload
    }
  ]
}

Platform-specific implementations​

Sunshine Conversations​

For Sunshine Conversations (Sunco), the passthrough feature integrates with their native passthrough API. The payload is placed in the override field of the WhatsApp message. See the Sunshine Conversations passthrough documentation for detailed examples.

Examples​

The following example demonstrates sending a custom WhatsApp message using passthrough. On all other channels, the AI Agent sends only the text "Hello!".

{
  "type": "text",
  "text": "Hello!",
  "passthrough": [
    {
      "channel": "whatsapp",
      "payload": "{\"type\":\"template\",\"template\":{\"namespace\":\"XXXXXXXX_XXXX_XXXX_XXXX_XXXXXXXXXXXX\",\"element_name\":\"hello_world\",\"language\":{\"policy\":\"deterministic\",\"code\":\"en_US\"},\"components\":[{\"type\":\"header\",\"parameters\":[{\"type\":\"image\",\"image\":{\"link\":\"https://image.jpg\"}}]}]}}"
    }
  ]
}

Best practices​

  1. Always validate your channel-specific payloads against the platform's documentation.
  2. Test passthrough messages in a development environment first.
  3. Keep track of platform-specific features and limitations.
  4. Consider fallback options for channels that don't support certain message types.

Limitations​

  • The passthrough feature is only available through the API.
  • Each channel has specific message format requirements and limitations.
  • Messages sent via passthrough bypass Moveo's standard message processing and validation.

Channel documentation​

For detailed message format specifications, refer to these platform-specific resources:

Last updated on