Create Appointment

Authorizations

Authorization

string

header

required

Provide a Bearer Token

Body

application/json

appointment_at

string<date-time>

The date and time of the appointment

Example:

"2021-01-01T00:00:00.000Z"

duration_in_minutes

integer

The duration of the appointment in minutes

Example:

60

department_id

any

is_interpreter_needed

boolean

Whether an interpreter is needed for the appointment

Example:

true

interpreter_language

string

The language of the interpreter

Example:

"English"

reference

string

The reference of the appointment

Example:

123456789

claimant

any

features_call_recording_enable

boolean

Whether the call recording is enabled

Example:

true

features_breakout_room_enable

boolean

Whether the breakout room is enabled

Example:

true

features_webcam_access_agent_enable

boolean

Whether the webcam access for agent is enabled

Example:

true

features_webcam_access_claimant_enable

boolean

Whether the webcam access for claimant is enabled

Example:

true

features_webcam_background_blurring_enable

boolean

Whether the webcam background blurring is enabled

Example:

true

features_microphone_access_enable

boolean

Whether the microphone access is enabled

Example:

true

Whether the screen sharing is enabled

Example:

true

features_messages_chat_enable

boolean

Whether the chat messages are enabled

Example:

true

features_participant_list_enable

boolean

Whether the participant list is enabled

Example:

true

features_bandwidth

enum<string>

The bandwidth of the appointment

Available options:

low,

medium,

high

use_custom_post_call_redirect

boolean

Select true if a separate redirect is required for a caller

Example:

true

custom_user_post_call_redirect_url

string | null

The url of the custom post call redirect

custom_agent_post_call_redirect_url

string | null

The url of the custom post call redirect for agent

Response

201 - application/json

Created.

data

any

required

API documentation

Authorisation

Scheduled Calls

Waiting Areas

Create Appointment

Authorizations

Body

Response