Pular para o conteúdo principal

inbox_create_payload

namestring

The name of the inbox.

Example: Support
avatarstring<binary>

Image file for avatar.

greeting_enabledboolean

Enable greeting message.

Example: true
greeting_messagestring

Greeting message to send when greeting messages are enabled.

Example: Hello, how can I help you?
enable_email_collectboolean

Enable email collection.

Available for: Website

Example: true
csat_survey_enabledboolean

Enable CSAT survey.

Example: true
csat_config object

CSAT survey configuration.

display_typestring

Display style for the CSAT survey.

Possible values: [emoji, star]

Example: emoji
messagestring

Message shown with the CSAT survey.

Example: Please rate your conversation
button_textstring

Text shown on the CSAT survey button.

Example: Please rate us
languagestring

Language code for the CSAT survey.

Example: en
survey_rules object

Rules that decide when to show the CSAT survey.

operatorstring
Example: contains
valuesstring[]
Example: ["billing"]
enable_auto_assignmentboolean

Enable Auto Assignment.

Example: true
working_hours_enabledboolean

Enable working hours.

Example: true
out_of_office_messagestring

Out of office message to send outside working hours.

Example: We are currently out of office. Please leave a message and we will get back to you.
timezonestring

Timezone of the inbox.

Example: America/New_York
allow_messages_after_resolvedboolean

Allow messages after conversation is resolved.

Available for: Website

Example: true
lock_to_single_conversationboolean

Lock contact messages to a single active conversation.

Available for: API LINE Telegram WhatsApp SMS

Example: true
portal_idinteger

Id of the help center portal to attach to the inbox.

Example: 1
sender_name_typestring

Sender name type for outbound email replies.

Available for: Website Email

Possible values: [friendly, professional]

Example: friendly
business_namestring

Business name for outbound email replies.

Available for: Website Email

Example: My Business
channel object
type stringrequired

Possible values: [web_widget, api, email, line, telegram, whatsapp, sms]

website_urlstringrequired

URL at which the widget will be loaded

Example: https://example.com
welcome_titlestring

Welcome title to be displayed on the widget

Example: Welcome to our support
welcome_taglinestring

Welcome tagline to be displayed on the widget

Example: We are here to help you
widget_colorstring

A Hex-color string used to customize the widget

Example: #FF5733
reply_timestring

Expected reply time shown on the widget

Possible values: [in_a_few_minutes, in_a_few_hours, in_a_day]

Example: in_a_few_minutes
pre_chat_form_enabledboolean

Enable the pre-chat form before starting a conversation

Example: false
pre_chat_form_optionsobject

Pre-chat form configuration

Example: {"pre_chat_message":"Share your queries or comments here.","pre_chat_fields":[{"field_type":"standard","label":"Email Id","name":"emailAddress","type":"email","required":true,"enabled":true}]}
continuity_via_emailboolean

Continue conversations over email when the contact leaves the website

Example: true
hmac_mandatoryboolean

Require HMAC verification for contacts using the widget

Example: false
allowed_domainsstring

Comma-separated list of domains where the widget is allowed to load

Example: example.com
selected_feature_flagsstring[]

Enabled widget feature flags

Possible values: [attachments, emoji_picker, end_conversation, use_inbox_avatar_for_bot, allow_mobile_webview]

Example: ["attachments","emoji_picker","end_conversation"]
inbox_create_payload
{
  "name": "Support",
  "avatar": "string",
  "greeting_enabled": true,
  "greeting_message": "Hello, how can I help you?",
  "enable_email_collect": true,
  "csat_survey_enabled": true,
  "csat_config": {
    "display_type": "emoji",
    "message": "Please rate your conversation",
    "button_text": "Please rate us",
    "language": "en",
    "survey_rules": {
      "operator": "contains",
      "values": [
        "billing"
      ]
    }
  },
  "enable_auto_assignment": true,
  "working_hours_enabled": true,
  "out_of_office_message": "We are currently out of office. Please leave a message and we will get back to you.",
  "timezone": "America/New_York",
  "allow_messages_after_resolved": true,
  "lock_to_single_conversation": true,
  "portal_id": 1,
  "sender_name_type": "friendly",
  "business_name": "My Business",
  "channel": {
    "type": "web_widget",
    "website_url": "https://example.com",
    "welcome_title": "Welcome to our support",
    "welcome_tagline": "We are here to help you",
    "widget_color": "#FF5733",
    "reply_time": "in_a_few_minutes",
    "pre_chat_form_enabled": false,
    "pre_chat_form_options": {
      "pre_chat_message": "Share your queries or comments here.",
      "pre_chat_fields": [
        {
          "field_type": "standard",
          "label": "Email Id",
          "name": "emailAddress",
          "type": "email",
          "required": true,
          "enabled": true
        }
      ]
    },
    "continuity_via_email": true,
    "hmac_mandatory": false,
    "allowed_domains": "example.com",
    "selected_feature_flags": [
      "attachments",
      "emoji_picker",
      "end_conversation"
    ]
  }
}