Sample Request
This API allows you to create a new schedule call.
curl --request POST \
--url https://api-smartflo.tatateleservices.com/v1/dialer/schedule_call/
--header 'accept: application/json' \
--header 'content-type: application/json'📘Important
Before we begin, note that the * sign denotes the mandatory variables in each table.
Request Variables (Body Params)
Variable Name | Description | Data Type |
|---|---|---|
customer_name | The name of the lead for whom the callback is being scheduled. | String |
schedule_date_time | The exact date and time when the call should be scheduled, format: YYYY-MM-DD HH:MM:SS. | String |
assigned_to | The agent ID to whom this scheduled call is assigned. Agent ID example- (05056XX1974) | String |
customer_number | The contact number of the customer to be called. | String |
reminder_schedule_callbacks | If true, a reminder notification will be set for the scheduled callback. | Boolean |
reminder_time | The time (in minutes) before the scheduled callback when the reminder should be triggered. | Integer |
call_end_min | The duration after which the scheduled call should automatically end if unanswered. | Integer |
inbound_queue | The queue ID to which this scheduled callback belongs. Only applicable when dialer campaign inbound callback is 1 through campaigns API. | Integer |
Response Variables
After the execution of the API, you will get the following response:
| Variable Name | Description | Data Type |
|---|---|---|
| success | The request success status, the possible values are: True (default) for success. False for failure. | Boolean |
| message | The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here. | String |