Zmień status agenta

curl --request PUT \
  --url https://api.example.com/api/v1/agents/{agent_id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/agents/{agent_id}/status"

payload = { "status": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({status: '<string>'})
};

fetch('https://api.example.com/api/v1/agents/{agent_id}/status', 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://api.example.com/api/v1/agents/{agent_id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <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://api.example.com/api/v1/agents/{agent_id}/status"

	payload := strings.NewReader("{\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-API-Key", "<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.put("https://api.example.com/api/v1/agents/{agent_id}/status")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/agents/{agent_id}/status")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "public_id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "workflow_definition": {},
  "current_definition_id": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "template_context_variables": {},
  "call_disposition_codes": {},
  "total_runs": 123,
  "workflow_configurations": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PUT

api

agents

{agent_id}

status

Zmień status agenta

curl --request PUT \
  --url https://api.example.com/api/v1/agents/{agent_id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/agents/{agent_id}/status"

payload = { "status": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({status: '<string>'})
};

fetch('https://api.example.com/api/v1/agents/{agent_id}/status', 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://api.example.com/api/v1/agents/{agent_id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <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://api.example.com/api/v1/agents/{agent_id}/status"

	payload := strings.NewReader("{\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-API-Key", "<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.put("https://api.example.com/api/v1/agents/{agent_id}/status")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/agents/{agent_id}/status")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "public_id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "workflow_definition": {},
  "current_definition_id": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "template_context_variables": {},
  "call_disposition_codes": {},
  "total_runs": 123,
  "workflow_configurations": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autoryzacje

X-API-Key

string

header

wymagane

Klucz API organizacji (konto w lewym dolnym rogu panelu → Brosbots API).

Nagłówki

authorization

string | null

X-API-Key

string | null

Parametry ścieżki

agent_id

wymagane

ID agenta: publiczny identyfikator agent_ + 20 znaków (pokazywany w panelu, zalecany) albo dotychczasowy numer. Oba wskazują tego samego agenta.

Pattern: ^agent_[A-Za-z0-9]{20}$

Przykład:

"agent_7fK2mQ9xLp3RtV8wYb1N"

Treść

application/json

status

string

wymagane

Odpowiedź

Pomyślna odpowiedź

integer

wymagane

public_id

string

wymagane

name

string

wymagane

status

string

wymagane

created_at

string<date-time>

wymagane

workflow_definition

object

wymagane

current_definition_id

integer | null

wymagane

updated_at

string<date-time> | null

template_context_variables

object | null

call_disposition_codes

object | null

total_runs

integer | null

workflow_configurations

object | null

Start

Endpointy

Zmień status agenta

Autoryzacje

Nagłówki

Parametry ścieżki

Treść

Odpowiedź