@wppconnect/wa-js/dist/call/functions/end.d.ts

WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web

/*!
 * Copyright 2024 WPPConnect Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * End a call
 *
 * @example
 * ```javascript
 * // End any call
 * WPP.call.end();
 *
 * // End specific call id
 * WPP.call.end(callId);
 *
 * // End any incoming call
 * WPP.on('call.incoming_call', (call) => {
 *   WPP.call.end(call.id);
 * });
 * ```
 *
 * @param   {string}  callId  The call ID, empty to end the first one
 * @return  {[type]}          [return description]
 */
export declare function end(callId?: string): Promise<boolean>;