|Help Centre

Developer API: /confirmationcallback

Last updated at

Have you ever had customers missing appointments or simply not showing up as scheduled? While it's possible to make courtesy calls to confirm an appointment with a customer or a prospect, this is time consuming and costly for most companies. 

 

As a solution to this, we have now implemented a Confirmation Callback service, where an automatic callback will reach to a customer or prospect in order to confirm their appointments (and give an opportunity to cancel or to speak with an agent). 

 

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_phone string The phone number that will call the customer
customer_phone string The phone number to connect the agent with
display_phone int The number to display as caller ID
scheduled int The date and time for the appointment
retries int Call attempts to reach the customer
retry_interval int Seconds between call attempts
completed int

 1 = completed or 0 = incomplete

cdr_id int 

 Callback unique ID

POST

Mandatory parameters

Name Type Description
customer_id int Freespee's unique ID for customer.
customer_phone string  
agent_phone string  
call_datetime int  
retries int   
retry_interval int   

Optional parameters

Name Type Description
display_phone  string  Phone number to display as caller ID

Output

Name Type Description
scheduled  int  Date and Time for the callback
retries  int   Number of attempts
retry_interval   int   Seconds between attempts
type  int    
id   int   Unique ID for the callback
agent_phone   string   Phone number for the agent 
customer_phone  string   Number to call for the customer 
display_phone  string   Number to display as caller ID 

PUT

Method not supported.

DELETE

Method not supported.

Can't find what you're looking for?