API reference
List scheduled calls
GET /v1/scheduled-calls
The calls this key's side of test mode scheduled, newest first. Filter by status. Needs calls:write.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
status |
query | ScheduledCallStatus or null | No | Only these: scheduled, placed, cancelled, failed. |
limit |
query | integer | No | How many to return, 1 to 100. |
cursor |
query | string or null | No | next_cursor from the previous page, with the same filters. |
Answer
200 with ScheduledCallList.
Errors
Every error is a problem document with a stable code.
| Status | When |
|---|---|
401 |
The key is missing, mistyped, unknown, revoked or expired. |
403 |
The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something. |
422 |
Validation Error |
429 |
Too many requests for this key or its organization; see Retry-After. |
500 |
Something went wrong on our side. Quote the request_id to support. |
Examples
#!/bin/sh
# List the calls still waiting
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/scheduled-calls?status=scheduled" \
-H "Authorization: Bearer $AIGENTLY_API_KEY"
Try it
Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.