Skip to main content
GET
/
v1
/
agents
List agents
curl --request GET \
  --url https://api.eu.volubile.ai/v1/agents \
  --header 'X-Api-Key: <api-key>'
import requests

url = "https://api.eu.volubile.ai/v1/agents"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.eu.volubile.ai/v1/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_URL => "https://api.eu.volubile.ai/v1/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "https://api.eu.volubile.ai/v1/agents"

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

req.Header.Add("X-Api-Key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.eu.volubile.ai/v1/agents")
.header("X-Api-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.eu.volubile.ai/v1/agents")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "content": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "telephonyConfiguration": {
        "sipConnection": {
          "did": "2566458"
        },
        "phoneNumbers": [
          "+33612345678",
          "+33612345679"
        ]
      },
      "name": "<string>",
      "active": true,
      "recordable": true,
      "archived": true,
      "configuration": {
        "extractors": [
          {
            "description": "Extract all the information about the customer",
            "extractors": [
              {
                "description": "Customer's first name",
                "name": "First name"
              },
              {
                "description": "Customer's last name",
                "name": "Last name"
              },
              {
                "description": "Customer's phone number in a valid format (+33)",
                "name": "Phone"
              },
              {
                "description": "Customer's email in a valid format",
                "name": "Email"
              },
              {
                "description": "Customer address information",
                "name": "Address",
                "extractors": [
                  {
                    "description": "Street address of the customer, including house number and street name",
                    "name": "Street"
                  },
                  {
                    "description": "Postal code of the customer's address",
                    "name": "Postal code"
                  },
                  {
                    "description": "City or locality where the customer resides",
                    "name": "City"
                  }
                ]
              }
            ],
            "name": "Customer information"
          }
        ],
        "classifiers": [
          {
            "description": "What was the reason for the call",
            "name": "Classification of the call",
            "values": [
              "Support",
              "Sales",
              "Billing",
              "Technical issue"
            ]
          }
        ]
      }
    }
  ],
  "size": 123,
  "page": 123,
  "totalElements": 123,
  "totalPages": 123
}
{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"message": "<string>",
"errors": [
{
"field": "<string>",
"rejectedValue": {},
"message": "<string>"
}
]
}
{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"message": "<string>",
"errors": [
{
"field": "<string>",
"rejectedValue": {},
"message": "<string>"
}
]
}
{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"message": "<string>",
"errors": [
{
"field": "<string>",
"rejectedValue": {},
"message": "<string>"
}
]
}
{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"message": "<string>",
"errors": [
{
"field": "<string>",
"rejectedValue": {},
"message": "<string>"
}
]
}

Authorizations

X-Api-Key
string
header
required

Your API key.

Query Parameters

type
enum<string>

Filter by type

Available options:
INBOUND,
OUTBOUND
page
string
default:1

The page number to be returned, starts at 1

size
string
default:25

The number of items to be returned, maximum 100

sort
enum<string>

The sort property and direction

Available options:
<property>,ASC,
<property>,DESC
Example:

"property,DESC"

Response

OK

content
object[]

List of items in the current page

size
integer<int32>

The size of the page

page
integer<int32>

The page number

totalElements
integer<int64>

The total amount of elements

totalPages
integer<int32>

The number of total pages