Pular para o conteúdo principal
GET
/
api
/
v1
/
accounts
/
{account_id}
/
inboxes
/
{id}
Obter an inbox
curl --request GET \
  --url https://airys.chat/api/v1/accounts/{account_id}/inboxes/{id} \
  --header 'api_access_token: <api-key>'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/inboxes/{id}"

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://airys.chat/api/v1/accounts/{account_id}/inboxes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://airys.chat/api/v1/accounts/{account_id}/inboxes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://airys.chat/api/v1/accounts/{account_id}/inboxes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://airys.chat/api/v1/accounts/{account_id}/inboxes/{id}")
  .header("api_access_token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/inboxes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "website_url": "<string>",
  "channel_type": "<string>",
  "avatar_url": "<string>",
  "widget_color": "<string>",
  "website_token": "<string>",
  "enable_auto_assignment": true,
  "web_widget_script": "<string>",
  "welcome_title": "<string>",
  "welcome_tagline": "<string>",
  "greeting_enabled": true,
  "greeting_message": "<string>",
  "channel_id": 123,
  "working_hours_enabled": true,
  "enable_email_collect": true,
  "csat_survey_enabled": true,
  "auto_assignment_config": {},
  "out_of_office_message": "<string>",
  "working_hours": [
    {
      "day_of_week": 123,
      "closed_all_day": true,
      "open_hour": 123,
      "open_minutes": 123,
      "close_hour": 123,
      "close_minutes": 123,
      "open_all_day": true
    }
  ],
  "timezone": "<string>",
  "callback_webhook_url": "<string>",
  "allow_messages_after_resolved": true,
  "lock_to_single_conversation": true,
  "sender_name_type": "<string>",
  "business_name": "<string>",
  "hmac_mandatory": true,
  "selected_feature_flags": [
    "<string>"
  ],
  "reply_time": "<string>",
  "messaging_service_sid": "<string>",
  "phone_number": "<string>",
  "medium": "<string>",
  "provider": "<string>"
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

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