Module Manager

Appearance

Whatsapp Facade ​

The Whatsapp facade provides a simple way to interact with the Whatsapp module's services.

Available Methods ​

instance() ​

Returns an instance of the InstanceService, which can be used to manage Whatsapp instances.

Example:

php
use Modules\Whatsapp\Facades\Whatsapp;

$instanceService = Whatsapp::instance();

message() or messages() ​

Returns an instance of the MessageService, which can be used to send messages.

Example:

php
use Modules\Whatsapp\Facades\Whatsapp;

$messageService = Whatsapp::message();

status() ​

Returns an instance of the StatusService, which can be used to manage statuses.

Example:

php
use Modules\Whatsapp\Facades\Whatsapp;

$statusService = Whatsapp::status();

groups() ​

Returns an instance of the GroupService, which can be used to manage groups.

Example:

php
use Modules\Whatsapp\Facades\Whatsapp;

$groupService = Whatsapp::groups();

InstanceService Methods ​

create(Instance $instance): Instance ​

Creates a new Whatsapp instance.

find(?Instance $instance = null, ?string $instanceName = null, ?string $instanceId = null): Collection | Instance | null ​

Finds one or more Whatsapp instances.

update(Instance $instance): Instance ​

Updates a Whatsapp instance.

updateConnection(Instance $instance): bool ​

Updates the connection status of a Whatsapp instance.

delete(Instance $instance): bool ​

Deletes a Whatsapp instance.

restart(Instance $instance): bool ​

Restarts a Whatsapp instance.

getAll(): Collection ​

Gets all Whatsapp instances.

connect(Instance $instance, ?string $phoneNumber = null): EvoResponse | false ​

Connects a Whatsapp instance.

getWhatsappProfile(Instance $instance, string $number): ?CheckIsWhatsappResponse ​

Gets the Whatsapp profile for a given number.

MessageService Methods ​

text(Instance $instance, Contact | Group $target, string $message): bool ​

Sends a text message.

media(Instance $instance, Contact | Group $target, MediaObject $mediaObject): bool ​

Sends a media message.

audio(Instance $instance, Contact | Group $target, MediaObject $mediaObject): bool ​

Sends an audio message.

StatusService Methods ​

text(Instance $instance, array $settings): bool ​

Sends a text status.

media(Instance $instance, array $settings): bool ​

Sends a media status.

audio(Instance $instance, array $settings): bool ​

Sends an audio status.

sendStatus(Status $status): bool ​

Sends a status.

GroupService Methods ​

create(Instance $instance, Group $group): Group ​

Creates a new group.

updatePicture(Instance $instance, Group $group, string $pictureUrl): bool ​

Updates a group's picture.

updateSubject(Instance $instance, Group $group): bool ​

Updates a group's subject.

updateDescription(Instance $instance, Group $group): bool ​

Updates a group's description.

getInviteCode(Instance $instance, Group $group): Group ​

Gets a group's invite code.

revokeInviteCode(Instance $instance, Group $group): bool ​

Revokes a group's invite code.

findById(Instance $instance, Group $group): array ​

Finds a group by its ID.

fetchAll(Instance $instance, bool $includeParticipants = false, bool $onlyIsAdmin = false): Collection ​

Fetches all groups.

getParticipants(Instance $instance, Group $group): array ​

Gets a group's participants.

updateSettings(Instance $instance, Group $group): bool ​

Updates a group's settings.

leave(Instance $instance, Group $group): bool ​

Leaves a group.

addParticipants(Instance $instance, Group $group, Collection $contacts): bool ​

Adds participants to a group.

removeParticipants(Instance $instance, Group $group, Collection $contacts): bool ​

Removes participants from a group.

promoteParticipants(Instance $instance, Group $group, Collection $contacts): bool ​

Promotes participants in a group.

demoteParticipants(Instance $instance, Group $group, Collection $contacts): bool ​

Demotes participants in a group.

getSettings(Instance $instance, Group $group): GroupSettings ​

Gets a group's settings.