Get server agents

Get all agents for a server

GET /api/messaging/message-servers/{messageServerId}/agents

Get server agents

cURL

curl --request GET \
  --url http://localhost:3000/api/messaging/message-servers/{messageServerId}/agents

import requests

url = "http://localhost:3000/api/messaging/message-servers/{messageServerId}/agents"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('http://localhost:3000/api/messaging/message-servers/{messageServerId}/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/messaging/message-servers/{messageServerId}/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/messaging/message-servers/{messageServerId}/agents"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:3000/api/messaging/message-servers/{messageServerId}/agents")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/messaging/message-servers/{messageServerId}/agents")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

Path Parameters

messageServerId · string<uuid> · required

Response

200

application/json

Agents retrieved successfully

success · boolean

data · object[]

Show child attributes