Auths

An auth is a connected messaging account — WhatsApp, Telegram, VK, and more — for your company

An auth is a connected messaging account for your company: WhatsApp, Telegram, MAX, VK, Instagram, Facebook, Avito, and other providers.

Think of it as the bridge between Pact.im and the messenger. Until an auth is created and confirmed, you cannot send or receive messages on that channel. Auths go through create → confirm (QR, code, or OAuth) → enabled, and can later be disabled or deleted.

Some providers also expose pages (for example VK groups) that you choose during confirmation. Auth changes are pushed as webhooks — see Auth events.

If you still use API v1 Channels, see Migration from Channels v1 to Auths v2.

With the Auths API you can:

Auth object

Example

json
{
  "auth": {
    "id": 69174,
    "company_id": 52368,
    "provider": "whatsapp",
    "state": "enabled",
    "phone_number": "79000000000",
    "username": null,
    "created_at": "2025-06-23T14:33:47.886Z",
    "updated_at": "2025-06-23T14:33:47.886Z",
    "sync_messages_at": "2025-06-22T14:33:47.877Z",
    "pages": null
  }
}

Description

ParameterTypeDescription
idIntegerAuth ID
company_idIntegerID of the company
providerStringName of the connected messenger
stateStringConnection status (disabled or enabled)
phone_numberIntegerPhone number of the connected messenger (when the provider exposes it)
usernameStringUsername of the connected messenger (when the provider exposes it)
created_atTimeAuth connection time
updated_atTimeLast update time
sync_messages_atTimeThe time from which message synchronization began
pagesObjectSome providers may provide a list of pages that can be connected

Pages object

Example

json
{
  "page": {
    "id": 30190,
    "auth_id": 69167,
    "company_id": 52368,
    "external_id": "229559196",
    "name": "Test1",
    "enabled": true
  }
}

Description

ParameterTypeDescription
idIntegerPage ID
auth_idIntegerAuth ID to which the page belongs
company_idIntegerCompany ID to which the page belongs
external_idIntegerExternal page ID
nameStringPage title
enabledBooleanPage connection status (true or false)

Search…

Start typing to search