Pular para o conteúdo principal
GET
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
/
{conversation_id}
Conversation detalhes
curl --request GET \
  --url https://airys.chat/api/v1/accounts/{account_id}/conversations/{conversation_id} \
  --header 'api_access_token: <api-key>'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/conversations/{conversation_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}/conversations/{conversation_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}/conversations/{conversation_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}/conversations/{conversation_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}/conversations/{conversation_id}")
.header("api_access_token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/conversations/{conversation_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,
  "messages": [
    {
      "id": 123,
      "content": "<string>",
      "account_id": 123,
      "inbox_id": 123,
      "conversation_id": 123,
      "created_at": 123,
      "updated_at": 123,
      "private": true,
      "source_id": "<string>",
      "content_attributes": {},
      "sender_id": 123,
      "external_source_ids": {},
      "additional_attributes": {},
      "processed_message_content": "<string>",
      "sentiment": {},
      "conversation": {},
      "attachment": {},
      "sender": {}
    }
  ],
  "account_id": 123,
  "uuid": "<string>",
  "additional_attributes": {},
  "agent_last_seen_at": 123,
  "assignee_last_seen_at": 123,
  "can_reply": true,
  "contact_last_seen_at": 123,
  "custom_attributes": {},
  "inbox_id": 123,
  "labels": [
    "<string>"
  ],
  "muted": true,
  "snoozed_until": 123,
  "created_at": 123,
  "updated_at": 123,
  "timestamp": 123,
  "first_reply_created_at": 123,
  "unread_count": 123,
  "last_non_activity_message": {
    "id": 123,
    "content": "<string>",
    "account_id": 123,
    "inbox_id": 123,
    "conversation_id": 123,
    "created_at": 123,
    "updated_at": 123,
    "private": true,
    "source_id": "<string>",
    "content_attributes": {},
    "sender_id": 123,
    "external_source_ids": {},
    "additional_attributes": {},
    "processed_message_content": "<string>",
    "sentiment": {},
    "conversation": {},
    "attachment": {},
    "sender": {}
  },
  "last_activity_at": 123,
  "priority": "<string>",
  "waiting_since": 123,
  "sla_policy_id": 123,
  "applied_sla": {},
  "sla_events": [
    {}
  ],
  "meta": {
    "sender": {
      "additional_attributes": {},
      "availability_status": "<string>",
      "email": "<string>",
      "id": 123,
      "name": "<string>",
      "phone_number": "<string>",
      "blocked": true,
      "identifier": "<string>",
      "thumbnail": "<string>",
      "custom_attributes": {},
      "last_activity_at": 123,
      "created_at": 123
    },
    "channel": "<string>",
    "assignee": {
      "id": 123,
      "access_token": "<string>",
      "account_id": 123,
      "available_name": "<string>",
      "avatar_url": "<string>",
      "confirmed": true,
      "display_name": "<string>",
      "message_signature": "<string>",
      "email": "<string>",
      "hmac_identifier": "<string>",
      "inviter_id": 123,
      "name": "<string>",
      "provider": "<string>",
      "pubsub_token": "<string>",
      "ui_settings": {},
      "uid": "<string>",
      "type": "<string>",
      "custom_attributes": {},
      "accounts": [
        {
          "id": 123,
          "name": "<string>",
          "status": "<string>",
          "active_at": "2023-11-07T05:31:56Z",
          "permissions": [
            "<string>"
          ],
          "availability": "<string>",
          "availability_status": "<string>",
          "auto_offline": true,
          "custom_role_id": 123,
          "custom_role": {}
        }
      ]
    },
    "hmac_verified": true
  }
}
{
"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

conversation_id
integer
obrigatório

O ID numérico da conversa

Resposta

Sucesso

id
number

ID da conversa

messages
object[]
account_id
number

ID da conta

uuid
string

UUID da conversa

additional_attributes
object

O objeto contendo atributos adicionais relacionados à conversa

agent_last_seen_at
number

A última atividade do agente

assignee_last_seen_at
number

A última atividade do responsável

can_reply
boolean

Se a conversa pode ser respondida

contact_last_seen_at
number

A última atividade em do contato

custom_attributes
object

O objeto para salvar atributos personalizados para a conversa, aceita chave e valor de atributos personalizados

inbox_id
number

ID da caixa de entrada

labels
string[]

Os rótulos da conversa

muted
boolean

Se a conversa está silenciada

snoozed_until
number | null

O horário em que a conversa deixará de ser silenciada

status
enum<string>

O status da conversa

Opções disponíveis:
open,
resolved,
pending
created_at
number

O horário em que a conversa foi criada

updated_at
number

O horário em que a conversa foi atualizada

timestamp
number

O horário em que a conversa foi criada

first_reply_created_at
number | null

O horário em que a primeira resposta foi criada

unread_count
number

O número de mensagens não lidas

last_non_activity_message
object | null

A última mensagem de não atividade

last_activity_at
number

A última atividade da conversa

priority
string | null

A prioridade da conversa

waiting_since
number | null

O horário em que a conversa estava em espera

sla_policy_id
number | null

O ID da política de SLA

applied_sla
object

O SLA aplicado

sla_events
object[]
meta
object