This resource is used to retrieve and schedule callback calls.

GET

Mandatory parameters

Name	Type	Description
customer_id	int	Freespee's unique ID for customer.

Optional parameters

Name	Type	Description
from_date	string	From date in UTC, format 'YYYY-MM-DD HH:MM:SS'. Defaults to current time.
to_date	string	To date in UTC, format 'YYYY-MM-DD HH:MM:SS'. Defaults to a week from now.

Output

Name	Type	Description
id	int	Freespee's unique ID of the callback.
customer_id	int	Freespee's unique ID for the customer.
agent_nr	string	Phone number that will be called first
caller_id	string	The phone number that will be displayed to the end user.
scheduled	string	Time in UTC when the call will be initiated.
retries	int	How many times the call will be retried if not successful.
retry_interval	int	Time in seconds between retry attempts.
completed	int	0 if not completed, 1 if completed.
cdr_id	int	Freespee's unique ID of cdr.

POST

Mandatory parameters

Name	Type	Description
customer_id	int	Freespee's unique ID for customer.
agent_nr	string	The phone number that will be called first in E164 format.
requester_nr	string	The phone number of the person who requested the callback in E164 format.

Optional parameters

Name	Type	Description
scheduled	string	Time to initiate the callback in UTC, format 'YYYY-MM-DD HH:MM:SS'. Defaults to call as soon as possible.
retries	int	Number of attempt to retry the callback if not successful. Defaults to 1.
retry_interval	int	Time in seconds between retry attempts. Defaults to 300 seconds.
caller_id	string	The phone number that will be displayed to the requester. Defaults to the agent_nr
custom_dynamic	json	custom values to be sent included with the request

Output

Name	Type	Description
id	int	Freespee's unique ID of the callback.
customer_id	int	Freespee's unique ID for the customer.
agent_nr	string	Phone number that will be called first
caller_id	string	The phone number that will be displayed to the end user.
scheduled	string	Time in UTC when the call will be initiated.
retries	int	How many times the call will be retried if not successful.
retry_interval	int	Time in seconds between retry attempts.
completed	int	0 if not completed, 1 if completed.
cdr_id	int	Freespee's unique ID of cdr.

PUT

Method not supported.

DELETE

Mandatory parameters

Name	Type	Description
customer_id	int	Freespee's unique ID for customer.
callback_id	int	Id for the callback

Or

Name	Type	Description
customer_id	int	Freespee's unique ID for customer.
to_date	string	Date for callback to be deleted up to

With optional

Name	Type	Description
from_date	string	Starting date for callback to be deleted

What will happen?

It will clear any personal information from all specified callbacks, including any related measures.

When using the first option with customer_id and callback_id it’s possible to cancel an upcoming callback but:
-> please note that if the callback already started (all attempts are not yet finished) this request will fail.