joinCall method

Future<DynamiteResponse<CallJoinCallResponseApplicationJson, void>> joinCall({
  1. required String token,
  2. CallJoinCallFlags? flags,
  3. CallJoinCallForcePermissions? forcePermissions,
  4. CallJoinCallSilent? silent,
  5. CallJoinCallRecordingConsent? recordingConsent,
  6. CallJoinCallApiVersion? apiVersion,
  7. bool? oCSAPIRequest,
})

Join a call.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • flags In-Call flags.
  • forcePermissions In-call permissions.
  • silent Join the call silently. Defaults to 0.
  • recordingConsent When the user ticked a checkbox and agreed with being recorded (Only needed when the config => call => recording-consent capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} and the conversation recordingConsent value is {@see RecordingService::CONSENT_REQUIRED_YES} ). Defaults to 0.
  • apiVersion Defaults to v4.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Call joined successfully
  • 404: Call not found
  • 400: No recording consent was given

See:

  • joinCallRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<CallJoinCallResponseApplicationJson, void>> joinCall({
  required String token,
  CallJoinCallFlags? flags,
  CallJoinCallForcePermissions? forcePermissions,
  CallJoinCallSilent? silent,
  CallJoinCallRecordingConsent? recordingConsent,
  CallJoinCallApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = joinCallRaw(
    token: token,
    flags: flags,
    forcePermissions: forcePermissions,
    silent: silent,
    recordingConsent: recordingConsent,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}