GET
/
v1
/
agents
/
{id}
curl --request GET \
  --url https://api.eu.volubile.ai/v1/agents/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "telephonyConfiguration": {
    "phoneNumbers": [
      "+33612345678",
      "+33612345679"
    ],
    "sipConnection": {
      "did": "2566458"
    }
  },
  "name": "<string>",
  "type": "INBOUND",
  "active": true,
  "recordable": true
}

Authorizations

X-Api-Key
string
header
required

Your API key.

Path Parameters

id
string
required

Unique identifier of the agent

Response

200
application/json
OK
id
string

Unique identifier of the agent

telephonyConfiguration
object

Telephony configuration of the agent containing phone numbers and SIP connections

name
string

Name of the agent

type
enum<string>

Type of the agent

Available options:
INBOUND,
OUTBOUND
active
boolean

If the agent is active

recordable
boolean

If the agent record calls