Get scheduled callback

Returns a scheduled callback by ID.

The Get scheduled callback endpoint returns details for a single scheduled callback task.

Requirements: Base URL, Authentication, Error codes

Scope: tasks.scheduled_callbacks.manage

What this does

When you send a Get scheduled callback request with a scheduled callback ID,

Voiso
returns the scheduled callback object for that task.

When to use it

  • Retrieve a callback after you have its ID from List scheduled callbacks
  • Display callback details in an external system
  • Confirm the current status of a scheduled callback

Prerequisites

  • Scheduled callbacks must be enabled for your contact center.
  • The scheduled callback must exist and be accessible to your API key.

Endpoint


GET /api/v4/tasks/scheduled_callbacks/{scheduled_callback_id}

Path parameters

  • scheduled_callback_id
    The unique identifier of the scheduled callback.

Examples

Minimal request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/tasks/scheduled_callbacks/149" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns a scheduled callback object.

{
  "scheduled_callback": {
    "id": 149,
    "phone_number": "18885658889",
    "scheduled_at": "2025-12-12T12:00:00.000+02:00",
    "user": {
      "id": "0b97ce11-b6e0-49b4-8f92-68040aa324bf",
      "name": "Jane Doe",
      "email": "[email protected]"
    },
    "caller_id_group": {
      "id": 1,
      "name": "Default"
    },
    "note": "Follow up call",
    "related_call": null,
    "source": {
      "system": "zoho",
      "account_id": "ACC01"
    },
    "status": "pending"
  }
}

Notes

  • scheduled_at is returned in ISO 8601 format.
  • note, related_call, and source can be null if they were not provided when the callback was created.

Troubleshooting

401 Unauthorized

What to check:

  • You are sending Authorization: Bearer <contact_center_api_key>.
  • Your Base URL includes the correct {cluster_id}.

403 Forbidden

Common causes:

  • Scheduled callbacks are not enabled for the contact center.
  • Your API key does not have access to scheduled callback resources.

404 Not found

This usually means the scheduled callback ID does not exist, or you do not have access to it.

What to check:

Example response:

{ "error": "Not found" }

429 Too many requests

What to do:

  • Reduce request frequency and retry with backoff.
Path Params
integer
required

Scheduled callback ID

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json