Pular para o conteúdo principal
POST
/
api
/
v1
/
accounts
/
{account_id}
/
teams
Criar a team
curl --request POST \
  --url https://airys.chat/api/v1/accounts/{account_id}/teams \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "Support Team",
  "description": "This is a team of support agents",
  "allow_auto_assign": true
}
'
import requests

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

payload = {
"name": "Support Team",
"description": "This is a team of support agents",
"allow_auto_assign": True
}
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({
name: 'Support Team',
description: 'This is a team of support agents',
allow_auto_assign: true
})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/teams', 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}/teams",
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([
'name' => 'Support Team',
'description' => 'This is a team of support agents',
'allow_auto_assign' => true
]),
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}/teams"

payload := strings.NewReader("{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\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}/teams")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "allow_auto_assign": true,
  "account_id": 123,
  "is_member": true
}
{
"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
name
string

O nome da equipe

Exemplo:

"Support Team"

description
string

A descrição da equipe

Exemplo:

"This is a team of support agents"

allow_auto_assign
boolean

Se esta configuração estiver ativada, o sistema atribuirá automaticamente a conversa a um agente na equipe ao atribuir a conversa a uma equipe

Exemplo:

true

Resposta

Sucesso

id
number

O ID da equipe

name
string

O nome da equipe

description
string | null

A descrição sobre a equipe

allow_auto_assign
boolean

Se esta configuração estiver ativada, o sistema atribuirá automaticamente a conversa a um agente na equipe ao atribuir a conversa a uma equipe

account_id
number

O ID da conta da qual a equipe faz parte

is_member
boolean

Este campo mostra se o usuário atual faz parte da equipe