recordingGetWelcomeMessage method

Future<DynamiteResponse<RecordingGetWelcomeMessageResponseApplicationJson, void>> recordingGetWelcomeMessage({ required int serverId, RecordingGetWelcomeMessageApiVersion? apiVersion, bool? oCSAPIRequest, })

Get the welcome message of a recording server.

This endpoint requires admin access.

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:

• apiVersion Defaults to "v1".
• serverId ID of the server.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Welcome message returned
• 404: Recording server not found or not configured
• 500

See:

• $recordingGetWelcomeMessage_Request for the request send by this method.
• $recordingGetWelcomeMessage_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<RecordingGetWelcomeMessageResponseApplicationJson, void>> recordingGetWelcomeMessage({
  required int serverId,
  RecordingGetWelcomeMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $recordingGetWelcomeMessage_Request(
    serverId: serverId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $recordingGetWelcomeMessage_Serializer();
  return _i1.ResponseConverter<RecordingGetWelcomeMessageResponseApplicationJson, void>(_serializer)
      .convert(_response);
}