v1

latestOpenAPI 3.0.22026-07-2441902.6 MB

Schedule Callbacks

Create a Callback

Creates a new scheduled callback and returns the created resource. Use this endpoint to schedule a callback for a specific phone number with optional agent assignment and time scheduling.

post/schedule-callbacks

Request body

interaction_idstring required

Id of the interaction

caller_idstring required

The number that will be shown as the caller

time_to_callstring date-time required

The time the callback is scheduled

timezonestring required

The timezone in which the callback is scheduled

assign_type'MYSELF_ONLY' | 'SPECIFIC_AGENT' | 'SPECIFIC_QUEUE' | 'MYSELF_IF_AVAILABLE' | 'ANY_ELIGIBLE_AGENT' required

Describes what assign type is this related to

from_call_type'INBOUND' | 'MANUAL_OUTBOUND' | 'PROACTIVE_OUTBOUND' | 'API' required

Describes what call type is this related to

The communication channel of the callback (VOICE, CHAT, SMS, EMAIL, WHATSAPP, FACEBOOK_MESSENGER, API). If omitted, inferred from from_call_type.

dialing_model'PREDICTIVE' | 'PREVIEW' required

Describes what dialing model is this related to

campaign_idstring

The id of the campaign that originated this callback

record_idstring

The id of the record that is scheduled to be called

record_list_idstring

The id of the record list that is scheduled to be called

phone_numberstring required

The phone number that is scheduled to be called

record_first_namestring

First name of the record that is scheduled to be called

record_last_namestring

Last name of the record that is scheduled to be called

record_extra_dataobject

Extra Data from the record that is scheduled to be called

descriptionstring

The callback note

Response

Created a Callback