Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
package openwa
import (
"context"
"net/url"
"strings"
)
// ContactsService looks up and manages contacts.
// Backed by src/modules/contact/contact.controller.ts.
type ContactsService struct{ client *Client }
func (s *ContactsService) base(sessionID string) string {
return "/api/sessions/" + pathEscape(sessionID) + "/contacts"
}
// List returns contacts for a session.
func (s *ContactsService) List(ctx context.Context, sessionID string, query *ListContactsQuery) ([]ContactRecord, error) {
var out []ContactRecord
err := s.client.do(ctx, "GET", s.base(sessionID), valuesOf(query), nil, &out)
return out, err
}
// Get returns a single contact.
func (s *ContactsService) Get(ctx context.Context, sessionID, contactID string) (*ContactRecord, error) {
var out ContactRecord
err := s.client.do(ctx, "GET", s.base(sessionID)+"/"+pathEscape(contactID), nil, nil, &out)
if err != nil {
return nil, err
}
return &out, nil
}
// Check reports whether a number is on WhatsApp. Requires an OPERATOR-level
// key.
func (s *ContactsService) Check(ctx context.Context, sessionID, number string) (*CheckNumberResponse, error) {
var out CheckNumberResponse
err := s.client.do(ctx, "GET", s.base(sessionID)+"/check/"+pathEscape(number), nil, nil, &out)
if err != nil {
return nil, err
}
return &out, nil
}
// ProfilePicture returns a contact's profile picture URL.
func (s *ContactsService) ProfilePicture(ctx context.Context, sessionID, contactID string) (*ProfilePictureResponse, error) {
var out ProfilePictureResponse
err := s.client.do(ctx, "GET", s.base(sessionID)+"/"+pathEscape(contactID)+"/profile-picture", nil, nil, &out)
if err != nil {
return nil, err
}
return &out, nil
}
// ProfilePictures batch-resolves profile picture URLs for up to 50 contacts
// in one request. The result maps each requested id to its URL (nil when the
// lookup failed). An id skipped after a lookup timed out is absent from the map; ask for it again.
func (s *ContactsService) ProfilePictures(ctx context.Context, sessionID string, ids []string) (*ProfilePicturesResponse, error) {
var out ProfilePicturesResponse
q := url.Values{"ids": []string{strings.Join(ids, ",")}}
err := s.client.do(ctx, "GET", s.base(sessionID)+"/profile-pictures", q, nil, &out)
if err != nil {
return nil, err
}
return &out, nil
}
// Phone resolves a contact's phone number.
func (s *ContactsService) Phone(ctx context.Context, sessionID, contactID string) (*ContactPhoneResponse, error) {
var out ContactPhoneResponse
err := s.client.do(ctx, "GET", s.base(sessionID)+"/"+pathEscape(contactID)+"/phone", nil, nil, &out)
if err != nil {
return nil, err
}
return &out, nil
}
// Upsert saves a contact to the addressbook, or edits an existing entry. Requires an OPERATOR-level
// key.
func (s *ContactsService) Upsert(ctx context.Context, sessionID, contactID string, body UpsertContactRequest) (*SuccessResult, error) {
var out SuccessResult
if err := s.client.do(ctx, "PUT", s.base(sessionID)+"/"+pathEscape(contactID), nil, body, &out); err != nil {
return nil, err
}
return &out, nil
}
// Delete removes a contact from the addressbook. Requires an OPERATOR-level key.
func (s *ContactsService) Delete(ctx context.Context, sessionID, contactID string) (*SuccessResult, error) {
var out SuccessResult
if err := s.client.do(ctx, "DELETE", s.base(sessionID)+"/"+pathEscape(contactID), nil, nil, &out); err != nil {
return nil, err
}
return &out, nil
}
// Block blocks a contact. Requires an OPERATOR-level key.
func (s *ContactsService) Block(ctx context.Context, sessionID, contactID string) (*SuccessResult, error) {
var out SuccessResult
err := s.client.do(ctx, "POST", s.base(sessionID)+"/"+pathEscape(contactID)+"/block", nil, nil, &out)
if err != nil {
return nil, err
}
return &out, nil
}
// Unblock unblocks a contact. Requires an OPERATOR-level key.
func (s *ContactsService) Unblock(ctx context.Context, sessionID, contactID string) (*SuccessResult, error) {
var out SuccessResult
err := s.client.do(ctx, "DELETE", s.base(sessionID)+"/"+pathEscape(contactID)+"/block", nil, nil, &out)
if err != nil {
return nil, err
}
return &out, nil
}
// ListBlocked returns the JIDs this account has blocked. Session-wide, so it takes no contact ID —
// unlike Block and Unblock, which act on one contact — and it returns bare IDs, not contact records.
func (s *ContactsService) ListBlocked(ctx context.Context, sessionID string) ([]string, error) {
var out []string
err := s.client.do(ctx, "GET", s.base(sessionID)+"/blocked", nil, nil, &out)
return out, err
}