Skip to main content
GET
/
api
/
agents
/
{agent_id}
/
scheduled_batches
/
{batch_id}
/
scheduled_calls
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/agents/{agent_id}/scheduled_batches/{batch_id}/scheduled_calls \
  --header 'X-API-Key: <api-key>'
{
  "results": [
    {
      "status": "FUTURE",
      "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error": "<string>",
      "medium": {
        "webRtc": {
          "dataMessages": {
            "pong": true,
            "state": true,
            "transcript": true,
            "clientToolInvocation": true,
            "dataConnectionToolInvocation": true,
            "playbackClearBuffer": true,
            "callStarted": true,
            "debug": true,
            "callEvent": true,
            "toolUsed": true,
            "userStartedSpeaking": true,
            "userStoppedSpeaking": true
          }
        },
        "twilio": {
          "outgoing": {
            "to": "<string>",
            "from": "<string>",
            "additionalParams": {}
          }
        },
        "serverWebSocket": {
          "inputSampleRate": 123,
          "outputSampleRate": 123,
          "clientBufferSizeMs": 123,
          "dataMessages": {
            "pong": true,
            "state": true,
            "transcript": true,
            "clientToolInvocation": true,
            "dataConnectionToolInvocation": true,
            "playbackClearBuffer": true,
            "callStarted": true,
            "debug": true,
            "callEvent": true,
            "toolUsed": true,
            "userStartedSpeaking": true,
            "userStoppedSpeaking": true
          }
        },
        "telnyx": {
          "outgoing": {
            "to": "<string>",
            "from": "<string>",
            "additionalParams": {}
          }
        },
        "plivo": {
          "outgoing": {
            "to": "<string>",
            "from": "<string>",
            "additionalParams": {}
          }
        },
        "exotel": {},
        "sip": {
          "incoming": {},
          "outgoing": {
            "to": "<string>",
            "from": "<string>",
            "username": "<string>",
            "password": "<string>"
          }
        }
      },
      "metadata": "<unknown>",
      "templateContext": "<unknown>",
      "experimentalSettings": "<unknown>"
    }
  ],
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
agent_id
string<uuid>
required
​
batch_id
string<uuid>
required

Query Parameters

​
cursor
string

The pagination cursor value.

​
pageSize
integer

Number of results to return per page.

​
status
enum<string>
  • FUTURE - FUTURE
  • PENDING - PENDING
  • SUCCESS - SUCCESS
  • EXPIRED - EXPIRED
  • ERROR - ERROR
Available options:
FUTURE,
PENDING,
SUCCESS,
EXPIRED,
ERROR
Minimum string length: 1

Response

200 - application/json
​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"

​
total
integer
Example:

123