ringAttendee method

Future<DynamiteResponse<CallRingAttendeeResponseApplicationJson, void>> ringAttendee({
  1. required String token,
  2. required int attendeeId,
  3. CallRingAttendeeApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Ring an attendee.

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 v4.
  • token
  • attendeeId ID of the attendee to ring.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Attendee rang successfully
  • 400: Ringing attendee is not possible
  • 404: Attendee could not be found

See:

Implementation

Future<DynamiteResponse<CallRingAttendeeResponseApplicationJson, void>> ringAttendee({
  required String token,
  required int attendeeId,
  CallRingAttendeeApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = ringAttendeeRaw(
    token: token,
    attendeeId: attendeeId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}