API reference
Get a scheduled call
GET /v1/scheduled-calls/{scheduled_call_id}
One scheduled call: when it will be placed, or what became of it. calls:write.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scheduled_call_id |
path | string (uuid) | Yes |
Answer
200 with ScheduledCall.
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. |
404 |
This key reaches no such scheduled call. |
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
# Read a scheduled call. Once it is placed, conversation_id names the conversation.
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/scheduled-calls/4b6d8f0a-2c4e-4a6c-9e8a-0c2e4a6c8e0b" \
-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.