Criar an agente Bot
Criar um agent bot
curl --request POST \
--url https://airys.chat/platform/api/v1/agent_bots \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
'import requests
url = "https://airys.chat/platform/api/v1/agent_bots"
payload = {
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
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 Agent Bot',
description: 'This is a sample agent bot',
outgoing_url: 'https://example.com/webhook',
account_id: 1,
avatar: '<string>',
avatar_url: 'https://example.com/avatar.png'
})
};
fetch('https://airys.chat/platform/api/v1/agent_bots', 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/agent_bots",
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 Agent Bot',
'description' => 'This is a sample agent bot',
'outgoing_url' => 'https://example.com/webhook',
'account_id' => 1,
'avatar' => '<string>',
'avatar_url' => 'https://example.com/avatar.png'
]),
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/agent_bots"
payload := strings.NewReader("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\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/agent_bots")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://airys.chat/platform/api/v1/agent_bots")
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 Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"outgoing_url": "<string>",
"bot_type": "<string>",
"bot_config": {},
"account_id": 123,
"access_token": "<string>",
"system_bot": true
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}Autorizações
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
O nome do agent bot
"My Agent Bot"
A descrição do agent bot
"This is a sample agent bot"
O URL do webhook para o bot
"https://example.com/webhook"
O ID da conta para associar o agent bot
1
Envie os dados do formulário com o binário da imagem do avatar ou use a avatar_url
A url para um arquivo jpeg, png para o avatar do agent bot
"https://example.com/avatar.png"
Resposta
Sucesso
ID do agent bot
O nome do agent bot
A descrição sobre o agent bot
A miniatura do agent bot
O URL do webhook para o bot
O tipo do bot
A configuração do bot
ID da conta, se for um bot específico da conta
O token de acesso para o bot
Se o bot é um bot do sistema
curl --request POST \
--url https://airys.chat/platform/api/v1/agent_bots \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
'import requests
url = "https://airys.chat/platform/api/v1/agent_bots"
payload = {
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
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 Agent Bot',
description: 'This is a sample agent bot',
outgoing_url: 'https://example.com/webhook',
account_id: 1,
avatar: '<string>',
avatar_url: 'https://example.com/avatar.png'
})
};
fetch('https://airys.chat/platform/api/v1/agent_bots', 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/agent_bots",
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 Agent Bot',
'description' => 'This is a sample agent bot',
'outgoing_url' => 'https://example.com/webhook',
'account_id' => 1,
'avatar' => '<string>',
'avatar_url' => 'https://example.com/avatar.png'
]),
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/agent_bots"
payload := strings.NewReader("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\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/agent_bots")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://airys.chat/platform/api/v1/agent_bots")
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 Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"outgoing_url": "<string>",
"bot_type": "<string>",
"bot_config": {},
"account_id": 123,
"access_token": "<string>",
"system_bot": true
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}