Pular para o conteúdo principal
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
agent_bots
/
{id}
Atualizar an agente bot
curl --request PATCH \
  --url https://airys.chat/api/v1/accounts/{account_id}/agent_bots/{id} \
  --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",
  "avatar": "<string>",
  "avatar_url": "https://example.com/avatar.png",
  "bot_type": 0,
  "bot_config": {}
}
'
import requests

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

payload = {
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png",
"bot_type": 0,
"bot_config": {}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
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',
avatar: '<string>',
avatar_url: 'https://example.com/avatar.png',
bot_type: 0,
bot_config: {}
})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/agent_bots/{id}', 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}/agent_bots/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My Agent Bot',
'description' => 'This is a sample agent bot',
'outgoing_url' => 'https://example.com/webhook',
'avatar' => '<string>',
'avatar_url' => 'https://example.com/avatar.png',
'bot_type' => 0,
'bot_config' => [

]
]),
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}/agent_bots/{id}"

payload := strings.NewReader("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://airys.chat/api/v1/accounts/{account_id}/agent_bots/{id}")
.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 \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.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 \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\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

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

id
integer
obrigatório

O ID do agentbot a ser atualizado

Corpo

application/json
name
string

O nome do agent bot

Exemplo:

"My Agent Bot"

description
string

A descrição do agent bot

Exemplo:

"This is a sample agent bot"

outgoing_url
string

O URL do webhook para o bot

Exemplo:

"https://example.com/webhook"

avatar
file

Envie os dados do formulário com o binário da imagem do avatar ou use a avatar_url

avatar_url
string

A url para um arquivo jpeg, png para o avatar do agent bot

Exemplo:

"https://example.com/avatar.png"

bot_type
integer

O tipo de bot (0 para webhook)

Exemplo:

0

bot_config
object

A configuração para o bot

Exemplo:
{}

Resposta

Sucesso

id
number

ID do agent bot

name
string

O nome do agent bot

description
string

A descrição sobre o agent bot

thumbnail
string

A miniatura do agent bot

outgoing_url
string

O URL do webhook para o bot

bot_type
string

O tipo do bot

bot_config
object

A configuração do bot

account_id
number

ID da conta, se for um bot específico da conta

access_token
string

O token de acesso para o bot

system_bot
boolean

Se o bot é um bot do sistema