Sign in
video
video

Initiate Call

Initiate a video/audio call between users.

Checks:

  • User authentication (must be logged in)
  • Call minutes quota (unless admin/premium)
  • Caller identity verification (can't initiate as someone else)
  • Relationship validation: Users must be friends OR have an accepted tutor-student relationship OR have a booking today
  • Admins can call anyone (bypass relationship check)
post/video/call/initiate

Headers

authorizationstring nullable

Request body

caller_idstring required
callee_idstring required
call_typestring
conversation_languagestring nullable
transcription_languagestring nullable
translation_languagestring nullable
conversation_idstring nullable
transcription_enabledboolean nullable
scheduled_duration_minutesinteger nullable
call_modestring nullable
exchange_period_secondsinteger nullable
exchange_language_bstring nullable
language_for_practicestring nullable
learner_idstring nullable
teacher_idstring nullable
lesson_contextobject nullable

Response

Successful Response

{"stackTrail":"paths:/video/call/initiate:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.