Pular para o conteúdo principal
POST
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
Criar novo conversa
curl --request POST \
  --url https://airys.chat/api/v1/accounts/{account_id}/conversations \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "source_id": "1234567890",
  "inbox_id": 1,
  "contact_id": 1,
  "additional_attributes": {
    "browser": "Chrome",
    "browser_version": "89.0.4389.82",
    "os": "Windows",
    "os_version": "10"
  },
  "custom_attributes": {
    "attribute_key": "attribute_value",
    "priority_conversation_number": 3
  },
  "status": "open",
  "assignee_id": 1,
  "team_id": 1,
  "snoozed_until": "2030-07-21T17:32:28Z"
}
'
import requests

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

payload = {
    "source_id": "1234567890",
    "inbox_id": 1,
    "contact_id": 1,
    "additional_attributes": {
        "browser": "Chrome",
        "browser_version": "89.0.4389.82",
        "os": "Windows",
        "os_version": "10"
    },
    "custom_attributes": {
        "attribute_key": "attribute_value",
        "priority_conversation_number": 3
    },
    "status": "open",
    "assignee_id": 1,
    "team_id": 1,
    "snoozed_until": "2030-07-21T17:32:28Z"
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_id: '1234567890',
    inbox_id: 1,
    contact_id: 1,
    additional_attributes: {
      browser: 'Chrome',
      browser_version: '89.0.4389.82',
      os: 'Windows',
      os_version: '10'
    },
    custom_attributes: {attribute_key: 'attribute_value', priority_conversation_number: 3},
    status: 'open',
    assignee_id: 1,
    team_id: 1,
    snoozed_until: '2030-07-21T17:32:28Z'
  })
};

fetch('https://airys.chat/api/v1/accounts/{account_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}/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_id' => '1234567890',
    'inbox_id' => 1,
    'contact_id' => 1,
    'additional_attributes' => [
        'browser' => 'Chrome',
        'browser_version' => '89.0.4389.82',
        'os' => 'Windows',
        'os_version' => '10'
    ],
    'custom_attributes' => [
        'attribute_key' => 'attribute_value',
        'priority_conversation_number' => 3
    ],
    'status' => 'open',
    'assignee_id' => 1,
    'team_id' => 1,
    'snoozed_until' => '2030-07-21T17:32:28Z'
  ]),
  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"

	payload := strings.NewReader("{\n  \"source_id\": \"1234567890\",\n  \"inbox_id\": 1,\n  \"contact_id\": 1,\n  \"additional_attributes\": {\n    \"browser\": \"Chrome\",\n    \"browser_version\": \"89.0.4389.82\",\n    \"os\": \"Windows\",\n    \"os_version\": \"10\"\n  },\n  \"custom_attributes\": {\n    \"attribute_key\": \"attribute_value\",\n    \"priority_conversation_number\": 3\n  },\n  \"status\": \"open\",\n  \"assignee_id\": 1,\n  \"team_id\": 1,\n  \"snoozed_until\": \"2030-07-21T17:32:28Z\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://airys.chat/api/v1/accounts/{account_id}/conversations")
  .header("api_access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_id\": \"1234567890\",\n  \"inbox_id\": 1,\n  \"contact_id\": 1,\n  \"additional_attributes\": {\n    \"browser\": \"Chrome\",\n    \"browser_version\": \"89.0.4389.82\",\n    \"os\": \"Windows\",\n    \"os_version\": \"10\"\n  },\n  \"custom_attributes\": {\n    \"attribute_key\": \"attribute_value\",\n    \"priority_conversation_number\": 3\n  },\n  \"status\": \"open\",\n  \"assignee_id\": 1,\n  \"team_id\": 1,\n  \"snoozed_until\": \"2030-07-21T17:32:28Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_id\": \"1234567890\",\n  \"inbox_id\": 1,\n  \"contact_id\": 1,\n  \"additional_attributes\": {\n    \"browser\": \"Chrome\",\n    \"browser_version\": \"89.0.4389.82\",\n    \"os\": \"Windows\",\n    \"os_version\": \"10\"\n  },\n  \"custom_attributes\": {\n    \"attribute_key\": \"attribute_value\",\n    \"priority_conversation_number\": 3\n  },\n  \"status\": \"open\",\n  \"assignee_id\": 1,\n  \"team_id\": 1,\n  \"snoozed_until\": \"2030-07-21T17:32:28Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "account_id": 123,
  "inbox_id": 123
}
{
  "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

Corpo

application/json
​
source_id
string
obrigatório

Id de origem da conversa (source id)

Exemplo:

"1234567890"

​
inbox_id
integer

Id da caixa de entrada na qual a conversa é criada
Tipos de caixa de entrada permitidos: Website, Phone, Api, Email

Exemplo:

1

​
contact_id
integer

Id do contato para o qual a conversa é criada

Exemplo:

1

​
additional_attributes
object

Permite especificar atributos como informações do navegador

Exemplo:
{
  "browser": "Chrome",
  "browser_version": "89.0.4389.82",
  "os": "Windows",
  "os_version": "10"
}
​
custom_attributes
object

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

Exemplo:
{
  "attribute_key": "attribute_value",
  "priority_conversation_number": 3
}
​
status
enum<string>

Especifique a conversa se estiver pendente, aberta, fechada

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

"open"

​
assignee_id
integer

Id do agente para atribuir uma conversa a um agente

Exemplo:

1

​
team_id
integer

Id da equipe para atribuir uma conversa a uma equipe\

Exemplo:

1

​
snoozed_until
string<date-time>

Adiada até a data e hora

Exemplo:

"2030-07-21T17:32:28Z"

​
message
object

A mensagem inicial a ser enviada para a conversa

Resposta

Sucesso

​
id
number

ID da conversa

​
account_id
number

ID da conta

​
inbox_id
number

ID da caixa de entrada