Methods and scopes
All API methods and key scopes. Each method’s parameters, daily limits and example responses are on the Documentation tab of the API section.
Methods
All methods require the “Accounts: actions” scope and run on behalf of the account you specify.
| Method | What it does |
|---|
| Find and check |
search_entities | Global search for people, chats and channels by query |
resolve_username | Full profile by a public @username |
get_entity_data | A fresh full profile of a known person or chat |
get_personal_channel_data | Full channel check: profile, pinned post and latest posts |
resolve_post_author | The profile of a channel post’s author |
| Collect |
fetch_members_page | A page of members of a public chat or channel |
fetch_messages_page | A page of messages from a public chat or channel |
| Conversations |
list_dialogs | The account’s list of dialogs |
start_dialog | A first message to a person — opens a dialog |
send_reply | A message in an already open dialog |
| Account profile |
set_name | Change the account’s first and last name |
set_bio | Change the bio (“About”) |
Key scopes
| Code | Scope | What it allows |
|---|
campaigns:read | Campaigns: read | View campaigns, their dialogs and audience reports |
campaigns:write | Campaigns: write | Create and change campaigns, start and stop them |
flows:read | Flows: read | View scripts and their steps |
flows:write | Flows: write | Create and change scripts |
audience:read | Audiences: read | View lists, contacts and variables |
audience:write | Audiences: write | Create and change lists, import contacts, run tasks |
accounts:read | Accounts: read | View accounts and their state |
accounts:actions | Accounts: actions | Call API methods on behalf of an account |
wallet:read | Wallet: read | Balance, tokens and transaction history |
Limits
| What | How much |
|---|
| Requests | 60 per minute |
| Active keys | 15 |
Waiting for a result in one request (wait) | Up to 30 seconds |
| Job result retention | 7 days |
| Daily method limits | Per account, different for each method — see the Documentation tab |