Calls: Scheduled Callbacks
The Scheduled Callbacks in your account. Calls will be placed to leads when the callback matches.
GET /scheduled_callbacks
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/scheduled_callbacks
List scheduled callbacks.
Lists scheduled callbacks, future calls the system will place back to a lead, ordered by when they're due to go out by default. Requires agent or superuser access; supports CSV export.
GET /scheduled_callbacks/new
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/scheduled_callbacks/new
Returns a new Scheduled Callback
Returns a new, unsaved Scheduled Callback for the given call_id or lead_id, with its offer and schedule inherited from that call. Requires agent or superuser access, or the request is rejected; even then, an agent account without permission to access calls gets back an empty response instead of the built record.
Params
| Param name | Description |
|---|---|
|
call_id Optional |
The callback will be made against this call.
|
|
lead_id Optional |
The callback will be made against this lead.
|
POST /scheduled_callbacks
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/scheduled_callbacks
Create a Scheduled Callback
Schedules a callback to a lead for place_call_at (interpreted in place_call_time_zone), identified by call_id, lead_id, or a phone number plus schedule_id. If the lead already has a scheduled callback it is updated rather than duplicated; if the lead has no schedule yet it is assigned to schedule_id. Requires agent or superuser access, or the request is rejected.
Params
| Param name | Description |
|---|---|
|
to Optional Blank value allowed |
The telephone number for the consumer who will receive a callback.
|
|
schedule_id Optional Blank value allowed |
The schedule that the callback will be associated with.
|
|
call_id Optional Blank value allowed |
The callback will be made against this call.
|
|
lead_id Optional Blank value allowed |
The callback will be made against this lead.
|
|
connect_with Required |
Who Should The Consumer Talk To?
|
|
place_call_at Required |
When should the callback occur?
|
|
place_call_time_zone Required |
The time zone that will be used when parsing place_call_at
|
GET /scheduled_callbacks/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/scheduled_callbacks/:id
Returns a Scheduled Callback by ID
Fetches a Scheduled Callback by id, or by call_id/lead_id if no callback has been created for that id yet. Requires agent or superuser access, or the request is rejected.
Params
| Param name | Description |
|---|---|
|
call_id Optional |
The callback will be made against this call.
|
|
lead_id Optional |
The callback will be made against this lead.
|
PUT /scheduled_callbacks/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/scheduled_callbacks/:id
Updates a Scheduled Callback by ID
Updates a Scheduled Callback's connect_with target, place_call_at, or place_call_time_zone. Requires agent or superuser access, or the request is rejected.
Params
| Param name | Description |
|---|---|
|
connect_with Required |
Who Should The Consumer Talk To?
|
|
place_call_at Required |
When should the callback occur?
|
|
place_call_time_zone Required |
The time zone that will be used when parsing place_call_at
|
DELETE /scheduled_callbacks/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/scheduled_callbacks/:id
Delete a Scheduled Callback by ID
Deletes a Scheduled Callback, canceling the future call. Requires agent or superuser access, or the request is rejected.