Skip to main content
Use users and contacts to look up WhatsApp profiles and manage instance contacts. For instances, see Instances and billing.

​
Contacts

​
Contacts.List(ctx, instanceID, options)

contacts, err := client.Contacts.List(ctx, "VZ...", vzaps.InstanceOptions{
	InstanceToken: "instance-token",
})
Return: envelope { code, success, data } with contact array (jid, Name, IsInWhatsapp, etc.).

​
Contacts.Add(ctx, req)

_, err := client.Contacts.Add(ctx, vzaps.ContactAddRequest{
	InstanceScopedRequest: vzaps.InstanceScopedRequest{
		InstanceID:    "VZ...",
		InstanceToken: "instance-token",
	},
	Phone:     "5511888888888",
	FirstName: "Maria",
	FullName:  "Maria Silva",
})
Return: envelope { code, success, data } with confirmation text (e.g. "Contact added").

​
Users

​
Users.Info(ctx, req)

info, err := client.Users.Info(ctx, vzaps.UserPhonesRequest{
	InstanceScopedRequest: vzaps.InstanceScopedRequest{
		InstanceID:    "VZ...",
		InstanceToken: "instance-token",
	},
	Phone: "5511999999999",
})
Return: envelope { code, success, data } with user profile fields (VerifiedName, Status, PictureId, etc.).

​
Users.Check(ctx, req)

exists, err := client.Users.Check(ctx, vzaps.UserPhonesRequest{
	InstanceScopedRequest: vzaps.InstanceScopedRequest{
		InstanceID:    "VZ...",
		InstanceToken: "instance-token",
	},
	Phone: "5511999999999",
})
Return: envelope { code, success, data.users[] } with phone, exists, jid per checked number.

​
Users.Avatar(ctx, req)

avatar, err := client.Users.Avatar(ctx, vzaps.UserAvatarRequest{
	InstanceScopedRequest: vzaps.InstanceScopedRequest{
		InstanceID:    "VZ...",
		InstanceToken: "instance-token",
	},
	Phone: "5511999999999",
})
Return: envelope { code, success, data } with avatar base64 and mimetype.

​
Users.Contacts(ctx, instanceID, options)

contacts, err := client.Users.Contacts(ctx, "VZ...", vzaps.InstanceOptions{
	InstanceToken: "instance-token",
})
Return: envelope { code, success, data } — JID map to contact fields (FirstName, FullName, PushName, etc.).