Skip to main content
GET
Obter an inbox

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

id
number
obrigatório

ID da caixa de entrada

Resposta

Sucesso

id
number

ID da caixa de entrada

name
string

O nome da caixa de entrada

website_url
string

URL do site

channel_type
string

O tipo da caixa de entrada

avatar_url
string

A imagem de avatar da caixa de entrada

widget_color
string

Cor do widget usada para personalização do widget

website_token
string

Token do site

enable_auto_assignment
boolean

A sinalização que mostra se a Atribuição Automática está habilitada ou não

web_widget_script
string

Script usado para carregar o widget do site

welcome_title
string | null

Título de boas-vindas a ser exibido no widget

welcome_tagline
string | null

Slogan de boas-vindas a ser exibido no widget

greeting_enabled
boolean

A sinalização que mostra se a saudação está habilitada

greeting_message
string | null

Uma mensagem de saudação quando o usuário inicia a conversa

channel_id
number

ID do canal ao qual esta caixa de entrada pertence

working_hours_enabled
boolean

A sinalização que mostra se o recurso de horário comercial está ativado

enable_email_collect
boolean

A sinalização para permitir a coleta de e-mail de contatos

csat_survey_enabled
boolean

A sinalização para habilitar a pesquisa CSAT

auto_assignment_config
object

Configurações para atribuição automática

out_of_office_message
string | null

Mensagem para mostrar quando os agentes estiverem fora do escritório

working_hours
object[]

Configuração para o horário comercial da caixa de entrada

timezone
string

Configuração de fuso horário para a caixa de entrada

callback_webhook_url
string | null

URL do webhook para callbacks

allow_messages_after_resolved
boolean

Se deve permitir mensagens após uma conversa ser resolvida

lock_to_single_conversation
boolean

Se deve bloquear um contato a uma única conversa

sender_name_type
string

Tipo de nome do remetente a ser exibido (ex., amigável)

business_name
string | null

Nome da empresa associada à caixa de entrada

hmac_mandatory
boolean

Se a verificação HMAC é obrigatória

selected_feature_flags
string[] | null

Sinalizadores de recursos (feature flags) selecionados para a caixa de entrada

reply_time
string

Tempo de resposta esperado

messaging_service_sid
string | null

SID do serviço de mensagens para provedores de SMS

phone_number
string | null

Número de telefone associado à caixa de entrada

medium
string

Meio de comunicação (ex., sms, email)

provider
string | null

Provedor do canal