Provide the ability to search for a scheduled System or Personal Callback.
Endpoint:
GET https://api.convoso.com/v1/callbacks/search
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
|
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
auth_token |
string |
✅ Yes |
authorization token |
|
start_date |
string |
❌ No |
Filter callbacks starting from this date. Format: YYYY-MM-DD. |
|
end_date |
string |
❌ No |
Filter callbacks ending at this date. Format: YYYY-MM-DD. |
|
offset |
integer |
❌ No |
Offset for pagination. Default: 0. |
|
limit |
integer |
❌ No |
Max number of entries to return. Default: 20. |
|
campaign_id |
integer |
❌ No |
Filter callbacks by campaign ID. |
|
comments |
string |
❌ No |
Search callbacks by comments (partial match). |
|
account_id |
integer |
❌ No |
Filter by account ID (if applicable). |
|
id |
integer |
❌ No |
Filter by callback ID. |
|
lead_id |
integer |
❌ No |
Filter by associated lead ID. |
|
list_id |
integer |
❌ No |
Filter by lead list ID. |
|
recipient |
string |
❌ No |
Filter by recipient type: "System" or "Personal". |
|
user_id |
integer |
❌ No |
Filter by assigned user ID. |
|
stage |
string |
❌ No |
Filter by callback stage (e.g., "PENDING", "DISMISSED", "COMPLETED", "MISSED","PASTDUE"). |
Example Request
GET https://api.convoso.com/v1/callbacks/insert?auth_token=YOUR_AUTH_TOKEN&start_date=&end_date=&offset=0&limit=20&campaign_id=&comments=&account_id=&id=&lead_id=&list_id=&recipient=&user_id=&stage=
Response Format (JSON)
{
"success": true,
"data": {
"offset": "0",
"limit": "20",
"total": "12250",
"results": [
{
"id": "9999",
"lead_id": "9999",
"list_id": "123456",
"campaign_id": "123",
"status": "DISMISSED",
"created_at": "2025-06-03 14:59:06",
"callback_time": "2025-06-03 15:00:00",
"modified_at": "2025-06-03 14:59:06",
"user": "12345677",
"recipient": "USERONLY",
"comments": "",
"context": "104569",
"callback_seen": "2025-06-03 14:59:06",
"stage": "Dismissed",
"class": "past_due",
"user_name": "Agent Name",
"directory_name": "Directory Name",
"campaign_name": "Your Camaign Description",
"campaign_type": "Normal",
"status_name": ""
},
]
}
}
Response Field Definitions
Top-Level Data Object
|
Field |
Type |
Description |
|---|---|---|
|
success |
boolean |
Identifies if the API was executed successfully |
|
data |
object |
Response Object |
Data Object
|
Field |
Type |
Description |
|---|---|---|
|
offset |
string |
Starting record index for pagination. |
|
limit |
string |
Max number of results returned. |
|
total |
string |
Total number of matching records. |
|
results |
array |
Array of callback records. |
Results Object
|
Field |
Type |
Description |
|---|---|---|
|
id |
string |
Unique ID of the callback. |
|
lead_id |
string |
Associated lead ID. |
|
list_id |
string |
ID of the list the lead belongs to. |
|
campaign_id |
string |
ID of the associated campaign. |
|
status |
string |
Status of the callback (LIVE, DISMISSED, etc.). |
|
created_at |
string |
Callback creation timestamp (YYYY-MM-DD HH:mm:ss). |
|
callback_time |
string |
Scheduled callback time (YYYY-MM-DD HH:mm:ss). |
|
modified_at |
string |
Last modified timestamp. |
|
user |
string |
User ID assigned to the callback. |
|
recipient |
string |
Recipient of the callback (USERONLY, system, etc.). |
|
comments |
string |
Optional comments. |
|
context |
string |
Optional context ID or identifier for additional grouping. |
|
callback_seen |
string |
Timestamp when callback was last seen. |
|
stage |
string |
Callback stage (Dismissed, Completed, New, etc.). |
|
class |
string |
UI or logical categorization (past_due, etc.). |
|
user_name |
string |
Full name of the user assigned. |
|
directory_name |
string |
Name of the lead directory. |
|
campaign_name |
string |
Name of the associated campaign. |
|
campaign_type |
string |
Type of campaign (Normal, Manual, etc.). |
|
status_name |
string |
Optional user-friendly status name (may be empty). |