Contact Data DTO Reference

The NjoguAmos\Waha\Dto\ContactData represents a contact returned from the WAHA API.

use NjoguAmos\Waha\Facades\Contact;
use NjoguAmos\Waha\Dto\ContactData;

$response = Contact::all();
$contacts = $response->dtoOrFail(); // ContactData[]

id → string|null

The contact's WhatsApp ID (chat ID).

$contact->id; // "[email protected]"

number → string|null

The contact's phone number.

$contact->number; // "11231231231"

name → string|null

The contact's display name.

$contact->name; // "Contact Name"

pushname → string|null

The contact's push name (username set by the contact).

$contact->pushname; // "Pushname"

shortName → string|null

The contact's short name.

$contact->shortName; // "Shortname"

isMe → bool|null

Whether this contact is the authenticated user.

$contact->isMe; // true

isGroup → bool|null

Whether this contact is a group.

$contact->isGroup; // false

isWAContact → bool|null

Whether this contact is a WhatsApp user.

$contact->isWAContact; // true

isMyContact → bool|null

Whether this contact is in the authenticated user's contact list.

$contact->isMyContact; // true

isBlocked → bool|null

Whether this contact is blocked.

$contact->isBlocked; // false

TIP

All fields are nullable. Some fields may not be present in the API response, in which case they will be null.