Pular para o conteúdo principal
POST
/
platform
/
api
/
v1
/
accounts
Criar an conta
curl --request POST \
  --url https://airys.chat/platform/api/v1/accounts \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "My Account",
  "locale": "en",
  "domain": "example.com",
  "support_email": "support@example.com",
  "status": "active",
  "limits": {},
  "custom_attributes": {}
}
'
import requests

url = "https://airys.chat/platform/api/v1/accounts"

payload = {
"name": "My Account",
"locale": "en",
"domain": "example.com",
"support_email": "support@example.com",
"status": "active",
"limits": {},
"custom_attributes": {}
}
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: 'My Account',
locale: 'en',
domain: 'example.com',
support_email: 'support@example.com',
status: 'active',
limits: {},
custom_attributes: {}
})
};

fetch('https://airys.chat/platform/api/v1/accounts', 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/platform/api/v1/accounts",
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' => 'My Account',
'locale' => 'en',
'domain' => 'example.com',
'support_email' => 'support@example.com',
'status' => 'active',
'limits' => [

],
'custom_attributes' => [

]
]),
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/platform/api/v1/accounts"

payload := strings.NewReader("{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\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/platform/api/v1/accounts")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/platform/api/v1/accounts")

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\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>"
}
{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido pelo administrador do sistema após a criação de um platformApp. Este token deve ser usado para provisionar bot de agentes, contas, usuários e suas funções.

Corpo

application/json
name
string

Nome da conta

Exemplo:

"My Account"

locale
string

A localidade (locale) da conta

Exemplo:

"en"

domain
string

O domínio da conta

Exemplo:

"example.com"

support_email
string

O e-mail de suporte da conta

Exemplo:

"support@example.com"

status
enum<string>

O status da conta

Opções disponíveis:
active,
suspended
Exemplo:

"active"

limits
object

Os limites da conta

Exemplo:
{}
custom_attributes
object

Os atributos personalizados da conta

Exemplo:
{}

Resposta

Sucesso

id
number

ID da conta

name
string

Nome da conta