A channel target links a channel to an agent, allowing users to communicate with the agent through that channel.

​
Example Usage

import { ChannelTargetResponse } from "syllable-sdk/models/components";

let value: ChannelTargetResponse = {
  agentId: 414263,
  channelId: 64147,
  target: "<value>",
  targetMode: "sms",
  id: 566602,
  channelName: "<value>",
  updatedAt: new Date("2023-10-18T20:48:18.611Z"),
  lastUpdatedBy: "<value>",
  agent: {
    name: "<value>",
    type: "ca_v1",
    promptId: 523248,
    customMessageId: 93940,
    timezone: "America/Chicago",
    languages: [
      "en-US",
      "es-US",
    ],
    variables: {
      "key": "<value>",
    },
    toolHeaders: {
      "key": "<value>",
    },
    id: 929297,
    updatedAt: new Date("2023-12-16T03:38:15.811Z"),
    lastUpdatedBy: "<value>",
    prompt: {
      name: "<value>",
      type: "<value>",
      llmConfig: {
        model: "gpt-4o",
        version: "2024-05-13",
        apiVersion: "2024-06-01",
      },
      id: 667411,
      lastUpdated: "<value>",
      lastUpdatedBy: "user@email.com",
    },
    customMessage: {
      name: "<value>",
      text: "<value>",
      rules: [
        {
          description: "yuck supposing friendly serpentine",
          timeRangeStart: "09:00",
          timeRangeEnd: "17:00",
          date: "2025-01-01",
          daysOfWeek: [
            "mo",
            "tu",
            "we",
            "th",
            "fr",
          ],
          invert: false,
          text: "Sorry, we're closed today",
        },
      ],
      id: 501324,
      updatedAt: new Date("2025-11-13T20:49:26.140Z"),
      lastUpdatedBy: "user@email.com",
    },
    channelTargets: [],
  },
};

​
Fields

FieldTypeRequiredDescription
agentIdnumberTRUEThe ID of the agent associated with the channel target
channelIdnumberTRUEThe ID of the channel associated with the channel target
targetstringTRUEThe name of the channel target (must correspond to an organization-level target)
targetModecomponents.TargetModesTRUEAvailable modes (communication methods) for channel targets.
fallbackTargetstringFALSEThe fallback for the channel target (currently only supported for “voice” mode)
isTestbooleanFALSEWhether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
idnumberTRUEThe ID of the channel target
channelNamestringTRUEThe name of the channel associated with the channel target
updatedAtDateTRUETimestamp of the most recent update to the channel target
lastUpdatedBystringTRUEEmail of the user who last updated the channel target
agentcomponents.AgentResponseFALSEDefinition of the agent for the channel target
ChannelTargetPropertiesChannelTargetUpdateRequest