Contacts Client API

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

This page documents 10 schema-registry client methods in the contacts namespace.

`blockContact`

Block a contact

Overview

Prop	Value
Namespace	`contacts`
Action	`update`
Functionality	`both`
Positional parameter order	`contactId`
Aliases	`contactBlock`, `contacts.block`, `contacts.contactBlock`
Deprecated aliases	`contactBlock`, `contacts.contactBlock`
License	`none`
WAPI override	`contactBlock`
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`PUT`	`/api/contacts/block`	`blockContact`	Active
Alias	`PUT`	`/api/blockContact`	`blockContact`	Active
Deprecated alias	`PUT`	`/api/contactBlock`	`contactBlock`	Deprecated
Deprecated alias	`PUT`	`/api/contacts/contactBlock`	`contacts.contactBlock`	Deprecated

Usage

const result = await client.blockContact({
  contactId: "447123456789@c.us",
});

const result = await client.contacts.block({
  contactId: "447123456789@c.us",
});

curl -X PUT "http://localhost:8080/api/contacts/block" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "contactId": "447123456789@c.us"
  }'

Parameters

Prop

Type

Output

Prop	Value
Return type	`boolean`

checkNumberStatusInsiders

Check if number is on WhatsApp

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	`contactId`
Aliases	`contacts.checkNumberStatus`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/checkNumberStatus`	`checkNumberStatus`	Active
Alias	`GET`	`/api/checkNumberStatus`	`checkNumberStatus`	Active

Usage

const result = await client.checkNumberStatus({
  contactId: "447123456789@c.us",
});

const result = await client.contacts.checkNumberStatus({
  contactId: "447123456789@c.us",
});

curl -G "http://localhost:8080/api/contacts/checkNumberStatus" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "contactId=447123456789@c.us"

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

`checkReadReceipts`

Check read receipts setting

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	`contactId`
Aliases	`contacts.checkReadReceipts`, `contacts.getReadReceipts`, `getReadReceipts`
Deprecated aliases	-
License	`none`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/checkReadReceipts`	`checkReadReceipts`	Active
Alias	`GET`	`/api/checkReadReceipts`	`checkReadReceipts`	Active
Alias	`GET`	`/api/contacts/getReadReceipts`	`contacts.getReadReceipts`	Active
Alias	`GET`	`/api/getReadReceipts`	`getReadReceipts`	Active

Usage

const result = await client.checkReadReceipts({
  contactId: "447123456789@c.us",
});

const result = await client.contacts.checkReadReceipts({
  contactId: "447123456789@c.us",
});

curl -G "http://localhost:8080/api/contacts/checkReadReceipts" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "contactId=447123456789@c.us"

Parameters

Prop

Type

Output

Prop	Value
Return type	`boolean \| string`

`getAllContacts`

Retrieves all contacts

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	-
Aliases	`contacts.all`, `contacts.getAll`, `contacts.list`, `listContacts`
Deprecated aliases	-
License	`none`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/getAll`	`getAllContacts`	Active
Alias	`GET`	`/api/contacts/all`	`contacts.all`	Active
Alias	`GET`	`/api/contacts/list`	`contacts.list`	Active
Alias	`GET`	`/api/getAllContacts`	`getAllContacts`	Active
Alias	`GET`	`/api/listContacts`	`listContacts`	Active

Usage

const result = await client.getAllContacts({});

const result = await client.contacts.getAll({});

curl -X GET "http://localhost:8080/api/contacts/getAll" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

Prop	Value
Return type	`unknown[]`

`getBlockedIds`

Get blocked contact IDs

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	-
Aliases	`contacts.getBlockedIds`
Deprecated aliases	-
License	`none`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/getBlockedIds`	`getBlockedIds`	Active
Alias	`GET`	`/api/getBlockedIds`	`getBlockedIds`	Active

Usage

const result = await client.getBlockedIds({});

const result = await client.contacts.getBlockedIds({});

curl -X GET "http://localhost:8080/api/contacts/getBlockedIds" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

Prop	Value
Return type	`string[]`

`getCommonGroups`

Get common groups with contact

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	`contactId`
Aliases	`contacts.getCommonGroups`
Deprecated aliases	-
License	`none`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/getCommonGroups`	`getCommonGroups`	Active
Alias	`GET`	`/api/getCommonGroups`	`getCommonGroups`	Active

Usage

const result = await client.getCommonGroups({
  contactId: "447123456789@c.us",
});

const result = await client.contacts.getCommonGroups({
  contactId: "447123456789@c.us",
});

curl -G "http://localhost:8080/api/contacts/getCommonGroups" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "contactId=447123456789@c.us"

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

`getContact`

Get specific contact

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	`contactId`
Aliases	`contacts.get`
Deprecated aliases	-
License	`none`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/get`	`getContact`	Active
Alias	`GET`	`/api/getContact`	`getContact`	Active

Usage

const result = await client.getContact({
  contactId: "447123456789@c.us",
});

const result = await client.contacts.get({
  contactId: "447123456789@c.us",
});

curl -G "http://localhost:8080/api/contacts/get" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "contactId=447123456789@c.us"

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

getNumberProfileInsiders

Get profile of number

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	`contactId`
Aliases	`contacts.getNumberProfile`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/getNumberProfile`	`getNumberProfile`	Active
Alias	`GET`	`/api/getNumberProfile`	`getNumberProfile`	Active

Usage

const result = await client.getNumberProfile({
  contactId: "447123456789@c.us",
});

const result = await client.contacts.getNumberProfile({
  contactId: "447123456789@c.us",
});

curl -G "http://localhost:8080/api/contacts/getNumberProfile" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "contactId=447123456789@c.us"

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

`getProfilePicture`

Get profile picture from server

Overview

Prop	Value
Namespace	`contacts`
Action	`read`
Functionality	`both`
Positional parameter order	`chatId`
Aliases	`contacts.getProfilePicFromServer`, `contacts.getProfilePicture`, `getProfilePicFromServer`
Deprecated aliases	`contacts.getProfilePicFromServer`, `getProfilePicFromServer`
License	`none`
WAPI override	`getProfilePicFromServer`
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/contacts/getProfilePicture`	`getProfilePicture`	Active
Deprecated alias	`GET`	`/api/contacts/getProfilePicFromServer`	`contacts.getProfilePicFromServer`	Deprecated
Deprecated alias	`GET`	`/api/getProfilePicFromServer`	`getProfilePicFromServer`	Deprecated
Alias	`GET`	`/api/getProfilePicture`	`getProfilePicture`	Active

Usage

const result = await client.getProfilePicture({
  chatId: "447123456789@c.us",
});

const result = await client.contacts.getProfilePicture({
  chatId: "447123456789@c.us",
});

curl -G "http://localhost:8080/api/contacts/getProfilePicture" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "chatId=447123456789@c.us"

Parameters

Prop

Type

Output

Prop	Value
Return type	`string`

`unblockContact`

Unblock a contact

Overview

Prop	Value
Namespace	`contacts`
Action	`update`
Functionality	`both`
Positional parameter order	`contactId`
Aliases	`contacts.contactUnblock`, `contacts.unblock`, `contactUnblock`
Deprecated aliases	`contacts.contactUnblock`, `contactUnblock`
License	`none`
WAPI override	`contactUnblock`
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`PUT`	`/api/contacts/unblock`	`unblockContact`	Active
Deprecated alias	`PUT`	`/api/contacts/contactUnblock`	`contacts.contactUnblock`	Deprecated
Deprecated alias	`PUT`	`/api/contactUnblock`	`contactUnblock`	Deprecated
Alias	`PUT`	`/api/unblockContact`	`unblockContact`	Active

Usage

const result = await client.unblockContact({
  contactId: "447123456789@c.us",
});

const result = await client.contacts.unblock({
  contactId: "447123456789@c.us",
});

curl -X PUT "http://localhost:8080/api/contacts/unblock" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "contactId": "447123456789@c.us"
  }'

Parameters

Prop

Type

Output

Prop	Value
Return type	`boolean`

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

Was this helpful?

On this page