Pular para o conteúdo principal
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
/
{conversation_id}
Atualizar conversa
curl --request PATCH \
  --url https://airys.chat/api/v1/accounts/{account_id}/conversations/{conversation_id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "priority": "high",
  "sla_policy_id": 1
}
'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/conversations/{conversation_id}"

payload = {
"priority": "high",
"sla_policy_id": 1
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({priority: 'high', sla_policy_id: 1})
};

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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'priority' => 'high',
'sla_policy_id' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://airys.chat/api/v1/accounts/{account_id}/conversations/{conversation_id}"

payload := strings.NewReader("{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("api_access_token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://airys.chat/api/v1/accounts/{account_id}/conversations/{conversation_id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}")
.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::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}"

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": [
    {}
  ]
}
{
"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

Corpo

application/json
priority
enum<string>

A prioridade da conversa

Opções disponíveis:
urgent,
high,
medium,
low,
none
Exemplo:

"high"

sla_policy_id
number

O ID da política de SLA (Disponível apenas na edição Enterprise)

Exemplo:

1

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[]