Download OpenAPI specification:Download
API for creating and retrieving call jobs.
Request payload for creating a call job.
| workflowId required | string Identifier for the call workflow. |
| scheduledAt | string <date-time> Optional scheduled time in RFC3339 format. |
required | object (LeadInfo) |
{- "workflowId": "flow_123",
- "scheduledAt": "2025-02-05T15:04:05Z",
- "leadInfo": {
- "phoneNumber": "+6598765432",
- "countryCode": "SG",
- "customerData": {
- "name": "John Doe",
- "email": "john.doe@example.com"
}
}
}{- "data": {
- "callJobId": "lead_456"
}, - "status": "success",
- "errorMessage": null
}| call_job_id required | string The identifier of the call job (lead ID). |
{- "data": {
- "callOutput": [
- {
- "scheduledAt": "2025-02-05T15:04:05Z",
- "calledAt": "2025-02-05T15:05:05Z",
- "callEndedAt": "2025-02-05T15:10:05Z",
- "summary": "Call completed successfully.",
- "result": {
- "key": "value"
}, - "transcript": "Hello, this is a call transcript.",
- "callEndReason": "Completed"
}
], - "customerData": {
- "name": "John Doe",
- "email": "john.doe@example.com"
}
}, - "status": "success",
- "errorMessage": null
}