Get a channel

One of the following:

• RaizChannelAgent

  {2 properties}

  • id

    string

    required

    Agent id.

    pattern: ^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
  • name

    string

    required

  }
• null

One of the following:

• RaizBusinessHours

  {6 properties}

  • closedDates

    array of

    string

    required

    Local dates (YYYY-MM-DD) closed all day, such as holidays.

    format: date
  • outsideHoursMessage

    string

    required

    What whoever writes outside the hours receives, once per number and closed period (until the hours open again), whether the conversation's AI is on, off or paused. With outsideHoursTemplate, the template goes instead, and this text only when WhatsApp refuses the template. The notice is never taken as an answer: the AI answers what the contact wrote when a person turns it on or resumes it in business hours.

    maxLength: 1000 · minLength: 1
  • timeZone

    string | null

    required

    IANA time zone of the windows. Null uses the organization's.

    maxLength: 64 · pattern: ^[A-Za-z]+(/[A-Za-z0-9_+-]+)*$
  • windows

    array of

    object

    required

    {3 properties}

    Several windows may share a day, for a break at midday or an afternoon shift.

    • days

      array of

      MO

      or

      TU

      or

      WE

      or

      TH

      or

      FR

      or

      SA

      +1 more

      required

      RFC 5545 weekdays the window applies to.

    • from

      string

      required

      Local wall-clock time HH:MM (24-hour).

      pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • to

      string

      required

      Closing time HH:MM, exclusive; 24:00 closes at midnight. Must be after from: split a window that crosses midnight in two.

      pattern: ^(([01][0-9]|2[0-3]):[0-5][0-9]|24:00)$

    }
  • closingGraceMinutes

    optional

    15

    or

    30

    or

    60

    or

    120

    or

    null

    Minutes after a closing during which a conversation in progress at it is still attended: the AI keeps answering, with its tools, and no notice is sent. In progress: the contact wrote before the closing, and the AI or a person answered within these minutes before it, or since (a notice is not an answer). New conversations get the notice as always. Null or absent: off.

  • outsideHoursTemplate

    optional

    {2 variants}

    Send the notice as this approved WhatsApp template instead of outsideHoursMessage: a template of the number's account with no variables and no document, image or video header (in list_templates: sendable, with parameterCount 0). WhatsApp's approval is checked when the hours are saved. If WhatsApp refuses the template when a notice goes (deleted, paused or disabled since), outsideHoursMessage goes instead. Null or absent: the notice is outsideHoursMessage.

    One of the following:

    • RaizOutsideHoursTemplate
    • null

    }

  }
• null

One of the following:

• RaizWidgetPublication

  {3 properties}

  • live

    boolean

    required

    Visitors can start now: no problems. The hosted page answers at url, and the widget runs on its allowedOrigins.

  • problems

    array of

    CHANNEL_INACTIVE

    or

    PAUSED

    or

    AGENT_REQUIRED

    or

    AGENT_PAUSED

    or

    NOT_PLACED

    required

    Why it is not live: CHANNEL_INACTIVE (the channel is not active), PAUSED (inboundEnabled is off), AGENT_REQUIRED (no Agent assigned), AGENT_PAUSED (its Agent is paused), NOT_PLACED (no hosted page and no https site may embed it).

  • url

    string | null

    required

    The widget's own hosted page (publicLink on), live or not; null when it runs only on the allowed sites.

  }
• null

One of the following:

• RaizWidgetSettings

  {72 properties}

  • allowedOrigins

    array of

    string

    required

    Exact origins allowed to embed the widget. The Dashboard may always preview it.

    maxLength: 256 · pattern: ^(https://[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*|http://(localhost|127\.0\.0\.1))(:[0-9]{1,5})?$
  • title

    string

    required

    maxLength: 80 · minLength: 1
  • policyRevision

    integer

    required

    Increases when a policy field, the channel's Agent or its inbound switch changes; sessions opened under an older revision end.

    minimum: 1
  • agents

    optional

    array of

    object

    {3 properties}

    Up to 6 more Agents the visitor may pick; each Agent at most once.

    default: []

    • agentId

      string

      required

      A text Agent of the same organization.

      pattern: ^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
    • label

      string

      required

      maxLength: 60 · minLength: 1
    • description

      optional

      string

      maxLength: 120 · default: ""

    }
  • allowBusinessTools

    optional

    boolean

    Let the Agent use its business tools (its integration tools) with anonymous visitors.

    default: false
  • animation

    optional

    slide

    or

    fade

    or

    scale

    or

    none

    default: "slide"
  • askFirstMessage

    optional

    boolean

    The pre-chat form asks for the first message, which opens the conversation.

    default: true
  • assistantColor

    optional

    string

    Background behind the Agent's messages; the background color shows them as plain text. A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#FFFFFF"
  • assistantTextColor

    optional

    string | null

    Text of the Agent's messages; null: textColor. A color in #RRGGBB form, or null to derive it.

    pattern: ^#[0-9a-fA-F]{6}$ · default: null
  • attachmentsEnabled

    optional

    boolean

    default: false
  • attachmentTypes

    optional

    array of

    image/png

    or

    image/jpeg

    or

    application/pdf

    or

    text/plain

    default: ["image/png","image/jpeg","application/pdf","text/plain"]
  • avatarUrl

    optional

    {2 variants}

    default: null

    One of the following:

    • RaizHttpsUrl
    • null

    }
  • backgroundColor

    optional

    string

    A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#F6F8F5"
  • borderColor

    optional

    string

    A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#CAD4CD"
  • borderWidth

    optional

    integer

    maximum: 4 · minimum: 0 · default: 1
  • clientTools

    optional

    array of

    object

    {3 properties}

    Up to 8 browser tools with unique names.

    default: []

    • description

      string

      required

      maxLength: 400 · minLength: 1
    • name

      string

      required

      pattern: ^[a-z][a-z0-9_]{0,39}$
    • parameters

      array of

      object

      required

      {3 properties}

      • name

        string

        required

        pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,39}$
      • required

        boolean

        required
      • type

        string

        or

        number

        or

        boolean

        required

      }

    }
  • controlRadius

    optional

    integer | null

    Corner radius of fields and buttons, in pixels; 24 makes pill-shaped buttons. Null: derived from radius.

    maximum: 24 · minimum: 0 · default: null
  • consentText

    optional

    string

    maxLength: 500 · minLength: 1 · default: "Acepto compartir estos datos y esta conversación con esta organización."
  • customCss

    optional

    string

    A stylesheet applied inside the panel only; the launcher uses the style fields.

    maxLength: 8000 · default: ""
  • errorColor

    optional

    string

    Field errors and failures the visitor must see. A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#B42318"
  • fields

    optional

    array of

    object

    {8 properties}

    Up to 40 form fields with unique names, asked before the conversation (or alone, in form mode).

    default: []

    • label

      string

      required

      maxLength: 80 · minLength: 1
    • name

      string

      required

      pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,39}$
    • required

      boolean

      required
    • type

      text

      or

      textarea

      or

      email

      or

      tel

      or

      number

      or

      date

      +4 more

      required
    • description

      optional

      string

      Help shown under the label.

      maxLength: 300 · default: ""
    • options

      optional

      array of

      string

      maxLength: 80 · minLength: 1 · default: []
    • placeholder

      optional

      string

      maxLength: 120 · default: ""
    • width

      optional

      full

      or

      half

      half sets two consecutive half fields side by side on wide screens.

      default: "full"

    }
  • firstMessageLabel

    optional

    string

    maxLength: 60 · minLength: 1 · default: "Mensaje"
  • font

    optional

    arbol

    or

    system

    or

    serif

    or

    rounded

    or

    page

    or

    custom

    The text typeface: arbol (bundled), system (the device's), serif, rounded, page (the embedding page's) or custom (fontFamily, with an optional fontUrl).

    default: "arbol"
  • fontFamily

    optional

    string

    The CSS font-family of font: custom.

    maxLength: 200 · pattern: ^[a-zA-Z0-9 ,"'_-]*$ · default: ""
  • fontSize

    optional

    integer

    maximum: 20 · minimum: 12 · default: 15
  • fontUrl

    optional

    {2 variants}

    default: null

    One of the following:

    • RaizHttpsUrl
    • null

    }
  • formTitle

    optional

    string

    maxLength: 120 · default: "Antes de empezar"
  • greeting

    optional

    string

    maxLength: 500 · default: "¡Hola! ¿En qué te podemos ayudar?"
  • headerColor

    optional

    string

    A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#F6F8F5"
  • headerTextColor

    optional

    string

    A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#182D24"
  • headingFont

    optional

    text

    or

    arbol

    or

    system

    or

    serif

    or

    rounded

    or

    page

    +1 more

    The headings' typeface: text (the same as font) or one of font's choices, with headingFontFamily and headingFontUrl for custom.

    default: "text"
  • headingFontFamily

    optional

    string

    The CSS font-family of headingFont: custom.

    maxLength: 200 · pattern: ^[a-zA-Z0-9 ,"'_-]*$ · default: ""
  • headingFontUrl

    optional

    {2 variants}

    default: null

    One of the following:

    • RaizHttpsUrl
    • null

    }
  • headingWeight

    optional

    integer

    The headings' weight, from 300 (light) to 800 (heavy).

    maximum: 800 · minimum: 300 · default: 500
  • inputBorderColor

    optional

    string | null

    The border of form fields and of the message box. A color in #RRGGBB form, or null to derive it.

    pattern: ^#[0-9a-fA-F]{6}$ · default: null
  • inputColor

    optional

    string | null

    The background of form fields and of the message box. A color in #RRGGBB form, or null to derive it.

    pattern: ^#[0-9a-fA-F]{6}$ · default: null
  • language

    optional

    es

    or

    en

    The visitor interface language when the browser asks for none of the translated ones.

    default: "es"
  • launcherIcon

    optional

    chat

    or

    sparkle

    or

    question

    or

    logo

    default: "chat"
  • launcherLabel

    optional

    string

    maxLength: 60 · minLength: 1 · default: "Escríbenos"
  • launcherStyle

    optional

    icon

    or

    label

    label shows the launcher text next to the icon; icon keeps it as the accessible name.

    default: "icon"
  • linkColor

    optional

    string | null

    Links; null: primaryColor. A color in #RRGGBB form, or null to derive it.

    pattern: ^#[0-9a-fA-F]{6}$ · default: null
  • logoObjectKey

    optional

    string | null

    The stored logo, managed by Raíz: updateChannel's widgetLogo sets it. Send back the value you read, or null to remove the logo; any other key is refused.

    maxLength: 512 · pattern: ^[A-Za-z0-9][A-Za-z0-9/_.-]{0,511}$ · default: null
  • maxTurns

    optional

    integer

    Visitor messages per session.

    maximum: 100 · minimum: 1 · default: 30
  • mutedTextColor

    optional

    string | null

    Secondary text: descriptions, hints and times. A color in #RRGGBB form, or null to derive it.

    pattern: ^#[0-9a-fA-F]{6}$ · default: null
  • mobileMode

    optional

    sheet

    or

    fullscreen

    default: "fullscreen"
  • mode

    optional

    chat

    or

    form

    or

    form-chat

    chat: conversation only. form: the form only, no conversation. form-chat: the form, then the conversation.

    default: "chat"
  • position

    optional

    left

    or

    right

    default: "right"
  • primaryColor

    optional

    string

    A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#24664C"
  • privacyUrl

    optional

    {2 variants}

    default: null

    One of the following:

    • RaizHttpsUrl
    • null

    }
  • publicLink

    optional

    boolean

    Also serve the widget on its own hosted page, outside any embedding site.

    default: false
  • radius

    optional

    integer

    maximum: 28 · minimum: 0 · default: 20
  • sessionMinutes

    optional

    integer

    maximum: 60 · minimum: 5 · default: 30
  • sessionsPerDay

    optional

    integer

    maximum: 10000 · minimum: 1 · default: 100
  • sharePageContext

    optional

    boolean

    Send the embedding page's title, URL and visible text with each message.

    default: false
  • showBranding

    optional

    boolean

    default: true
  • speakReplies

    optional

    boolean

    default: false
  • speechInput

    optional

    boolean

    default: false
  • streaming

    optional

    boolean

    default: true
  • style

    optional

    soft

    or

    flat

    flat removes shadows and tightens corners for minimal sites.

    default: "soft"
  • submitLabel

    optional

    string

    maxLength: 60 · minLength: 1 · default: "Continuar"
  • subtitle

    optional

    string

    maxLength: 180 · default: "¿Cómo te podemos ayudar?"
  • suggestions

    optional

    array of

    string

    Starter questions offered before the first message.

    maxLength: 80 · minLength: 1 · default: []
  • textColor

    optional

    string

    A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#182D24"
  • thankYou

    optional

    string

    maxLength: 500 · default: "Gracias. Recibimos tu información."
  • translations

    optional

    object

    {2 properties}

    Copy overrides per language.

    default: {}

    • en

      optional

      object

      {11 properties}

      • consentText

        optional

        string

        maxLength: 500 · minLength: 1
      • firstMessageLabel

        optional

        string

        maxLength: 60 · minLength: 1
      • formTitle

        optional

        string

        maxLength: 120
      • greeting

        optional

        string

        maxLength: 500
      • launcherLabel

        optional

        string

        maxLength: 60 · minLength: 1
      • submitLabel

        optional

        string

        maxLength: 60 · minLength: 1
      • subtitle

        optional

        string

        maxLength: 180
      • thankYou

        optional

        string

        maxLength: 500
      • title

        optional

        string

        maxLength: 80 · minLength: 1
      • welcomeText

        optional

        string

        maxLength: 300
      • welcomeTitle

        optional

        string

        maxLength: 80

      }
    • es

      optional

      object

      {11 properties}

      • consentText

        optional

        string

        maxLength: 500 · minLength: 1
      • firstMessageLabel

        optional

        string

        maxLength: 60 · minLength: 1
      • formTitle

        optional

        string

        maxLength: 120
      • greeting

        optional

        string

        maxLength: 500
      • launcherLabel

        optional

        string

        maxLength: 60 · minLength: 1
      • submitLabel

        optional

        string

        maxLength: 60 · minLength: 1
      • subtitle

        optional

        string

        maxLength: 180
      • thankYou

        optional

        string

        maxLength: 500
      • title

        optional

        string

        maxLength: 80 · minLength: 1
      • welcomeText

        optional

        string

        maxLength: 300
      • welcomeTitle

        optional

        string

        maxLength: 80

      }

    }
  • turnsPerDay

    optional

    integer

    maximum: 100000 · minimum: 1 · default: 1000
  • userTextColor

    optional

    string

    Text on primaryColor: buttons and the launcher. A color in #RRGGBB form.

    pattern: ^#[0-9a-fA-F]{6}$ · default: "#FFFFFF"
  • visitorColor

    optional

    string | null

    Background of the visitor's own messages; null: a light tint of textColor. A color in #RRGGBB form, or null to derive it.

    pattern: ^#[0-9a-fA-F]{6}$ · default: null
  • visitorTextColor

    optional

    string | null

    Text of the visitor's own messages; null: textColor. A color in #RRGGBB form, or null to derive it.

    pattern: ^#[0-9a-fA-F]{6}$ · default: null
  • voiceMessages

    optional

    boolean

    Let visitors record a voice message; Raíz transcribes it and the Agent answers the transcript.

    default: false
  • welcomeText

    optional

    string

    maxLength: 300 · default: "Pregúntanos lo que necesites. Solemos responder en minutos."
  • welcomeTitle

    optional

    string

    maxLength: 80 · default: "¡Hola! 👋"

  }
• null