Package cx.syndeo.script

Interface Channel

public interface Channel
Represents a communication channel, providing details about the platform, name, and identifiers for the conversation.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    The user configured name of the Syndeo Channel.
    String
    getPlatform()
    The name of the messaging or voice platform (e.g., "Web", "SMS").
    String
    getTargetId()
    The unique identifier for the entity the user is communicating with on the platform (e.g.
    String
    getUserId()
    The unique ID for the user on the third-party platform.

  • Method Details

    • getPlatform

      String getPlatform()
      The name of the messaging or voice platform (e.g., "Web", "SMS").
      Returns:
      The name of platform (e.g., "WhatsApp").

    • getName

      String getName()
      The user configured name of the Syndeo Channel.
      Returns:
      The channel name as set by the user.

    • getTargetId

      String getTargetId()
      The unique identifier for the entity the user is communicating with on the platform (e.g. a specific phone number, a page ID).
      Returns:
      The unique target ID of the Syndeo Channel.

    • getUserId

      String getUserId()
      The unique ID for the user on the third-party platform.
      Returns:
      The platform-specific unique user ID.