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

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

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}/contacts/{id}/conversations', 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}/contacts/{id}/conversations",
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}/contacts/{id}/conversations"

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}/contacts/{id}/conversations")
.header("api_access_token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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

id
number
obrigatório

ID do contato

account_id
integer
obrigatório

O ID numérico da conta

Resposta

Sucesso

payload
object[]

Lista de conversas do contato