Authentication session
| Field | Type | Label | Description |
| id | int32 | Unuque ID of session |
|
| auth_holder | AuthHolder | holder of session. 1 - this device, 2 - other. |
|
| app_id | int32 | Application Id that you set during authorization |
|
| app_title | string | Deprecated |
|
| device_title | string | Deprecated |
|
| auth_time | int32 | Time of session creating |
|
| auth_location | string | Two-letter country code of session create |
|
| latitude | google.protobuf.DoubleValue |
|
|
| longitude | google.protobuf.DoubleValue |
|
Tells the client to clear contacts and load them again
Tells the client to clear dialogs and load them again
Notification to force client to reload some entities from server
Just for old clients. Should be ignore.
| Field | Type | Label | Description |
| forceReloadDialogs | ForceReloadDialogs |
|
|
| forceReloadContacts | ForceReloadContacts |
|
|
| forceReloadHistory | ForceReloadHistory |
|
Tells the client to clear the specified conversation and load it again
peer the peer whose history should be reloaded
| Field | Type | Label | Description |
| peer | Peer |
|
Complete OAuth2 Authentication - deprecated
| Field | Type | Label | Description |
| transaction_hash | string |
|
|
| code | string |
|
Getting of all active user's authentication sessions
Loading OAuth2 Parameters - deprecated
| Field | Type | Label | Description |
| transaction_hash | string |
|
|
| redirect_url | string |
|
Performs code resend
| Field | Type | Label | Description |
| transaction_hash | string | Hash of the authorization transaction * |
Requesting Phone activation
| Field | Type | Label | Description |
| phone_number | int64 |
|
|
| sms_hash | string |
|
|
| app_id | int32 |
|
|
| api_key | string |
|
Sending SMS with activation code
| Field | Type | Label | Description |
| phone_number | int64 |
|
|
| app_id | int32 |
|
|
| api_key | string |
|
Dial phone and dictate auth code
| Field | Type | Label | Description |
| transaction_hash | string | Hash from ResponseStartPhoneAuth |
Performing user signin - deprecated
| Field | Type | Label | Description |
| phone_number | int64 |
|
|
| sms_hash | string |
|
|
| sms_code | string |
|
|
| device_hash | bytes |
|
|
| device_title | string |
|
|
| app_id | int32 |
|
|
| app_key | string |
|
SignOut current session
Perform user SignUp
| Field | Type | Label | Description |
| transaction_hash | string | Hash of the authorization transaction * |
|
| name | string | Your name |
|
| sex | Sex | Use it in case of anonymous authorization (deprecated) |
|
| password | google.protobuf.StringValue |
|
Performing user signup. If user perform signup on already registered user it just override previous
profile information
| Field | Type | Label | Description |
| phone_number | int64 |
|
|
| sms_hash | string |
|
|
| sms_code | string |
|
|
| name | string |
|
|
| device_hash | bytes |
|
|
| device_title | string |
|
|
| app_id | int32 |
|
|
| app_key | string |
|
|
| is_silent | bool |
|
Starting Anonymous login - deprecated
| Field | Type | Label | Description |
| name | string |
|
|
| app_id | int32 |
|
|
| api_key | string |
|
|
| device_hash | bytes |
|
|
| device_title | string |
|
|
| time_zone | google.protobuf.StringValue |
|
|
| preferred_languages | string | repeated |
|
Start EMail Activation
| Field | Type | Label | Description |
| string |
|
||
| app_id | int32 | Application id, choose it by yourself and hold during authorization process * |
|
| api_key | string | Deprecated field - keep it empty * |
|
| device_hash | bytes | Deprecated field - keep it empty * |
|
| device_title | string | Some title, choose it by yourself and hold during authorization process * |
|
| time_zone | google.protobuf.StringValue | Your timezone * |
|
| preferred_languages | string | repeated | First language from this array will be used for some notifications from server * |
Start Phone Activation
| Field | Type | Label | Description |
| phone_number | int64 |
|
|
| app_id | int32 | Application id, choose it by yourself and hold during authorization process * |
|
| api_key | string | Deprecated field - keep it empty * |
|
| device_hash | bytes | Deprecated field - keep it empty * |
|
| device_title | string | Some title, choose it by yourself and hold during authorization process * |
|
| time_zone | google.protobuf.StringValue | Your timezone * |
|
| preferred_languages | string | repeated | First language from this array will be used for some notifications from server * |
Starting token-based login - to authorize bot
| Field | Type | Label | Description |
| token | string | Token received from BotFather * |
|
| app_id | int32 | Application id, choose it by yourself and hold during authorization process * |
|
| api_key | string | Deprecated field - keep it empty * |
|
| device_hash | bytes | Deprecated field - keep it empty * |
|
| device_title | string | Some title, choose it by yourself and hold during authorization process * |
|
| time_zone | google.protobuf.StringValue | Your timezone * |
|
| preferred_languages | string | repeated | First language from this array will be used for some notifications from server * |
Starting Login Authentication
| Field | Type | Label | Description |
| username | string |
|
|
| app_id | int32 | Application id, choose it by yourself and hold during authorization process * |
|
| api_key | string | Deprecated field - keep it empty * |
|
| device_hash | bytes | Deprecated field - keep it empty * |
|
| device_title | string | Some title, choose it by yourself and hold during authorization process * |
|
| time_zone | google.protobuf.StringValue |
|
|
| preferred_languages | string | repeated | First language from this array will be used for some notifications from server * |
SignOut on all exept current sessions
SignOut on specified user's session
| Field | Type | Label | Description |
| id | int32 | Session id |
Performing user sign in.
| Field | Type | Label | Description |
| transaction_hash | string | Hash of the authorization transaction * |
|
| code | string | Authorization code |
Validation of account password
| Field | Type | Label | Description |
| transaction_hash | string | Hash of the authorization transaction * |
|
| password | string |
|
Authentication result
| Field | Type | Label | Description |
| user | User | Registered/authorized user |
|
| config | Config | Config for that user |
|
| config_hash | google.protobuf.Int64Value | Hash of config to later usage |
| Field | Type | Label | Description |
| user_auths | AuthSession | repeated | Active user's sessions |
Deprecated
| Field | Type | Label | Description |
| auth_url | string |
|
| Field | Type | Label | Description |
| sms_hash | string |
|
|
| is_registered | bool |
|
| Field | Type | Label | Description |
| transaction_hash | string | Hash of authorization transaction * |
|
| is_registered | bool | Deprecated |
|
| activation_type | EmailActivationType | Code or password - call ValidateCode if code * |
| Field | Type | Label | Description |
| transaction_hash | string | Hash of authorization transaction * |
|
| is_registered | bool | Deprecated |
|
| activation_type | PhoneActivationType | Code or password - call ValidateCode if code * |
| Field | Type | Label | Description |
| transaction_hash | string | Hash of authorization transaction * |
|
| is_registered | bool | Deprecated |
This update is sent by the server to force a client to reload its data
| Field | Type | Label | Description |
| fields | ForceReloadField | repeated |
|
Holder of session
| Name | Number | Description |
| AUTHHOLDER_UNKNOWN | 0 | |
| AUTHHOLDER_THISDEVICE | 1 | |
| AUTHHOLDER_OTHERDEVICE | 2 |
| Name | Number | Description |
| EMAILACTIVATIONTYPE_UNKNOWN | 0 | |
| EMAILACTIVATIONTYPE_CODE | 1 | |
| EMAILACTIVATIONTYPE_OAUTH2 | 2 | |
| EMAILACTIVATIONTYPE_PASSWORD | 3 |
| Name | Number | Description |
| PHONEACTIVATIONTYPE_UNKNOWN | 0 | |
| PHONEACTIVATIONTYPE_CODE | 1 | |
| PHONEACTIVATIONTYPE_PASSWORD | 2 |
| Method Name | Request Type | Response Type | Description |
| StartPhoneAuth | RequestStartPhoneAuth | ResponseStartPhoneAuth | Start authorization by phone |
| SendCodeByPhoneCall | RequestSendCodeByPhoneCall | ResponseVoid | Resend code by transaction hash |
| StartEmailAuth | RequestStartEmailAuth | ResponseStartEmailAuth | Start email authorization process |
| StartAnonymousAuth | RequestStartAnonymousAuth | ResponseAuth | Deprecated |
| StartTokenAuth | RequestStartTokenAuth | ResponseAuth | Start token auth authorization (actual for bots) |
| StartUsernameAuth | RequestStartUsernameAuth | ResponseStartUsernameAuth | Start login/password authorization process |
| ValidateCode | RequestValidateCode | ResponseAuth | Validate code received by phone or email Returns error if user does not exist |
| ResendCode | RequestResendCode | ResponseVoid | Resend code if you don't receive it with first attempt |
| ValidatePassword | RequestValidatePassword | ResponseAuth | Validate your passwword |
| GetOAuth2Params | RequestGetOAuth2Params | ResponseGetOAuth2Params | Deprecated |
| CompleteOAuth2 | RequestCompleteOAuth2 | ResponseAuth | Deprecated |
| SignUp | RequestSignUp | ResponseAuth | Sign up existed user |
| GetAuthSessions | RequestGetAuthSessions | ResponseGetAuthSessions | Returns all authorized user's sessions |
| TerminateSession | RequestTerminateSession | ResponseVoid | Deprecated. Does not produce any effect. |
| TerminateAllSessions | RequestTerminateAllSessions | ResponseVoid | Log out user |
| SignOut | RequestSignOut | ResponseVoid | Log out current session |
| SignInObsolete | RequestSignInObsolete | ResponseAuth | Deprecated |
| SignUpObsolete | RequestSignUpObsolete | ResponseAuth | Deprecated |
| SendAuthCodeObsolete | RequestSendAuthCodeObsolete | ResponseSendAuthCodeObsolete | Deprecated |
| SendAuthCallObsolete | RequestSendAuthCallObsolete | ResponseVoid | Deprecated |
Syncing Parameter
| Field | Type | Label | Description |
| key | string | Key of parameter |
|
| value | string | Value of parameter |
Change parameter value
| Field | Type | Label | Description |
| key | string |
|
|
| value | google.protobuf.StringValue |
|
Getting Parameters
| Field | Type | Label | Description |
| parameters | Parameter | repeated |
|
Update about parameter change
| Field | Type | Label | Description |
| key | string |
|
|
| value | google.protobuf.StringValue |
|
| Method Name | Request Type | Response Type | Description |
| GetParameters | RequestGetParameters | ResponseGetParameters | |
| EditParameter | RequestEditParameter | ResponseSeq |
Email for import
| Field | Type | Label | Description |
| string | email for importing |
||
| name | google.protobuf.StringValue | optional name for contact |
Phone for import
| Field | Type | Label | Description |
| phone_number | int64 | phone number for import in international format |
|
| name | google.protobuf.StringValue | optional name for contact |
Adding contact to contact list
| Field | Type | Label | Description |
| uid | int32 |
|
|
| access_hash | int64 |
|
Importing phones and emails for building contact list
Import evaluated lazily, response does not contain any info
Maximum amount of items for import per method call equals to 100.
| Field | Type | Label | Description |
| phones | PhoneToImport | repeated |
|
| emails | EmailToImport | repeated |
|
Getting current contact list
SHA256 hash of list of a comma-separated list of contact UIDs in ascending
order may be passed in contactsHash parameter.
If the contact list was not changed, isNotChanged will be true.
| Field | Type | Label | Description |
| contacts_hash | string |
|
|
| optimizations | UpdateOptimization | repeated |
|
Importing phones and emails for building contact list
Maximum amount of items for import per method call equals to 100.
| Field | Type | Label | Description |
| phones | PhoneToImport | repeated |
|
| emails | EmailToImport | repeated |
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Removing contact from contact list
| Field | Type | Label | Description |
| uid | int32 |
|
|
| access_hash | int64 |
|
Searching contacts by user's query
| Field | Type | Label | Description |
| request | string |
|
|
| optimizations | UpdateOptimization | repeated |
|
| Field | Type | Label | Description |
| task_id | string |
|
| Field | Type | Label | Description |
| users | User | repeated |
|
| is_not_changed | bool |
|
|
| user_peers | UserOutPeer | repeated |
|
| Field | Type | Label | Description |
| users | User | repeated | Registered contacts |
| seq | int32 | Deprecated |
|
| state | bytes | Server state related to current client, used by server only |
|
| user_peers | UserOutPeer | repeated | Optimizations drops some info from response to decrease traffic and latency |
| Field | Type | Label | Description |
| users | User | repeated |
|
| user_peers | UserOutPeer | repeated |
|
Update about contact registration
| Field | Type | Label | Description |
| uid | int32 | User id of a registered contact |
|
| is_silent | bool | deprecated |
|
| date | int64 | deprecated |
|
| mid | UUIDValue | deprecated |
Update about suspending task - normally it should be ignored
| Field | Type | Label | Description |
| task_id | string |
|
Update about contacts added
| Field | Type | Label | Description |
| uids | int32 | repeated | User ids of the registered contacts |
| task_id | google.protobuf.StringValue | Id of the task that finished |
Update about contacts removed
| Field | Type | Label | Description |
| uids | int32 | repeated |
|
| Method Name | Request Type | Response Type | Description |
| ImportContacts | RequestImportContacts | ResponseImportContacts | Import contacts and wait while query is not finished |
| DeferredImportContacts | RequestDeferredImportContacts | ResponseDeferredImportContacts | Same as above, but without waiting response |
| GetContacts | RequestGetContacts | ResponseGetContacts | |
| RemoveContact | RequestRemoveContact | ResponseSeq | |
| AddContact | RequestAddContact | ResponseSeq | |
| SearchContacts | RequestSearchContacts | ResponseSearchContacts | Search contacts by query string |
| Field | Type | Label | Description |
| global_counter | google.protobuf.Int32Value | Global unread counter |
|
| global_dialogs_counter | google.protobuf.Int32Value | Global count of dialogs with positive counter values |
|
| unread_dialogs | UnreadDialog | repeated | map of chat peer id to unread to counters |
Unread dialogs
| Field | Type | Label | Description |
| peer | Peer | dialog peer |
|
| counter | int32 | unread messages count |
deprecated
| Field | Type | Label | Description |
| counters | AppCounters |
|
|
| ts | google.protobuf.Int64Value |
|
Exchange public keys
| Field | Type | Label | Description |
| client_key | google.protobuf.BytesValue |
|
| Field | Type | Label | Description |
| server_key | google.protobuf.BytesValue |
|
| Method Name | Request Type | Response Type | Description |
| KeyExchange | RequestKeyExchange | ResponseKeyExchange |
server timestamp when state was created or modified
| Field | Type | Label | Description |
| clock | int64 |
|
| Field | Type | Label | Description |
| log | string |
|
| Field | Type | Label | Description |
| msb | int64 |
|
|
| lsb | int64 |
|
| Extension | Type | Base | Number | Description |
| dlg | DialogOptions | .google.protobuf.FieldOptions | 100001 |
Generic client info, containing information about platform type, version, sdk etc
| Field | Type | Label | Description |
| platform | PlatformType | The platform enum. Can be either Android, Web or iOS |
|
| device_name | string | For android: vendor and model; For iOS: model; For Web: platform and user agent |
|
| app_name | string | Optional application name |
|
| app_version | google.protobuf.StringValue | Application version |
|
| sdk_version | google.protobuf.StringValue | Optional SDK version |
|
| preferred_languages | string | repeated | Optional ISO-639 language code and ISO-3166 country code: ru-RU |
| time_zone | google.protobuf.StringValue | Optional TimeZone id |
Notifying about device information
| Field | Type | Label | Description |
| preferred_languages | string | repeated | First language from this array will be used for some notifications from server * |
| time_zone | google.protobuf.StringValue | Your timezone * |
| Name | Number | Description |
| PLATFORMTYPE_UNKNOWN | 0 | |
| PLATFORMTYPE_ANDROID | 1 | |
| PLATFORMTYPE_IOS | 2 | |
| PLATFORMTYPE_WEB | 3 | |
| PLATFORMTYPE_CLC | 4 | |
| PLATFORMTYPE_TESTS | 42 |
| Method Name | Request Type | Response Type | Description |
| NotifyAboutDeviceInfo | RequestNotifyAboutDeviceInfo | ResponseVoid | Set info about current device |
Joining Event Bus
| Field | Type | Label | Description |
| id | string | Bus id |
|
| timeout | int64 | Join TTL |
Keep Alive Event Bus
| Field | Type | Label | Description |
| id | string | Bus id |
|
| timeout | int64 | Keep TTL |
Event Bus Destination
| Field | Type | Label | Description |
| id | string | Bus id |
|
| destinations | int64 | repeated | Destination device ids |
| message | bytes | Message to send |
| Field | Type | Label | Description |
| device_id | int64 | Generated device id for this event bus |
Update about pubsub device connected
| Field | Type | Label | Description |
| id | string | Bus id |
|
| user_id | int32 | Connected user id |
|
| device_id | int64 | Connected device id |
|
| peer | Peer | Connected peer |
Update about device disconnected
| Field | Type | Label | Description |
| id | string | Bus id |
|
| user_id | int32 |
|
|
| device_id | int64 |
|
|
| peer | Peer |
|
Event Bus dispose
| Field | Type | Label | Description |
| id | string |
|
Event Bus Message
| Field | Type | Label | Description |
| id | string | Bus id |
|
| sender_id | int32 |
|
|
| sender_device_id | int64 |
|
|
| message | bytes |
|
| Method Name | Request Type | Response Type | Description |
| JoinEventBus | RequestJoinEventBus | ResponseJoinEventBus | |
| KeepAliveEventBus | RequestKeepAliveEventBus | ResponseVoid | |
| PostToEventBus | RequestPostToEventBus | ResponseVoid |
Group information
| Field | Type | Label | Description |
| id | int32 | group id |
|
| space_id | UUIDValue |
|
|
| access_hash | int64 | Access hash of group |
|
| title | string | Title of group |
|
| avatar | Avatar | Avatar of group |
|
| members_amount | google.protobuf.Int32Value | Number of members |
|
| is_member | google.protobuf.BoolValue | Is current user a member of a group. Default is true. |
|
| is_hidden | google.protobuf.BoolValue | Is group hidden (not showing it in recent list). Default is false. |
|
| group_type | GroupType | Group Type. Used only for displaying information. Default is GROUP. |
|
| can_send_message | google.protobuf.BoolValue | Can user send messages. Default is equals isMember for Group and false for channels. |
|
| is_admin | google.protobuf.BoolValue | Deprecated |
|
| creator_uid | int32 | Group creator |
|
| members | Member | repeated | Members of group |
| create_date | int64 | Date of creation |
|
| theme | google.protobuf.StringValue | Theme of group |
|
| about | google.protobuf.StringValue | About of group |
|
| shortname | google.protobuf.StringValue | Group short name |
Goup Full information - Deprecated
| Field | Type | Label | Description |
| id | int32 | Group Id |
|
| create_date | int64 | Date created |
|
| owner_uid | int32 | Group owner |
|
| members | Member | repeated | Group members. Can be empty when isAsyncMembers enabled. |
| theme | google.protobuf.StringValue | Group Theme |
|
| about | google.protobuf.StringValue | Group about |
|
| is_async_members | google.protobuf.BoolValue | Is Members need to be loaded asynchronous. |
|
| can_view_members | google.protobuf.BoolValue | Can current user view members of the group. Default is true. |
|
| can_invite_people | google.protobuf.BoolValue | Can current user invite new people. Default is true. |
|
| is_shared_history | google.protobuf.BoolValue | Is history shared among all users. |
A struct mapping a group member to their permissions
userId the id of the group member
permissions a list of permissions that user has
| Field | Type | Label | Description |
| user_id | int32 |
|
|
| permissions | GroupAdminPermission | repeated |
|
Member information
| Field | Type | Label | Description |
| uid | int32 | User id |
|
| inviter_uid | int32 | User inviter id |
|
| date | int64 | Adding date |
|
| is_admin | google.protobuf.BoolValue | Deprecated |
|
| permissions | GroupAdminPermission | repeated | List of member permissions |
Creating group chat
| Field | Type | Label | Description |
| rid | int64 | Id for query deduplication |
|
| space_id | UUIDValue |
|
|
| title | string |
|
|
| users | UserOutPeer | repeated | members |
| group_type | GroupType | group or channel |
|
| username | google.protobuf.StringValue | optional shortname of a group, group will be public if set |
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Edit Group About
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| about | google.protobuf.StringValue |
|
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Changing group avatar
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| file_location | FileLocation |
|
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Changing group title
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| title | string |
|
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Edit group topic
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| topic | google.protobuf.StringValue |
|
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Building invite url
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
Get group invite url base
Fetches the group administration permissions for each of the users from the list
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| user_ids | int32 | repeated |
|
Inviting user to group
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| user | UserOutPeer |
|
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Join group method
| Field | Type | Label | Description |
| token | string |
|
|
| optimizations | UpdateOptimization | repeated |
|
Join group by peer
| Field | Type | Label | Description |
| peer | GroupOutPeer |
|
Kicking user from group
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| user | UserOutPeer |
|
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Leaving group
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Loading Full Groups - Deprecated
| Field | Type | Label | Description |
| groups | GroupOutPeer | repeated |
|
Loading group members
| Field | Type | Label | Description |
| group | GroupOutPeer |
|
|
| limit | int32 |
|
|
| next | google.protobuf.BytesValue | cursor |
Make user admin
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| user_peer | UserOutPeer |
|
|
| permissions | GroupAdminPermission | repeated |
|
[OBSOLETE] Make user admin
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| user_peer | UserOutPeer |
|
Removing group avatar
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| rid | int64 | Id for query deduplication |
|
| optimizations | UpdateOptimization | repeated | Optimizations drops some info from response to decrease traffic and latency |
Revoking invite urls
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
Sets group short name
| Field | Type | Label | Description |
| peer | GroupOutPeer |
|
|
| shortname | string | if shortname was empty, then group will become public |
Transfer ownership of group
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| new_owner | int32 |
|
| Field | Type | Label | Description |
| seq | int32 | deprecated |
|
| state | bytes |
|
|
| group | Group | created group |
|
| users | User | repeated | empty if dropped by optimizations |
| user_peers | UserOutPeer | repeated | empty if dropped by optimizations |
| Field | Type | Label | Description |
| avatar | Avatar |
|
|
| seq | int32 | deprecated |
|
| state | bytes |
|
|
| date | int64 |
|
|
| mid | UUIDValue |
|
| Field | Type | Label | Description |
| url | string |
|
| Field | Type | Label | Description |
| permissions | GroupMemberPermission | repeated |
|
Response for invite url methods
| Field | Type | Label | Description |
| url | string |
|
| Field | Type | Label | Description |
| group | Group |
|
|
| users | User | repeated | empty if dropped by optimizations |
| user_peers | UserOutPeer | repeated | empty if dropped by optimizations |
| mid | UUIDValue | deprecated |
|
| seq | int32 | deprecated |
|
| state | bytes |
|
|
| date | int64 |
|
Deprecated
| Field | Type | Label | Description |
| groups | GroupFull | repeated |
|
| Field | Type | Label | Description |
| members | UserOutPeer | repeated |
|
| next | google.protobuf.BytesValue |
|
| Field | Type | Label | Description |
| members | Member | repeated |
|
| seq | int32 | deprecated |
|
| state | bytes |
|
Update about about changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| about | google.protobuf.StringValue |
|
Update about group about change
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| about | google.protobuf.StringValue |
|
Update about avatar changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| avatar | Avatar |
|
Update about group avatar change
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| mid | UUIDValue | deprecated |
|
| uid | int32 |
|
|
| avatar | Avatar |
|
|
| date | int64 |
|
Update about can invite members changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| can_invite_members | bool |
|
Update about can send messages changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| can_send_messages | bool |
|
Update about can view members changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| can_view_members | bool |
|
Update about history shared
| Field | Type | Label | Description |
| group_id | int32 |
|
Update about inviting current user to group
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| rid | int64 | deprecated |
|
| mid | UUIDValue | deprecated |
|
| invite_uid | int32 |
|
|
| date | int64 |
|
Update about member admin changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| user_id | int32 |
|
|
| is_admin | bool |
|
Update about membership changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| is_member | bool |
|
Update about members changed
| Field | Type | Label | Description |
| removed_users | int32 | repeated |
|
| added_members | Member | repeated |
|
| members_count | int32 |
|
Update about the user's permissions
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| user_id | int32 |
|
|
| permissions | GroupAdminPermission | repeated |
|
Update about members became async
| Field | Type | Label | Description |
| group_id | int32 |
|
Update about members count changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| members_count | int32 |
|
Silent group members update
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| members | Member | repeated |
|
Update about members updated
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| members | Member | repeated |
|
Update about owner changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| user_id | int32 | new owner |
Update group short name
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| shortname | string |
|
|
| uid | int32 |
|
Update about title changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| title | string |
|
Update about group title change
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| mid | UUIDValue | deprecated |
|
| uid | int32 |
|
|
| title | string |
|
|
| date | int64 |
|
Update about topic changed
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| topic | google.protobuf.StringValue |
|
Update about group topic change
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| rid | int64 | deprecated |
|
| uid | int32 |
|
|
| topic | google.protobuf.StringValue |
|
|
| date | int64 |
|
Update about inviting user to group
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| rid | int64 | Id for deduplication |
|
| mid | UUIDValue | deprecated |
|
| uid | int32 |
|
|
| inviter_uid | int32 |
|
|
| date | int64 |
|
Update about kicking user
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| mid | UUIDValue | deprecated |
|
| uid | int32 |
|
|
| kicker_uid | int32 |
|
|
| date | int64 |
|
Update about leaving user
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| mid | UUIDValue | deprecated |
|
| uid | int32 |
|
|
| date | int64 |
|
Possible permissions on a group
| Name | Number | Description |
| GROUPADMINPERMISSION_UNKNOWN | 0 | |
| GROUPADMINPERMISSION_EDITSHORTNAME | 1 | |
| GROUPADMINPERMISSION_INVITE | 2 | |
| GROUPADMINPERMISSION_KICK | 3 | |
| GROUPADMINPERMISSION_UPDATEINFO | 4 | |
| GROUPADMINPERMISSION_SETPERMISSIONS | 5 | |
| GROUPADMINPERMISSION_EDITMESSAGE | 6 | |
| GROUPADMINPERMISSION_DELETEMESSAGE | 7 | |
| GROUPADMINPERMISSION_GETINTEGRATIONTOKEN | 8 | |
| GROUPADMINPERMISSION_SENDMESSAGE | 9 | |
| GROUPADMINPERMISSION_PINMESSAGE | 10 |
| Name | Number | Description |
| GROUPTYPE_UNKNOWN | 0 | |
| GROUPTYPE_GROUP | 1 | |
| GROUPTYPE_CHANNEL | 2 |
Getting current group token
| Field | Type | Label | Description |
| group_peer | OutPeer |
|
Revoke group token
| Field | Type | Label | Description |
| group_peer | OutPeer |
|
Group token response
| Field | Type | Label | Description |
| token | string |
|
|
| url | string |
|
| Method Name | Request Type | Response Type | Description |
| GetIntegrationToken | RequestGetIntegrationToken | ResponseIntegrationToken | Get token for posting to group |
| RevokeIntegrationToken | RequestRevokeIntegrationToken | ResponseIntegrationToken | Revoke token |
Audio location
| Field | Type | Label | Description |
| file_location | FileLocation | File location |
|
| duration | int32 | audio duration in seconds |
|
| mime_type | string | mime type |
|
| file_size | int32 | file size |
Avatar of User or Group
| Field | Type | Label | Description |
| small_image | AvatarImage | Optional small image of avatar box in 100x100 |
|
| large_image | AvatarImage | Optional large image of avatar box in 200x200 |
|
| full_image | AvatarImage | Optional full screen image of avatar |
Avatar Image
| Field | Type | Label | Description |
| file_location | FileLocation | Location of file |
|
| width | int32 | Width of avatar image |
|
| height | int32 | Height of avatar image |
|
| file_size | int32 | Size of file |
| Field | Type | Label | Description |
| rgb | RgbColor |
|
|
| predefined | PredefinedColor |
|
Fast thumb of media messages. Less than 90x90 and compressed by JPEG with low quality
| Field | Type | Label | Description |
| w | int32 | Width of thumb |
|
| h | int32 | Height of thump |
|
| thumb | bytes | compressed image data |
Location of file on server
| Field | Type | Label | Description |
| file_id | int64 | Unique Id of file |
|
| access_hash | int64 | Access hash of file |
File url description
| Field | Type | Label | Description |
| file_id | int64 | File id of url |
|
| url | string | Url for downloading |
|
| timeout | int32 | Timeout of url |
|
| unsigned_url | google.protobuf.StringValue | Unsigned URL (used to honor web caches) |
|
| unsigned_url_headers | HTTPHeader | repeated | Headers that is required to download files with unsigned url |
HTTP Header record
| Field | Type | Label | Description |
| key | string | HTTP Header name |
|
| value | string | HTTP Header value |
Image location
| Field | Type | Label | Description |
| file_location | FileLocation | Location of file |
|
| width | int32 | Width of avatar image |
|
| height | int32 | Height of avatar image |
|
| file_size | int32 | Size of file |
Predefined color
| Field | Type | Label | Description |
| color | Colors | Predefined color value |
Comminting uploaded file to storage
| Field | Type | Label | Description |
| upload_key | bytes |
|
|
| file_name | string |
|
Upload file part
| Field | Type | Label | Description |
| part_number | int32 |
|
|
| part_size | int32 |
|
|
| upload_key | bytes |
|
Requesting pload url
| Field | Type | Label | Description |
| expected_size | int32 |
|
Requesting file URL for downloading
| Field | Type | Label | Description |
| file | FileLocation |
|
Get File URL Builder that allows to build file urls from client side
| Field | Type | Label | Description |
| supported_signature_algorithms | string | repeated |
|
Requesting multiple fle URL for downloading
| Field | Type | Label | Description |
| files | FileLocation | repeated |
|
| Field | Type | Label | Description |
| uploaded_file_location | FileLocation |
|
| Field | Type | Label | Description |
| url | string |
|
| Field | Type | Label | Description |
| url | string |
|
|
| upload_key | bytes |
|
| Field | Type | Label | Description |
| url | string |
|
|
| timeout | int32 |
|
|
| unsigned_url | google.protobuf.StringValue |
|
|
| unsigned_url_headers | HTTPHeader | repeated |
|
| Field | Type | Label | Description |
| base_url | string |
|
|
| algo | string |
|
|
| seed | string |
|
|
| signature_secret | bytes |
|
|
| timeout | int32 |
|
| Field | Type | Label | Description |
| file_urls | FileUrlDescription | repeated |
|
RGB Color
| Field | Type | Label | Description |
| rgb | int32 | RGB color value |
| Name | Number | Description |
| COLORS_UNKNOWN | 0 | |
| COLORS_RED | 1 | |
| COLORS_YELLOW | 2 | |
| COLORS_GREEN | 3 |
| Method Name | Request Type | Response Type | Description |
| GetFileUrl | RequestGetFileUrl | ResponseGetFileUrl | Get link to file for downloading |
| GetFileUrls | RequestGetFileUrls | ResponseGetFileUrls | Get link to files for downloading |
| GetFileUrlBuilder | RequestGetFileUrlBuilder | ResponseGetFileUrlBuilder | Create builder for file url |
| GetFileUploadUrl | RequestGetFileUploadUrl | ResponseGetFileUploadUrl | Get url for uploading |
| CommitFileUpload | RequestCommitFileUpload | ResponseCommitFileUpload | Finish uploading a file |
| GetFileUploadPartUrl | RequestGetFileUploadPartUrl | ResponseGetFileUploadPartUrl | Get url for uploading chunk of file |
Audio media
| Field | Type | Label | Description |
| audio | AudioLocation |
|
Binary Message. Useful for implementing your own content types
| Field | Type | Label | Description |
| content_tag | string |
|
|
| msg | bytes |
|
Deleted message
| Field | Type | Label | Description |
| is_local | google.protobuf.BoolValue | Deleted locally message |
Conversation from history
peer
unreadCount
sortDate date of conversation for sorting
senderUid Sender of top message (may be zero)
isFavourite Is dialog favourite
rid Random ID of top message (may be zero)
mid Message id
date Date of top message (can't be zero)
message Content of message
firstUnreadDate Date of first unread message
attributes Optional top message attributes
pinnedMessages Optional pinned messages
historyMessage Optional last messages
| Field | Type | Label | Description |
| peer | Peer | Peer of conversation |
|
| unread_count | int32 | counter of unread messages |
|
| sort_date | int64 | deprecated |
|
| sender_uid | int32 |
|
|
| is_favourite | google.protobuf.BoolValue |
|
|
| mid | UUIDValue | Message id |
|
| date | int64 | last action date |
|
| message | MessageContent | last message content |
|
| state | MessageState |
|
|
| first_unread_date | int64 |
|
|
| attributes | MessageAttributes |
|
|
| pinned_messages | PinnedMessages |
|
|
| history_message | HistoryMessage | last message in this dialog |
Grouped dialog list
| Field | Type | Label | Description |
| title | string |
|
|
| key | string |
|
|
| dialogs | DialogShort | repeated |
|
Dialog index from history. Used in client side pagination
| Field | Type | Label | Description |
| peer | Peer | The peer for the conversation |
|
| timestamp | int64 | The timestamp for the top message |
Short Dialog from grouped conversation list
| Field | Type | Label | Description |
| peer | Peer | Peer of conversation |
|
| counter | int32 | Conversation unread count |
|
| date | int64 | Conversation top message date |
| Field | Type | Label | Description |
| photo | DocumentExPhoto |
|
|
| video | DocumentExVideo |
|
|
| voice | DocumentExVoice |
|
File photo extension
| Field | Type | Label | Description |
| w | int32 | image width |
|
| h | int32 | image height |
File video extension
| Field | Type | Label | Description |
| w | int32 | video width |
|
| h | int32 | video height |
|
| duration | int32 |
|
File voice extension
| Field | Type | Label | Description |
| duration | int32 |
|
File message
| Field | Type | Label | Description |
| file_id | int64 |
|
|
| access_hash | int64 |
|
|
| file_size | int32 |
|
|
| name | string |
|
|
| mime_type | string |
|
|
| thumb | FastThumb | optional thumb of file. JPEG less that 90x90 with 60-70 quality. |
|
| ext | DocumentEx |
|
Empty Message
Message from history
| Field | Type | Label | Description |
| sender_uid | int32 |
|
|
| sender_peer | OutPeer |
|
|
| host_peer | OutPeer |
|
|
| mid | UUIDValue | Message id generated by server |
|
| prev_mid | UUIDValue |
|
|
| date | int64 |
|
|
| message | MessageContent |
|
|
| state | MessageState |
|
|
| reactions | MessageReaction | repeated |
|
| attribute | MessageAttributes |
|
|
| forward | ReferencedMessages |
|
|
| reply | ReferencedMessages |
|
|
| edited_at | google.protobuf.Int64Value |
|
Image media
image image
| Field | Type | Label | Description |
| image | ImageLocation |
|
A text message extension representing an interactive action.
Can be used to add widgets (such as buttons, selects, etc) to messages.
| Field | Type | Label | Description |
| id | string | identifier of the media action |
|
| widget | InteractiveMediaWidget | a widget to be shown to user |
|
| style | InteractiveMediaStyle | a style of the widget, which is interpreted by the client |
|
| confirm | InteractiveMediaConfirm | A content of the alert dialog that will be show to user when they perform the media action |
A 'Button' widget
| Field | Type | Label | Description |
| value | string | A value for this button |
|
| label | google.protobuf.StringValue | A user-visible description of this button |
An alert dialog content to show to user
| Field | Type | Label | Description |
| text | google.protobuf.StringValue | the optional alert dialog prompt |
|
| title | google.protobuf.StringValue | the optional alert dialog title |
|
| ok | google.protobuf.StringValue | the optional confirm button text |
|
| dismiss | google.protobuf.StringValue | the optional cancel button text |
A group of interactive media actions
| Field | Type | Label | Description |
| actions | InteractiveMedia | repeated | the list of actions |
| title | google.protobuf.StringValue | an optional title of the group |
|
| description | google.protobuf.StringValue | an optional description of the group |
|
| translations | InteractiveMediaTranslationGroup | repeated | a media content translations |
A select from multiple values widget
| Field | Type | Label | Description |
| options | InteractiveMediaSelectOption | repeated | list of values to present to user |
| label | google.protobuf.StringValue | A user-visible descripton of this select |
|
| default_value | google.protobuf.StringValue | A value that will be selected by default |
A row in the select widget
| Field | Type | Label | Description |
| value | string | id of the row |
|
| label | string | a user visible text for this row |
| Field | Type | Label | Description |
| id | string |
|
|
| value | string |
|
| Field | Type | Label | Description |
| language | string | a translation group language |
|
| messages | InteractiveMediaTranslation | repeated | a list of translation mesages |
Some interactive element inside a message
| Field | Type | Label | Description |
| interactiveMediaButton | InteractiveMediaButton |
|
|
| interactiveMediaSelect | InteractiveMediaSelect |
|
Custom-data JsonMessage
| Field | Type | Label | Description |
| raw_json | string |
|
Message Attributes
| Field | Type | Label | Description |
| is_mentioned | google.protobuf.BoolValue | Is mentioned. If set overrides built-in value. |
|
| is_highlighted | google.protobuf.BoolValue | Is message highlighted. Default is false. |
|
| is_notified | google.protobuf.BoolValue | Is notified. If set overrides built-in settings. |
|
| is_only_for_you | google.protobuf.BoolValue | If this message is only for you. Default is false |
| Field | Type | Label | Description |
| textMessage | TextMessage |
|
|
| serviceMessage | ServiceMessage |
|
|
| documentMessage | DocumentMessage |
|
|
| jsonMessage | JsonMessage |
|
|
| unsupportedMessage | UnsupportedMessage |
|
|
| stickerMessage | StickerMessage |
|
|
| binaryMessage | BinaryMessage |
|
|
| emptyMessage | EmptyMessage |
|
|
| deletedMessage | DeletedMessage |
|
Message media
| Field | Type | Label | Description |
| webpage | WebpageMedia |
|
|
| image | ImageMedia |
|
|
| audio | AudioMedia |
|
|
| actions | InteractiveMediaGroup | repeated |
|
Reaction to message
| Field | Type | Label | Description |
| users | int32 | repeated | User's reaction |
| code | string | Reaction EMOJI code |
Paragraph style
| Field | Type | Label | Description |
| show_paragraph | google.protobuf.BoolValue | Show quote-like paragraph? |
|
| paragraph_color | Color | Override paragraph color |
|
| bg_color | Color | Override background color |
Pinned messages
| Field | Type | Label | Description |
| mids | UUIDValue | repeated | Messages ids |
Quoted Message
messageId
publicGroupId
senderUserId
messageDate
quotedMessageContent
| Field | Type | Label | Description |
| message_id | int64 | Message Id if present |
|
| public_group_id | int32 | Public Group id if present |
|
| sender_user_id | int32 | Sender of message |
|
| message_date | int64 | Date of message |
|
| quoted_message_content | MessageContent | Optional Quoted Message Content. Can be empty if messageId is present and message is in current peer. |
mids Referenced messge ids
| Field | Type | Label | Description |
| mids | UUIDValue | repeated |
|
Archiving chat
| Field | Type | Label | Description |
| peer | OutPeer |
|
Clearing of conversation (without removing dialog from dialogs list)
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| last_message_date | int64 |
|
Deleting of conversation (also leave group for group conversations)
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| last_message_date | int64 |
|
Deleting messages
| Field | Type | Label | Description |
| mids | UUIDValue | repeated | Message ids |
Sends a request to do interactive media message
| Field | Type | Label | Description |
| mid | UUIDValue | Message id of the enclosed message |
|
| id | string | Media id |
|
| value | string | selected value |
Marking dialog as favourite
| Field | Type | Label | Description |
| peer | OutPeer |
|
Fetches dialog index (short info about all user's dialogs).
Used in client side pagination.
Hide Dialog from grouped list
| Field | Type | Label | Description |
| peer | OutPeer |
|
Loading archived messages - deprecated
| Field | Type | Label | Description |
| next_offset | google.protobuf.BytesValue |
|
|
| limit | int32 |
|
|
| optimizations | UpdateOptimization | repeated |
|
Loading conversation history
| Field | Type | Label | Description |
| min_date | int64 |
|
|
| limit | int32 |
|
|
| optimizations | UpdateOptimization | repeated |
|
| filters | DialogsFilter | repeated |
|
| peers_to_load | Peer | repeated |
|
Load all dialogs from grouped list - deprecated
| Field | Type | Label | Description |
| optimizations | UpdateOptimization | repeated |
|
Loading history of chat
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| date | int64 |
|
|
| load_mode | ListLoadMode | forward, backward or both |
|
| limit | int32 |
|
|
| optimizations | UpdateOptimization | repeated |
|
Marking plain messages as read
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| date | int64 |
|
Confirmation of plain message receive by device
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| date | int64 |
|
Removing Message reaction
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| mid | UUIDValue | Message id |
|
| code | string | EMOJI code |
Setting Message reaction
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| mid | UUIDValue | Message id |
|
| code | string | EMOJI code |
Notifying about dialog open
| Field | Type | Label | Description |
| peer | OutPeer |
|
Pin message in conversation
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| mid | UUIDValue | Message id |
|
| last_pin_date | int64 |
|
Sending plain message
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| rid | int64 | Id for deduplication |
|
| message | MessageContent |
|
|
| is_only_for_user | int32 | if not empty, then message will be send to this user only |
|
| forward | ReferencedMessages | If current message forwards some other |
|
| reply | ReferencedMessages | If current message is a reply on some other |
Show Dialog in grouped list
| Field | Type | Label | Description |
| peer | OutPeer |
|
Making dialog as unfavourite
| Field | Type | Label | Description |
| peer | OutPeer |
|
Unpin message in conversation
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| mid | UUIDValue | Message id |
|
| last_pin_date | int64 |
|
Changing Message content
| Field | Type | Label | Description |
| mid | UUIDValue | Message id |
|
| updated_message | MessageContent |
|
|
| last_edited_at | int64 | Date from this message when it was changed last time |
Dialogs order response - deprecated
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| groups | DialogGroup | repeated |
|
| Field | Type | Label | Description |
| dialog_indices | DialogIndex | repeated |
|
deprecated
| Field | Type | Label | Description |
| groups | Group | repeated |
|
| users | User | repeated |
|
| dialogs | Dialog | repeated |
|
| user_peers | UserOutPeer | repeated |
|
| group_peers | GroupOutPeer | repeated |
|
| next_offset | google.protobuf.BytesValue |
|
Contains dialogs and related peers and entities
| Field | Type | Label | Description |
| groups | Group | repeated |
|
| users | User | repeated |
|
| dialogs | Dialog | repeated |
|
| user_peers | UserOutPeer | repeated |
|
| group_peers | GroupOutPeer | repeated |
|
deprecated
| Field | Type | Label | Description |
| dialogs | DialogGroup | repeated |
|
| users | User | repeated |
|
| groups | Group | repeated |
|
| show_archived | google.protobuf.BoolValue |
|
|
| show_invite | google.protobuf.BoolValue |
|
|
| user_peers | UserOutPeer | repeated |
|
| group_peers | GroupOutPeer | repeated |
|
| Field | Type | Label | Description |
| history | HistoryMessage | repeated |
|
| users | User | repeated |
|
| user_peers | UserOutPeer | repeated |
|
| groups | Group | repeated |
|
| group_peers | GroupOutPeer | repeated |
|
| counter | google.protobuf.Int32Value | counter of unread messages |
|
| counter_date | int64 | date, related to this unread counter |
Response for reactions change
| Field | Type | Label | Description |
| seq | int32 | deprecated |
|
| state | bytes |
|
|
| reactions | MessageReaction | repeated |
|
| Field | Type | Label | Description |
| userInvited | ServiceExUserInvited |
|
|
| userJoined | ServiceExUserJoined |
|
|
| userKicked | ServiceExUserKicked |
|
|
| userLeft | ServiceExUserLeft |
|
|
| groupCreated | ServiceExGroupCreated |
|
|
| changedTitle | ServiceExChangedTitle |
|
|
| changedTopic | ServiceExChangedTopic |
|
|
| changedAbout | ServiceExChangedAbout |
|
|
| changedAvatar | ServiceExChangedAvatar |
|
|
| contactRegistered | ServiceExContactRegistered |
|
|
| phoneMissed | ServiceExPhoneMissed |
|
|
| phoneCall | ServiceExPhoneCall |
|
|
| phoneRejected | ServiceExPhoneRejected |
|
|
| chatArchived | ServiceExChatArchived |
|
|
| chatRestored | ServiceExChatRestored |
|
Service message on group about change
| Field | Type | Label | Description |
| about | google.protobuf.StringValue | New group about |
Service message about avatar change
| Field | Type | Label | Description |
| avatar | Avatar | Updated avatar |
Service message about group title change
| Field | Type | Label | Description |
| title | string | New group title |
Service message on group topic change
| Field | Type | Label | Description |
| topic | google.protobuf.StringValue | New group topic |
Message about chat archived
Message about chat restored
Service message about user registration
| Field | Type | Label | Description |
| uid | int32 | User Id |
Service message about group creating
Update about phone call
| Field | Type | Label | Description |
| duration | int32 | Duration of a phone call |
Update about missing phone call
Update about phone call rejected
Service message about adding user to group
| Field | Type | Label | Description |
| invited_uid | int32 | added user id |
Service message about user join to group
Service message about kicking user from group
| Field | Type | Label | Description |
| kicked_uid | int32 |
|
Service message about user left group
Service message
| Field | Type | Label | Description |
| text | string |
|
|
| ext | ServiceEx |
|
Sticker message
| Field | Type | Label | Description |
| sticker_id | google.protobuf.Int32Value | Optional Unique ID of sticker |
|
| fast_preview | google.protobuf.BytesValue | Optional Fast preview of sticker in webp format |
|
| image_512 | ImageLocation | Optional 512x512 sticker image in webp format |
|
| image_256 | ImageLocation | Optional 256x256 sticker image in webp format |
|
| sticker_collection_id | google.protobuf.Int32Value | Optional Collection ID |
|
| sticker_collection_access_hash | google.protobuf.Int64Value | Optional Collection Access Hash |
|
| emoji | google.protobuf.StringValue | Sticker emoji |
Text Command Message for bots
| Field | Type | Label | Description |
| command | string | Slash-Command For execution |
|
| args | string |
|
Markdown extension
| Field | Type | Label | Description |
| markdown | string | Markdown text |
Text message
| Field | Type | Label | Description |
| text | string |
|
|
| mentions | int32 | repeated | User mentions in message |
| ext | TextMessageEx | Optional bytes of extension |
|
| media | MessageMedia | repeated |
|
| extensions | Any | repeated |
|
| Field | Type | Label | Description |
| textExMarkdown | TextExMarkdown |
|
|
| textModernMessage | TextModernMessage |
|
|
| textCommand | TextCommand |
|
Attaches to message
| Field | Type | Label | Description |
| title | google.protobuf.StringValue |
|
|
| title_url | google.protobuf.StringValue |
|
|
| title_icon | ImageLocation |
|
|
| text | google.protobuf.StringValue |
|
|
| style | ParagraphStyle |
|
|
| fields | TextModernField | repeated |
|
Modern message fields
| Field | Type | Label | Description |
| title | string |
|
|
| value | string |
|
|
| is_short | google.protobuf.BoolValue | Is field can be shown in compact way (default is TRUE) |
Modern text message
| Field | Type | Label | Description |
| text | google.protobuf.StringValue |
|
|
| sender_name_override | google.protobuf.StringValue |
|
|
| sender_photo_override | Avatar |
|
|
| style | ParagraphStyle |
|
|
| attaches | TextModernAttach | repeated |
|
Explicit type for unsupported message
Update about chat archive
| Field | Type | Label | Description |
| peer | Peer |
|
Update about chat clear
| Field | Type | Label | Description |
| peer | Peer |
|
|
| action_date | int64 |
|
Update about chat delete
| Field | Type | Label | Description |
| peer | Peer |
|
|
| action_date | int64 |
|
Update about chat groups changed. Called only when adding, removing and reordering of grouped dialog.
| Field | Type | Label | Description |
| dialogs | DialogGroup | repeated |
|
Update about dialog favourite changed
| Field | Type | Label | Description |
| peer | Peer |
|
|
| is_favourite | google.protobuf.BoolValue |
|
The update which will be received when the action is performed. Duplicated on all clients.
| Field | Type | Label | Description |
| mid | UUIDValue | Message id of the message that contains interactive media |
|
| id | string | identifier of the media action |
|
| value | string | selected value of that action |
|
| uid | int32 | who interacted with that media |
Update about plain message
| Field | Type | Label | Description |
| peer | Peer |
|
|
| sender_uid | int32 |
|
|
| date | int64 |
|
|
| mid | UUIDValue | Message id |
|
| message | MessageContent |
|
|
| attributes | MessageAttributes | attributes to help reasoning about message |
|
| forward | ReferencedMessages |
|
|
| reply | ReferencedMessages |
|
|
| previous_mid | UUIDValue | Message id of previos message from current conversation |
|
| counter | google.protobuf.Int32Value | counter of unreads message |
Update about message change
| Field | Type | Label | Description |
| peer | Peer |
|
|
| mid | UUIDValue | Message id |
|
| message | MessageContent |
|
|
| edited_at | int64 |
|
Update about message delete
| Field | Type | Label | Description |
| peer | Peer |
|
|
| mids | UUIDValue | repeated | Deleted messages |
| counter | google.protobuf.Int32Value | counter of unread messages |
|
| action_date | int64 | date? related for this unread counter |
Update about message read
| Field | Type | Label | Description |
| peer | Peer |
|
|
| start_date | int64 | when message was read |
|
| read_date | int64 | deprecated |
Update about message read by me
| Field | Type | Label | Description |
| peer | Peer |
|
|
| start_date | int64 | when message was read |
|
| unread_counter | google.protobuf.Int32Value | counter of unread messages |
Update about message received
| Field | Type | Label | Description |
| peer | Peer |
|
|
| start_date | int64 | when message was receive |
|
| received_date | int64 | deprecated |
Update about message sent
| Field | Type | Label | Description |
| peer | Peer |
|
|
| rid | int64 |
|
|
| date | int64 |
|
|
| mid | UUIDValue | Message id |
|
| prev_mid | UUIDValue | Previous message id in current conversation |
|
| unread_counter | google.protobuf.Int32Value | counter of unread messages |
Update about pinned messages changed in conversation
| Field | Type | Label | Description |
| peer | Peer |
|
|
| pinned_messages | PinnedMessages |
|
|
| action_date | int64 |
|
Update about reactions change
| Field | Type | Label | Description |
| peer | Peer |
|
|
| mid | UUIDValue | related message id |
|
| reactions | MessageReaction | repeated |
|
Webpage media
| Field | Type | Label | Description |
| url | google.protobuf.StringValue |
|
|
| title | google.protobuf.StringValue |
|
|
| description | google.protobuf.StringValue |
|
|
| image | ImageLocation |
|
| Name | Number | Description |
| DIALOGSFILTER_UNKNOWN | 0 | |
| DIALOGSFILTER_EXCLUDEFAVOURITES | 1 | |
| DIALOGSFILTER_EXCLUDEARCHIVED | 2 |
| Name | Number | Description |
| INTERACTIVEMEDIASTYLE_UNKNOWN | 0 | |
| INTERACTIVEMEDIASTYLE_DEFAULT | 1 | |
| INTERACTIVEMEDIASTYLE_PRIMARY | 2 | |
| INTERACTIVEMEDIASTYLE_DANGER | 3 |
| Name | Number | Description |
| LISTLOADMODE_UNKNOWN | 0 | |
| LISTLOADMODE_FORWARD | 1 | |
| LISTLOADMODE_BACKWARD | 2 | |
| LISTLOADMODE_BOTH | 3 |
| Name | Number | Description |
| MESSAGESTATE_UNKNOWN | 0 | |
| MESSAGESTATE_SENT | 1 | |
| MESSAGESTATE_RECEIVED | 2 | |
| MESSAGESTATE_READ | 3 |
Any
typeUrl type url
data data
| Field | Type | Label | Description |
| type_url | string |
|
|
| data | bytes |
|
Calls configuration
callsEnabled If true then client should enable calls
videoCallsEnabled If true then client should enable video calls
groupCallsEnabled If true then client should enable group calls
groupCallsMaxMembers Determines how many members may participate in call
rtcpMuxPolicy The RTCP mux policy to use when gathering ICE candidates
emojiSecurityEnabled If true then client should send and render emoji security
screenSharingEnabled If true then client should enable screen sharing
| Field | Type | Label | Description |
| calls_enabled | google.protobuf.BoolValue |
|
|
| video_calls_enabled | google.protobuf.BoolValue |
|
|
| group_calls_enabled | google.protobuf.BoolValue |
|
|
| group_calls_max_members | google.protobuf.Int32Value |
|
|
| rtcp_mux_policy | RtcpMuxPolicy |
|
|
| emoji_security_enabled | google.protobuf.BoolValue |
|
|
| screen_sharing_enabled | google.protobuf.BoolValue |
|
Configuration of system
maxGroupSize Current maximum group size
discover Discover configuration
shareEndpoint Share endpoint
callsConfig Calls configuration
groupInviteConfig Group invite configuration
serverMetaInfo Server meta information (version, etc.)
customProfileSchema Custom profile JSON Schema
servicePeers Service peers supported interpreted by the client
| Field | Type | Label | Description |
| max_group_size | int32 |
|
|
| discover | Discover |
|
|
| share_endpoint | google.protobuf.StringValue |
|
|
| calls_config | CallsConfig |
|
|
| group_invite_config | InvitesConfig |
|
|
| server_meta_info | ServerMetaInfo |
|
|
| custom_profile_schema | string |
|
|
| service_peers | ServicePeers |
|
|
| extensions | Any | repeated |
|
Discover description
peers peers
| Field | Type | Label | Description |
| peers | OutPeer | repeated |
|
Extention
id Extension id
data Extension data
| Field | Type | Label | Description |
| id | int32 |
|
|
| data | bytes |
|
Group invites configuration
baseUrl Base URL part
groupInviteUrlPrefix Prefix for private group invite detection
resolveUrlPrefix Prefix for public groups and users link detection
shareInviteUrl Independent URL for external app sharing
| Field | Type | Label | Description |
| base_url | google.protobuf.StringValue |
|
|
| group_invite_url_prefix | google.protobuf.StringValue |
|
|
| resolve_url_prefix | google.protobuf.StringValue |
|
|
| share_invite_url | google.protobuf.StringValue |
|
| Field | Type | Label | Description |
| items | RecursiveMapValue.Item | repeated |
|
| Field | Type | Label | Description |
| values | RecursiveMapValue.Value | repeated |
|
| Field | Type | Label | Description |
| key | string |
|
|
| value | RecursiveMapValue.Value |
|
| Field | Type | Label | Description |
| d | google.protobuf.DoubleValue |
|
|
| i32 | google.protobuf.Int32Value |
|
|
| i64 | google.protobuf.Int64Value |
|
|
| str | google.protobuf.StringValue |
|
|
| rec | RecursiveMapValue |
|
|
| array_rec | RecursiveMapValue.Array |
|
Boolean response
| Field | Type | Label | Description |
| value | bool |
|
Sequence response. Methods that return this value must process response in particular order
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| date | int64 |
|
Sequence response with date. Methods that return this value must process response in particular order
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| date | int64 |
|
|
| mid | UUIDValue |
|
Response with seq, date and messageId
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| date | int64 |
|
|
| mid | UUIDValue |
|
Empty response
Some info about the servr
releaseDate Server release date in milliseconds
apiVersion Server api version
| Field | Type | Label | Description |
| release_date | int64 |
|
|
| api_version | google.protobuf.Int64Value |
|
Service peers
| Field | Type | Label | Description |
| security | OutPeer |
|
|
| support | OutPeer |
|
|
| stash | OutPeer |
|
Update about config change
| Field | Type | Label | Description |
| config | Config |
|
|
| config_hash | google.protobuf.Int64Value |
|
| Name | Number | Description |
| RTCPMUXPOLICY_UNKNOWN | 0 | |
| RTCPMUXPOLICY_NEGOTIATE | 1 | |
| RTCPMUXPOLICY_REQUIRE | 2 |
| Name | Number | Description |
| UPDATEOPTIMIZATION_UNKNOWN | 0 | |
| UPDATEOPTIMIZATION_NONE | 1 | |
| UPDATEOPTIMIZATION_STRIP_ENTITIES | 2 | |
| UPDATEOPTIMIZATION_ENABLE_COMBINED | 3 | |
| UPDATEOPTIMIZATION_FASTER_MESSAGES | 4 | |
| UPDATEOPTIMIZATION_STRIP_COUNTERS | 5 | |
| UPDATEOPTIMIZATION_COMPACT_USERS | 6 | |
| UPDATEOPTIMIZATION_GROUPS_V2 | 7 | |
| UPDATEOPTIMIZATION_STRIP_ENTITIES_V2 | 8 |
| Field | Type | Label | Description |
| seq | google.protobuf.Int32Value |
|
|
| state | bytes |
|
|
| configHash | int64 |
|
| Field | Type | Label | Description |
| peer | ObsoletePeer |
|
|
| accessHash | int64 |
|
| Field | Type | Label | Description |
| type | ObsoletePeer.ObsoletePeerType |
|
|
| id | int32 |
|
|
| strId | google.protobuf.StringValue |
|
|
| access_hash | int64 |
|
| Field | Type | Label | Description |
| peers | ObsoletePeer | repeated |
|
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| obsoleteUpdate | google.protobuf.BytesValue |
|
| Field | Type | Label | Description |
| obsoleteUpdate | google.protobuf.BytesValue |
|
| Field | Type | Label | Description |
| date | int64 |
|
|
| typing | ObsoleteWeakUpdateBox.ObsoleteUpdateTyping |
|
|
| userLastSeen | ObsoleteWeakUpdateBox.ObsoleteUpdateUserLastSeen |
|
|
| groupOnline | ObsoleteWeakUpdateBox.ObsoleteUpdateGroupOnline |
|
|
| busMessage | ObsoleteWeakUpdateBox.ObsoleteUpdateEventBusMessage |
|
|
| busDeviceConnected | ObsoleteWeakUpdateBox.ObsoleteUpdateEventBusDeviceConnected |
|
|
| busDeviceDisconnected | ObsoleteWeakUpdateBox.ObsoleteUpdateEventBusDeviceDisconnected |
|
|
| busDisposed | ObsoleteWeakUpdateBox.ObsoleteUpdateEventBusDisposed |
|
|
| forceReload | ObsoleteWeakUpdateBox.ObsoleteUpdateForceReloadState |
|
|
| incomingCall | ObsoleteWeakUpdateBox.ObsoleteUpdateIncomingCall |
|
|
| callHandled | ObsoleteWeakUpdateBox.ObsoleteUpdateCallHandled |
|
|
| callDisposed | ObsoleteWeakUpdateBox.ObsoleteUpdateCallDisposed |
|
| Field | Type | Label | Description |
| callId | int64 |
|
|
| attemptIndex | google.protobuf.Int32Value |
|
|
| reason | ObsoleteWeakUpdateBox.ObsoleteUpdateCallDisposed.ObsoleteDisposalReason |
|
| Field | Type | Label | Description |
| callId | int64 |
|
|
| attemptIndex | google.protobuf.Int32Value |
|
| Field | Type | Label | Description |
| busId | string |
|
|
| userId | google.protobuf.Int32Value |
|
|
| deviceId | int64 |
|
| Field | Type | Label | Description |
| busId | string |
|
|
| userId | google.protobuf.Int32Value |
|
|
| deviceId | int64 |
|
| Field | Type | Label | Description |
| busId | string |
|
| Field | Type | Label | Description |
| busId | string |
|
|
| senderId | google.protobuf.Int32Value |
|
|
| senderDeviceId | google.protobuf.Int64Value |
|
|
| message | bytes |
|
| Field | Type | Label | Description |
| fields | ObsoleteWeakUpdateBox.ObsoleteUpdateForceReloadState.ObsoleteForceReloadField | repeated |
|
| Field | Type | Label | Description |
| groupId | int32 |
|
|
| count | int32 |
|
| Field | Type | Label | Description |
| callId | int64 |
|
|
| busId | string |
|
|
| peer | ObsoletePeer |
|
|
| displayName | google.protobuf.StringValue |
|
|
| attemptIndex | google.protobuf.Int32Value |
|
|
| outPeer | ObsoleteOutPeer |
|
| Field | Type | Label | Description |
| peer | ObsoletePeer |
|
|
| userId | int32 |
|
|
| type | ObsoleteTypingType |
|
|
| isTyping | bool |
|
| Field | Type | Label | Description |
| userId | int32 |
|
|
| epochMillis | int64 |
|
|
| deviceType | int32 |
|
|
| deviceCategory | string |
|
|
| isOnline | bool |
|
| Field | Type | Label | Description |
| subscribeToOnlines | ObsoletePeersList |
|
|
| unsubscribeFromOnlines | ObsoletePeersList |
|
|
| dropOnlineSubscriptions | google.protobuf.Empty |
|
|
| myTyping | ObsoleteWeakUpdateCommand.ObsoleteMyTyping |
|
|
| subscribeToTypings | ObsoletePeersList |
|
|
| unsubscribeFromTypings | ObsoletePeersList |
|
|
| dropTypingSubscriptions | google.protobuf.Empty |
|
|
| subscribeToEventBusUpdates | google.protobuf.Empty |
|
|
| myOnline | ObsoleteWeakUpdateCommand.ObsoleteMyOnline |
|
| Field | Type | Label | Description |
| online | bool |
|
| Field | Type | Label | Description |
| peer | ObsoletePeer |
|
|
| type | ObsoleteTypingType |
|
|
| start | bool |
|
| Name | Number | Description |
| OBSOLETE_PEERTYPE_UNKNOWN | 0 | |
| OBSOLETE_PEERTYPE_PRIVATE | 1 | |
| OBSOLETE_PEERTYPE_GROUP | 2 | |
| OBSOLETE_PEERTYPE_SIP | 4 | PEERTYPE_ENCRYPTED_PRIVATE = 3; |
| Name | Number | Description |
| OBSOLETE_TYPINGTYPE_UNKNOWN | 0 | |
| OBSOLETE_TYPINGTYPE_TEXT | 1 |
deprecated
| Method Name | Request Type | Response Type | Description |
| Obsolete | .google.protobuf.BytesValue | .google.protobuf.BytesValue | |
| SeqUpdates | .google.protobuf.Empty | ObsoleteSeqUpdateBox | |
| WeakUpdates | ObsoleteWeakUpdateCommand | ObsoleteWeakUpdateBox |
Group's out peer
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| access_hash | int64 |
|
Out peer with access hash
| Field | Type | Label | Description |
| type | PeerType |
|
|
| id | int32 |
|
|
| access_hash | int64 |
|
|
| str_id | google.protobuf.StringValue |
|
Peer
| Field | Type | Label | Description |
| type | PeerType |
|
|
| id | int32 |
|
|
| str_id | google.protobuf.StringValue |
|
User's out peer
| Field | Type | Label | Description |
| uid | int32 | User's id |
|
| access_hash | int64 |
|
| Name | Number | Description |
| PEERTYPE_UNKNOWN | 0 | |
| PEERTYPE_PRIVATE | 1 | |
| PEERTYPE_GROUP | 2 | |
| PEERTYPE_ENCRYPTEDPRIVATE | 3 | |
| PEERTYPE_SIP | 4 |
Block User
| Field | Type | Label | Description |
| peer | UserOutPeer |
|
Load Blocked Users
Unblock User
| Field | Type | Label | Description |
| peer | UserOutPeer |
|
| Field | Type | Label | Description |
| user_peers | UserOutPeer | repeated |
|
Update about User Blocked
| Field | Type | Label | Description |
| uid | int32 |
|
Update about User Unblocked
| Field | Type | Label | Description |
| uid | int32 |
|
| Method Name | Request Type | Response Type | Description |
| BlockUser | RequestBlockUser | ResponseSeq | |
| UnblockUser | RequestUnblockUser | ResponseSeq | |
| LoadBlockedUsers | RequestLoadBlockedUsers | ResponseLoadBlockedUsers |
Changing user's status
| Field | Type | Label | Description |
| status | UserStatus |
|
Checking availability of nickname
| Field | Type | Label | Description |
| nickname | string |
|
Changing about information
| Field | Type | Label | Description |
| about | google.protobuf.StringValue |
|
Changing account's avatar
| Field | Type | Label | Description |
| file_location | FileLocation |
|
Chaning user custom profile based on scheme
| Field | Type | Label | Description |
| custom_profile | string |
|
Changing preffered languages
| Field | Type | Label | Description |
| preferred_languages | string | repeated |
|
Updating user's time zone
| Field | Type | Label | Description |
| tz | string |
|
Changing account's name
| Field | Type | Label | Description |
| name | string |
|
Changing account's nickname
| Field | Type | Label | Description |
| nickname | google.protobuf.StringValue |
|
Changing user's sex
| Field | Type | Label | Description |
| sex | Sex |
|
Removing account's avatar
| Field | Type | Label | Description |
| avatar | Avatar |
|
|
| seq | int32 |
|
|
| state | bytes |
|
| Method Name | Request Type | Response Type | Description |
| EditName | RequestEditName | ResponseSeq | |
| EditNickName | RequestEditNickName | ResponseSeq | |
| CheckNickName | RequestCheckNickName | ResponseBool | |
| EditAbout | RequestEditAbout | ResponseSeq | |
| EditAvatar | RequestEditAvatar | ResponseEditAvatar | |
| RemoveAvatar | RequestRemoveAvatar | ResponseSeq | |
| EditMyTimeZone | RequestEditMyTimeZone | ResponseSeq | |
| EditMyPreferredLanguages | RequestEditMyPreferredLanguages | ResponseSeq | |
| EditSex | RequestEditSex | ResponseSeq | |
| EditCustomProfile | RequestEditCustomProfile | ResponseSeq | |
| ChangeUserStatus | RequestChangeUserStatus | ResponseSeq |
Registering apple push on server
| Field | Type | Label | Description |
| apns_key | int32 |
|
|
| token | string |
|
Registration of a new Apple's PushKit tokens
| Field | Type | Label | Description |
| apns_key | int32 |
|
|
| token | string |
|
Registering Apple Push Token
| Field | Type | Label | Description |
| bundle_id | string |
|
|
| token | string |
|
Registering push token on server
| Field | Type | Label | Description |
| project_id | int64 |
|
|
| token | string |
|
Unregistering Apple Push
| Field | Type | Label | Description |
| token | string |
|
Unregistering Apple Push Kit token
| Field | Type | Label | Description |
| token | string |
|
Unregister Apple Push token
| Field | Type | Label | Description |
| token | string |
|
Unregistering Google Push
| Field | Type | Label | Description |
| token | string |
|
| Method Name | Request Type | Response Type | Description |
| RegisterGooglePush | RequestRegisterGooglePush | ResponseVoid | |
| UnregisterGooglePush | RequestUnregisterGooglePush | ResponseVoid | |
| RegisterApplePush | RequestRegisterApplePush | ResponseVoid | |
| UnregisterApplePush | RequestUnregisterApplePush | ResponseVoid | |
| RegisterApplePushKit | RequestRegisterApplePushKit | ResponseVoid | |
| UnregisterApplePushKit | RequestUnregisterApplePushKit | ResponseVoid | |
| RegisterApplePushToken | RequestRegisterApplePushToken | ResponseVoid | |
| UnregisterApplePushToken | RequestUnregisterApplePushToken | ResponseVoid |
| Field | Type | Label | Description |
| service | google.protobuf.StringValue |
|
|
| body | google.protobuf.BytesValue |
|
| Field | Type | Label | Description |
| body | google.protobuf.BytesValue |
|
| Method Name | Request Type | Response Type | Description |
| RawRequest | RequestRawRequest | ResponseRawRequest |
| Field | Type | Label | Description |
| auth_id | int64 |
|
|
| signature | bytes |
|
| Field | Type | Label | Description |
| client_pk | bytes |
|
|
| app_id | int32 |
|
|
| app_title | string |
|
|
| device_title | string |
|
| Field | Type | Label | Description |
| server_pk | bytes |
|
|
| auth_id | int64 |
|
|
| token | string |
|
| Method Name | Request Type | Response Type | Description |
| ExchangeAuthIdForToken | RequestExchangeAuthIdForToken | ResponseDeviceRequest | |
| RegisterDevice | RequestRegisterDevice | ResponseDeviceRequest | register device to get auth token |
| RegisterDeprecatedDevice | RegisterDeprecatedDeviceRequest | ResponseDeviceRequest | deprecated |
Message Search result container
| Field | Type | Label | Description |
| result | MessageSearchResult |
|
Message container
| Field | Type | Label | Description |
| peer | Peer |
|
|
| rid | int64 | deprecated |
|
| date | int64 |
|
|
| sender_id | int32 |
|
|
| content | MessageContent |
|
Peer search result
| Field | Type | Label | Description |
| peer | Peer |
|
|
| title | string |
|
|
| shortname | google.protobuf.StringValue |
|
|
| description | google.protobuf.StringValue |
|
|
| members_count | google.protobuf.Int32Value |
|
|
| date_created | int64 | Group Creation Date |
|
| creator | google.protobuf.Int32Value |
|
|
| is_public | google.protobuf.BoolValue |
|
|
| is_joined | google.protobuf.BoolValue | Are you joined? |
Performing message search
| Field | Type | Label | Description |
| query | SearchCondition |
|
|
| optimizations | UpdateOptimization | repeated |
|
Performing message search paging
| Field | Type | Label | Description |
| load_more_state | bytes | Cursor |
|
| optimizations | UpdateOptimization | repeated |
|
Performing peer search
| Field | Type | Label | Description |
| query | SearchCondition | repeated |
|
| optimizations | UpdateOptimization | repeated |
|
Resolve peer by shortname
| Field | Type | Label | Description |
| shortname | string |
|
| Field | Type | Label | Description |
| criteria | SimpleSearchCondition | repeated |
|
| optimizations | UpdateOptimization | repeated |
|
| Field | Type | Label | Description |
| load_more_state | bytes | Cursor |
|
| optimizations | UpdateOptimization | repeated |
|
Search Result with related peers and entities
| Field | Type | Label | Description |
| search_results | MessageSearchItem | repeated |
|
| users | User | repeated |
|
| groups | Group | repeated |
|
| load_more_state | google.protobuf.BytesValue |
|
|
| user_out_peers | UserOutPeer | repeated |
|
| group_out_peers | GroupOutPeer | repeated |
|
Response with related peers and entities
| Field | Type | Label | Description |
| search_results | PeerSearchResult | repeated |
|
| users | User | repeated |
|
| groups | Group | repeated |
|
| user_peers | UserOutPeer | repeated |
|
| group_peers | GroupOutPeer | repeated |
|
| Field | Type | Label | Description |
| peer | OutPeer |
|
Search AND condion
| Field | Type | Label | Description |
| and_query | SearchCondition | repeated | "And" query |
| Field | Type | Label | Description |
| searchPeerTypeCondition | SearchPeerTypeCondition |
|
|
| searchPieceText | SearchPieceText |
|
|
| searchAndCondition | SearchAndCondition |
|
|
| searchOrCondition | SearchOrCondition |
|
|
| searchPeerCondition | SearchPeerCondition |
|
|
| searchPeerContentType | SearchPeerContentType |
|
|
| searchSenderIdConfition | SearchSenderIdConfition |
|
Search OR condition
| Field | Type | Label | Description |
| or_query | SearchCondition | repeated | "Or" query |
Serch Peer condition
| Field | Type | Label | Description |
| peer | OutPeer |
|
Search content type condition
| Field | Type | Label | Description |
| content_type | SearchContentType |
|
Search peer type condition
| Field | Type | Label | Description |
| peer_type | SearchPeerType |
|
Search peer name condition
| Field | Type | Label | Description |
| query | string |
|
Searching sender uid condition
| Field | Type | Label | Description |
| sender_id | int32 |
|
| Field | Type | Label | Description |
| text | string |
|
| Field | Type | Label | Description |
| peer | Peer | where to search |
|
| text | string | search term |
|
| content_type | SearchContentType | content message type to search |
Search among contacts/groups/users
| Field | Type | Label | Description |
| peer_type | SearchPeerType |
|
|
| text | google.protobuf.StringValue |
|
| Field | Type | Label | Description |
| contact | SimpleContactSearchCondition |
|
|
| message | SimpleMessageSearchCondition |
|
|
| peer | SimplePeerSearchCondition |
|
|
| userProfile | SimpleUserProfileSearchCondition |
|
| Field | Type | Label | Description |
| query_string | string |
|
| Name | Number | Description |
| SEARCHCONTENTTYPE_UNKNOWN | 0 | |
| SEARCHCONTENTTYPE_ANY | 1 | |
| SEARCHCONTENTTYPE_TEXT | 2 | |
| SEARCHCONTENTTYPE_LINKS | 3 | |
| SEARCHCONTENTTYPE_DOCUMENTS | 4 | |
| SEARCHCONTENTTYPE_PHOTOS | 5 |
| Name | Number | Description |
| SEARCHPEERTYPE_UNKNOWN | 0 | |
| SEARCHPEERTYPE_GROUPS | 1 | |
| SEARCHPEERTYPE_CONTACTS | 2 | |
| SEARCHPEERTYPE_PUBLIC | 3 |
| Method Name | Request Type | Response Type | Description |
| PeerSearch | RequestPeerSearch | ResponsePeerSearch | Search among groups/users/contacts |
| ResolvePeer | RequestResolvePeer | ResponseResolvePeer | |
| MessageSearch | RequestMessageSearch | ResponseMessageSearchResponse | Search by messages |
| MessageSearchMore | RequestMessageSearchMore | ResponseMessageSearchResponse | |
| SimpleSearch | RequestSimpleSearch | ResponseMessageSearchResponse | Custom search by conditions |
| SimpleSearchMore | RequestSimpleSearchMore | ResponseMessageSearchResponse |
Represents subset of group members
| Field | Type | Label | Description |
| group_peer | GroupOutPeer |
|
|
| member_ids | int32 | repeated |
|
Getting difference of dialogs
| Field | Type | Label | Description |
| clock | int64 | max of the last action dates among all user's dialogs |
Getting difference of sequence
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| optimizations | UpdateOptimization | repeated |
|
| config_hash | google.protobuf.Int64Value |
|
Loading referenced entities
| Field | Type | Label | Description |
| users | UserOutPeer | repeated | users needed |
| mids | UUIDValue | repeated | messages needed |
| group_members | GroupMembersSubset | repeated | Group + subset of members to return. For loading members of big groups by chunks. |
| groups | GroupOutPeer | repeated | groups needed |
Get main sequence state
| Field | Type | Label | Description |
| optimizations | UpdateOptimization | repeated |
|
Removing subscription for groups online
| Field | Type | Label | Description |
| groups | GroupOutPeer | repeated |
|
Removing subscription for users online
| Field | Type | Label | Description |
| users | UserOutPeer | repeated |
|
Subscribing for groups online
| Field | Type | Label | Description |
| groups | GroupOutPeer | repeated |
|
Subscribing for users online
| Field | Type | Label | Description |
| users | UserOutPeer | repeated |
|
Dialogs + peers and entities
| Field | Type | Label | Description |
| dialogs | Dialog | repeated |
|
| group_peers | GroupOutPeer | repeated |
|
| user_peers | UserOutPeer | repeated |
|
Updates happens after requested seq number + related peers and entities
| Field | Type | Label | Description |
| seq | int32 | seq of the last loaded update |
|
| state | bytes |
|
|
| users | User | repeated |
|
| groups | Group | repeated |
|
| updates | UpdateContainer | repeated |
|
| messages | HistoryMessage | repeated |
|
| need_more | bool | false if all updates returned |
|
| users_refs | UserOutPeer | repeated |
|
| groups_refs | GroupOutPeer | repeated |
|
| config | Config | user's config |
|
| config_hash | google.protobuf.Int64Value |
|
| Field | Type | Label | Description |
| users | User | repeated |
|
| groups | Group | repeated |
|
| messages | HistoryMessage | repeated |
|
Container which contains UpdateSeqUpdate
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| update | google.protobuf.BytesValue | serialized UpdateSeqUpdate |
Combined update
| Field | Type | Label | Description |
| seq_start | int32 | start of related sequence intervals |
|
| seq_end | int32 | end of related sequence intervals |
|
| state | bytes |
|
|
| users | User | repeated | related users |
| groups | Group | repeated | related groups |
| updates | UpdateContainer | repeated |
|
| messages | HistoryMessage | repeated | related messages |
Update container
| Field | Type | Label | Description |
| update_header | int32 |
|
|
| update | bytes |
|
Empty update
Fat sequence update with additional data
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| update_header | int32 |
|
|
| update | bytes |
|
|
| users | User | repeated | related users |
| groups | Group | repeated | related groups |
Custom Raw Update
| Field | Type | Label | Description |
| type | google.protobuf.StringValue |
|
|
| bytes | bytes |
|
Sequence update
| Field | Type | Label | Description |
| seq | int32 |
|
|
| state | bytes |
|
|
| update_header | int32 |
|
|
| updateForceReloadState | UpdateForceReloadState |
|
|
| updateUserAvatarChanged | UpdateUserAvatarChanged |
|
|
| updateUserNameChanged | UpdateUserNameChanged |
|
|
| updateUserLocalNameChanged | UpdateUserLocalNameChanged |
|
|
| updateUserContactsChanged | UpdateUserContactsChanged |
|
|
| updateUserNickChanged | UpdateUserNickChanged |
|
|
| updateUserAboutChanged | UpdateUserAboutChanged |
|
|
| updateUserPreferredLanguagesChanged | UpdateUserPreferredLanguagesChanged |
|
|
| updateUserTimeZoneChanged | UpdateUserTimeZoneChanged |
|
|
| updateUserBotCommandsChanged | UpdateUserBotCommandsChanged |
|
|
| updateUserExtChanged | UpdateUserExtChanged |
|
|
| updateUserFullExtChanged | UpdateUserFullExtChanged |
|
|
| updateUserSexChanged | UpdateUserSexChanged |
|
|
| updateUserCustomProfileChanged | UpdateUserCustomProfileChanged |
|
|
| updateUserStatusChanged | UpdateUserStatusChanged |
|
|
| updateContactRegistered | UpdateContactRegistered |
|
|
| updateContactsAdded | UpdateContactsAdded |
|
|
| updateContactsAddTaskSuspended | UpdateContactsAddTaskSuspended |
|
|
| updateContactsRemoved | UpdateContactsRemoved |
|
|
| updateUserBlocked | UpdateUserBlocked |
|
|
| updateUserUnblocked | UpdateUserUnblocked |
|
|
| updateInteractiveMediaEvent | UpdateInteractiveMediaEvent |
|
|
| updateMessage | UpdateMessage |
|
|
| updateMessageContentChanged | UpdateMessageContentChanged |
|
|
| updateMessageSent | UpdateMessageSent |
|
|
| updateMessageReceived | UpdateMessageReceived |
|
|
| updateMessageRead | UpdateMessageRead |
|
|
| updateMessageReadByMe | UpdateMessageReadByMe |
|
|
| updateMessageDelete | UpdateMessageDelete |
|
|
| updateChatClear | UpdateChatClear |
|
|
| updateChatDelete | UpdateChatDelete |
|
|
| updateChatArchive | UpdateChatArchive |
|
|
| updateChatGroupsChanged | UpdateChatGroupsChanged |
|
|
| updateReactionsUpdate | UpdateReactionsUpdate |
|
|
| updateDialogFavouriteChanged | UpdateDialogFavouriteChanged |
|
|
| updatePinnedMessagesChanged | UpdatePinnedMessagesChanged |
|
|
| updateGroupTitleChanged | UpdateGroupTitleChanged |
|
|
| updateGroupAvatarChanged | UpdateGroupAvatarChanged |
|
|
| updateGroupTopicChanged | UpdateGroupTopicChanged |
|
|
| updateGroupAboutChanged | UpdateGroupAboutChanged |
|
|
| updateGroupOwnerChanged | UpdateGroupOwnerChanged |
|
|
| updateGroupHistoryShared | UpdateGroupHistoryShared |
|
|
| updateGroupCanSendMessagesChanged | UpdateGroupCanSendMessagesChanged |
|
|
| updateGroupCanViewMembersChanged | UpdateGroupCanViewMembersChanged |
|
|
| updateGroupCanInviteMembersChanged | UpdateGroupCanInviteMembersChanged |
|
|
| updateGroupMemberChanged | UpdateGroupMemberChanged |
|
|
| updateGroupMembersBecameAsync | UpdateGroupMembersBecameAsync |
|
|
| updateGroupMembersUpdated | UpdateGroupMembersUpdated |
|
|
| updateGroupMemberDiff | UpdateGroupMemberDiff |
|
|
| updateGroupMembersCountChanged | UpdateGroupMembersCountChanged |
|
|
| updateGroupMemberAdminChanged | UpdateGroupMemberAdminChanged |
|
|
| updateGroupMemberPermissionsChanged | UpdateGroupMemberPermissionsChanged |
|
|
| updateGroupInviteObsolete | UpdateGroupInviteObsolete |
|
|
| updateGroupUserInvitedObsolete | UpdateGroupUserInvitedObsolete |
|
|
| updateGroupUserLeaveObsolete | UpdateGroupUserLeaveObsolete |
|
|
| updateGroupUserKickObsolete | UpdateGroupUserKickObsolete |
|
|
| updateGroupMembersUpdateObsolete | UpdateGroupMembersUpdateObsolete |
|
|
| updateGroupTitleChangedObsolete | UpdateGroupTitleChangedObsolete |
|
|
| updateGroupTopicChangedObsolete | UpdateGroupTopicChangedObsolete |
|
|
| updateGroupAboutChangedObsolete | UpdateGroupAboutChangedObsolete |
|
|
| updateGroupAvatarChangedObsolete | UpdateGroupAvatarChangedObsolete |
|
|
| updateGroupShortnameChanged | UpdateGroupShortnameChanged |
|
|
| updateStickerCollectionsChanged | UpdateStickerCollectionsChanged |
|
|
| updateStickerPackRemoved | UpdateStickerPackRemoved |
|
|
| updateStickerPackAdded | UpdateStickerPackAdded |
|
|
| updatePauseNotifications | UpdatePauseNotifications |
|
|
| updateRestoreNotifications | UpdateRestoreNotifications |
|
|
| updateTyping | UpdateTyping |
|
|
| updateTypingStop | UpdateTypingStop |
|
|
| updateUserOnline | UpdateUserOnline |
|
|
| updateUserOffline | UpdateUserOffline |
|
|
| updateUserLastSeen | UpdateUserLastSeen |
|
|
| updateGroupOnline | UpdateGroupOnline |
|
|
| updateEventBusDeviceConnected | UpdateEventBusDeviceConnected |
|
|
| updateEventBusDeviceDisconnected | UpdateEventBusDeviceDisconnected |
|
|
| updateEventBusMessage | UpdateEventBusMessage |
|
|
| updateEventBusDisposed | UpdateEventBusDisposed |
|
|
| updateIncomingCallDeprecated | UpdateIncomingCallDeprecated |
|
|
| updateIncomingCall | UpdateIncomingCall |
|
|
| updateCallHandled | UpdateCallHandled |
|
|
| updateCallDisposed | UpdateCallDisposed |
|
|
| updateParameterChanged | UpdateParameterChanged |
|
|
| updateRawUpdate | UpdateRawUpdate |
|
|
| updateEmptyUpdate | UpdateEmptyUpdate |
|
|
| updateCountersChanged | UpdateCountersChanged |
|
|
| updateConfig | UpdateConfig |
|
|
| updateSpaceModified | UpdateSpaceModified |
|
|
| updateSpaceMemberModified | UpdateSpaceMemberModified |
|
Notification about requiring performing manual GetDifference
Fat Weak Update
| Field | Type | Label | Description |
| date | int64 |
|
|
| update_header | int32 |
|
|
| update | bytes |
|
|
| users | User | repeated |
|
| groups | Group | repeated |
|
Out of sequence update (for typing and online statuses)
| Field | Type | Label | Description |
| date | int64 |
|
|
| update_header | int32 |
|
|
| update | bytes |
|
| Method Name | Request Type | Response Type | Description |
| GetState | RequestGetState | ResponseSeq | Get last seq number |
| GetDifference | RequestGetDifference | ResponseGetDifference | Get all update that happens after given seq number |
| GetDialogsDifference | RequestGetDialogsDifference | ResponseGetDialogsDifference | Load all dialogs that changed after given date |
| GetReferencedEntitites | RequestGetReferencedEntitites | ResponseGetReferencedEntitites | Load some required entities |
| SubscribeToOnline | RequestSubscribeToOnline | ResponseVoid | |
| SubscribeFromOnline | RequestSubscribeFromOnline | ResponseVoid | |
| SubscribeToGroupOnline | RequestSubscribeToGroupOnline | ResponseVoid | |
| SubscribeFromGroupOnline | RequestSubscribeFromGroupOnline | ResponseVoid | |
| SeqUpdates | .google.protobuf.Empty | SeqUpdateBox | Get stream of the user's updates |
| Field | Type | Label | Description |
| request_id | int64 |
|
|
| title | string |
|
|
| shortname | google.protobuf.StringValue |
|
|
| about | google.protobuf.StringValue |
|
|
| avatar | Avatar |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| about | google.protobuf.StringValue |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| file_location | FileLocation |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| shortname | google.protobuf.StringValue |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| title | string |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| user_id | int32 |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| user_id | int32 |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| user_id | int32 |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| space_id | UUIDValue |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| space | Space | repeated |
|
| owner_peers | UserOutPeer | repeated |
|
| Field | Type | Label | Description |
| space | Space |
|
| Field | Type | Label | Description |
| invite_url | string |
|
| Field | Type | Label | Description |
| space_id | UUIDValue |
|
|
| member | SpaceMember |
|
| Field | Type | Label | Description |
| id | UUIDValue |
|
|
| created_at | google.protobuf.Timestamp |
|
|
| general | Space.General |
|
|
| public | Space.Public |
|
|
| private | Space.Private |
|
|
| title | string |
|
|
| about | google.protobuf.StringValue |
|
|
| avatar | Avatar |
|
|
| deleted_at | google.protobuf.Timestamp |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| owner_user_id | int32 |
|
| Field | Type | Label | Description |
| owner_user_id | int32 |
|
|
| shortname | string |
|
| Field | Type | Label | Description |
| space_id | UUIDValue |
|
|
| user_id | int32 |
|
|
| invited_at | google.protobuf.Timestamp |
|
|
| joined_at | google.protobuf.Timestamp |
|
|
| deleted_at | google.protobuf.Timestamp |
|
|
| clock | DataClock |
|
| Field | Type | Label | Description |
| member | SpaceMember |
|
|
| peer | UserOutPeer |
|
| Field | Type | Label | Description |
| member | SpaceMember |
|
| Field | Type | Label | Description |
| space | Space |
|
| Method Name | Request Type | Response Type | Description |
| CreateSpace | RequestCreateSpace | ResponseSpace | |
| DeleteSpace | RequestDeleteSpace | ResponseSpace | |
| SetTitle | RequestSetTitle | ResponseSpace | |
| SetShortname | RequestSetShortname | ResponseSpace | |
| SetAbout | RequestSetAbout | ResponseSpace | |
| SetAvatar | RequestSetAvatar | ResponseSpace | |
| LoadSpaces | RequestLoadSpaces | ResponseLoadSpaces | |
| LoadSpaceMembers | RequestStreamSpaceMembers | SpaceMemberWithPeer | |
| Invite | RequestSpaceInvite | ResponseSpaceMember | |
| Kick | RequestSpaceKick | ResponseSpaceMember | |
| Leave | RequestSpaceLeave | ResponseSpaceMember | |
| GetSpaceInviteUrl | RequestGetSpaceInviteUrl | ResponseSpaceInviteUrl | |
| RevokeSpaceInviteUrl | RequestRevokeSpaceInviteUrl | ResponseSpaceInviteUrl |
Adding sticker collection
| Field | Type | Label | Description |
| title | string |
|
Add a reference to other user's sticker pack
| Field | Type | Label | Description |
| source_sticker_pack | int32 |
|
Load accessible stickers
Loading own stickers
Loading stickers
| Field | Type | Label | Description |
| id | int32 |
|
Removing sticker collection
| Field | Type | Label | Description |
| id | int32 |
|
Remove a reference to an other user's sticker pack
| Field | Type | Label | Description |
| source_sticker_pack | int32 |
|
| Field | Type | Label | Description |
| accessible_stickers | StickerCollection | repeated |
|
| Field | Type | Label | Description |
| own_stickers | StickerCollection | repeated |
|
| Field | Type | Label | Description |
| collection | StickerCollection |
|
Stickers response
| Field | Type | Label | Description |
| collections | StickerCollection | repeated |
|
| seq | int32 | deprecated |
|
| state | bytes |
|
Sticker collection
| Field | Type | Label | Description |
| id | int32 | Unique id of a collection |
|
| title | google.protobuf.StringValue | Sticker pack title |
|
| stickers | StickerDescriptor | repeated |
|
| owned_by_me | google.protobuf.BoolValue | does this pack belongs to current user |
Descriptor of a Sticker
| Field | Type | Label | Description |
| id | int32 | Sticker unique id |
|
| emoji | google.protobuf.StringValue | Emoji code for sticker |
|
| image_128 | ImageLocation | Image of sticker 128x128 in WebP format |
|
| image_512 | ImageLocation | Image of sticker 512x512 in WebP format |
|
| image_256 | ImageLocation | Image of sticker 256x256 in WebP format |
Sticker collection changed
| Field | Type | Label | Description |
| updated_collections | StickerCollection | repeated |
|
Sticker pack was added
| Field | Type | Label | Description |
| pack | StickerCollection |
|
Sticker pack removed
| Field | Type | Label | Description |
| pack_id | int32 |
|
| Method Name | Request Type | Response Type | Description |
| LoadOwnStickers | RequestLoadOwnStickers | ResponseLoadOwnStickers | |
| LoadAcesssibleStickers | RequestLoadAcesssibleStickers | ResponseLoadAcesssibleStickers | |
| AddStickerPackReference | RequestAddStickerPackReference | ResponseSeq | |
| RemoveStickerPackReference | RequestRemoveStickerPackReference | ResponseSeq | |
| AddStickerCollection | RequestAddStickerCollection | ResponseSeq | |
| RemoveStickerCollection | RequestRemoveStickerCollection | ResponseSeq | |
| LoadStickerCollection | RequestLoadStickerCollection | ResponseLoadStickerCollection |
Pause notifications
| Field | Type | Label | Description |
| timeout | int32 |
|
Restoring notifications
Sending online state
| Field | Type | Label | Description |
| is_online | bool |
|
|
| timeout | int64 | offline after timeout |
|
| device_type | DeviceType |
|
|
| device_category | google.protobuf.StringValue |
|
Stop typing
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| typing_type | TypingType |
|
Sending typing notification
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| typing_type | TypingType |
|
Update about group online change
| Field | Type | Label | Description |
| group_id | int32 |
|
|
| count | int32 | amount of online users |
Update about pausing notifications
| Field | Type | Label | Description |
| timeout | int32 |
|
Update about restoring notifications
Update about user's typing
| Field | Type | Label | Description |
| peer | Peer |
|
|
| uid | int32 |
|
|
| typing_type | TypingType |
|
Update about user's typing stop
| Field | Type | Label | Description |
| peer | Peer |
|
|
| uid | int32 |
|
|
| typing_type | TypingType |
|
Update about user's last seen state
| Field | Type | Label | Description |
| uid | int32 |
|
|
| date | int64 |
|
|
| device_type | DeviceType |
|
|
| device_category | google.protobuf.StringValue |
|
Update about user became offline
| Field | Type | Label | Description |
| uid | int32 |
|
|
| device_type | DeviceType |
|
|
| device_category | google.protobuf.StringValue |
|
Update about user became online
| Field | Type | Label | Description |
| uid | int32 |
|
|
| device_type | DeviceType |
|
|
| device_category | google.protobuf.StringValue |
|
| Name | Number | Description |
| DEVICETYPE_UNKNOWN | 0 | |
| DEVICETYPE_GENERIC | 1 | |
| DEVICETYPE_PC | 2 | |
| DEVICETYPE_MOBILE | 3 | |
| DEVICETYPE_TABLET | 4 | |
| DEVICETYPE_WATCH | 5 | |
| DEVICETYPE_MIRROR | 6 | |
| DEVICETYPE_CAR | 7 | |
| DEVICETYPE_TABLE | 8 |
| Name | Number | Description |
| TYPINGTYPE_UNKNOWN | 0 | |
| TYPINGTYPE_TEXT | 1 |
| Method Name | Request Type | Response Type | Description |
| Typing | RequestTyping | ResponseVoid | |
| StopTyping | RequestStopTyping | ResponseVoid | |
| SetOnline | RequestSetOnline | ResponseVoid | |
| PauseNotifications | RequestPauseNotifications | ResponseVoid | |
| RestoreNotifications | RequestRestoreNotifications | ResponseVoid |
Available bot commands
| Field | Type | Label | Description |
| slash_command | string | Slash command name (wihtout slash) |
|
| description | string | Slash command description |
|
| loc_key | google.protobuf.StringValue | Optional Localization Key for i18n |
Contact information record
| Field | Type | Label | Description |
| type | ContactType |
|
|
| type_spec | google.protobuf.StringValue | Value for specification type of contact, for example 'mobile/standalone/office' for phones or 'vk/fb/telegram' for extenrnal networks. |
|
| string_value | google.protobuf.StringValue |
|
|
| long_value | google.protobuf.Int64Value |
|
|
| title | google.protobuf.StringValue |
|
|
| subtitle | google.protobuf.StringValue |
|
Full User representation - deprecated
| Field | Type | Label | Description |
| id | int32 | User's id |
|
| contact_info | ContactRecord | repeated |
|
| about | google.protobuf.StringValue |
|
|
| preferred_languages | string | repeated |
|
| time_zone | google.protobuf.StringValue | Time Zone of user in TZ format |
|
| bot_commands | BotCommand | repeated |
|
| is_blocked | google.protobuf.BoolValue |
|
|
| custom_profile | string | custom user profile info in JSON format |
|
| integration_token | google.protobuf.StringValue |
|
|
| status | UserStatus |
|
Renaming of user's visible name
| Field | Type | Label | Description |
| uid | int32 |
|
|
| access_hash | int64 |
|
|
| name | string |
|
Loading Full User information
| Field | Type | Label | Description |
| user_peers | UserOutPeer | repeated |
|
| Field | Type | Label | Description |
| full_users | FullUser | repeated |
|
Update about user's about changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| about | google.protobuf.StringValue |
|
Update about avatar changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| avatar | Avatar |
|
Update about bot commands changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| commands | BotCommand | repeated |
|
Update about contact information change
| Field | Type | Label | Description |
| uid | int32 |
|
|
| contact_records | ContactRecord | repeated |
|
Update about user custom profile changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| custom_profile | string | custom user profile info in JSON format |
| Field | Type | Label | Description |
| uid | int32 |
|
|
| ext | RecursiveMapValue |
|
| Field | Type | Label | Description |
| uid | int32 |
|
|
| ext | RecursiveMapValue |
|
Update about local name changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| local_name | google.protobuf.StringValue |
|
Update about name changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| name | string |
|
Update about nick changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| nickname | google.protobuf.StringValue |
|
Update about user's preferred languages
| Field | Type | Label | Description |
| uid | int32 |
|
|
| preferred_languages | string | repeated |
|
Update about user sex changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| sex | Sex |
|
Update about user status change
| Field | Type | Label | Description |
| uid | int32 |
|
|
| status | UserStatus |
|
User TimeZone changed
| Field | Type | Label | Description |
| uid | int32 |
|
|
| time_zone | google.protobuf.StringValue |
|
Main user object
| Field | Type | Label | Description |
| id | int32 | User's id |
|
| access_hash | int64 |
|
|
| name | string |
|
|
| local_name | google.protobuf.StringValue |
|
|
| nick | google.protobuf.StringValue |
|
|
| sex | Sex |
|
|
| avatar | Avatar |
|
|
| is_bot | google.protobuf.BoolValue |
|
User's status
| Field | Type | Label | Description |
| type | UserStatusType |
|
|
| text | google.protobuf.StringValue | Text supplied by user |
| Name | Number | Description |
| CONTACTTYPE_UNKNOWN | 0 | |
| CONTACTTYPE_PHONE | 1 | |
| CONTACTTYPE_EMAIL | 2 | |
| CONTACTTYPE_WEB | 3 | |
| CONTACTTYPE_SOCIAL | 4 |
| Name | Number | Description |
| SEX_UNKNOWN | 0 | |
| SEX_MALE | 2 | |
| SEX_FEMALE | 3 |
| Name | Number | Description |
| USERSTATUSTYPE_UNKNOWN | 0 | |
| USERSTATUSTYPE_UNSET | 1 | |
| USERSTATUSTYPE_AWAY | 2 | |
| USERSTATUSTYPE_DONOTDISTURB | 3 | |
| USERSTATUSTYPE_INVISIBLE | 4 |
| Method Name | Request Type | Response Type | Description |
| EditUserLocalName | RequestEditUserLocalName | ResponseSeq | |
| LoadFullUsers | RequestLoadFullUsers | ResponseLoadFullUsers | Deprecated |
Active Calls. Used in broadcasting states of current calls.
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| peer | Peer | Call's peer |
|
| call_members | CallMember | repeated | Call Members |
Sent by master
| Field | Type | Label | Description |
| server | ICEServer | repeated | a list of ICE servers |
| call_api_version | google.protobuf.Int32Value | a verison of the call signaling |
|
| call_name | google.protobuf.StringValue |
|
Peer advertisement
| Field | Type | Label | Description |
| device_id | int64 | device id of the peer |
|
| peer_settings | PeerSettings | settings for the peer |
|
| ice_servers | ICEServer | repeated | ice servers for the peer |
Advertizing self to a master mode
| Field | Type | Label | Description |
| peer_settings | PeerSettings | Optional peer Settings |
Answer signal
| Field | Type | Label | Description |
| session_id | int64 | Session Id of answer |
|
| sdp | string | Answer SDP |
This struct represents a call from the history
| Field | Type | Label | Description |
| id | int64 | call id |
|
| call_date | int64 |
|
|
| initiator | OutPeer |
|
|
| recipient | OutPeer |
|
|
| duration | google.protobuf.Int64Value |
|
|
| answered | google.protobuf.BoolValue | was the call answered by anybody |
|
| finished | google.protobuf.BoolValue |
|
|
| display_name | google.protobuf.StringValue | optional display name for this call |
|
| rejected | google.protobuf.BoolValue |
|
Call Member
| Field | Type | Label | Description |
| user_id | int32 | Member User Id |
|
| state | CallMemberStateHolder | State of member |
Call Member state holder
| Field | Type | Label | Description |
| state | CallMemberState | State Value |
|
| fallback_is_ringing | google.protobuf.BoolValue | Fallback flag for future compatibility of state |
|
| fallback_is_connected | google.protobuf.BoolValue | Fallback flag for future compatibility of state |
|
| fallback_is_connecting | google.protobuf.BoolValue | Fallback flag for future compatibility of state |
|
| fallback_is_ringing_reached | google.protobuf.BoolValue | Fallback flag for future compatibility of state |
|
| fallback_is_ended | google.protobuf.BoolValue | Fallback flag for future compatibility of state |
Used to notify participants about call name changes
| Field | Type | Label | Description |
| call_name | google.protobuf.StringValue |
|
Used to send call statistics to the server
| Field | Type | Label | Description |
| type | CallStatsType | the type of the event |
|
| value | string | the value of the event |
Candidate signal
| Field | Type | Label | Description |
| session_id | int64 | Session Id of candidate |
|
| index | int32 | Index of candidate |
|
| id | string | Id of candidate |
|
| sdp | string | SDP of candidate |
Close this session and be ready to
| Field | Type | Label | Description |
| device | int64 | Device Id |
|
| session_id | int64 | Session Id for renegotiation |
Emulates DTMF key press
| Field | Type | Label | Description |
| code | DTMFCode |
|
|
| duration | int64 | the duration (in milliseconds) |
Notification about enabling connection to peer
| Field | Type | Label | Description |
| device | int64 | Device Id |
|
| session_id | int64 | Session Id |
WebRTC IceCandidate add signal.
Used to let the other party know about new ICE candidate, usually from onIceCandidate callback of WebRTC
| Field | Type | Label | Description |
| session_id | int64 |
|
|
| candidate | ICECandidate |
|
Structure representing an ICE candidate
| Field | Type | Label | Description |
| sdp_m_line_index | int32 |
|
|
| sdp_mid | string |
|
|
| sdp | string |
|
ICE Server description
| Field | Type | Label | Description |
| url | string | Url to server |
|
| username | google.protobuf.StringValue | Optional username |
|
| credential | google.protobuf.StringValue | Optional credential |
Notification about requirement about required disconnection from peer
| Field | Type | Label | Description |
| device | int64 | Device Id |
Notification from master that offer is required
| Field | Type | Label | Description |
| device | int64 | Destination Device Id |
|
| session_id | int64 | Session Id |
|
| peer_settings | PeerSettings | Deprecated peer settings |
Notification about on negotiation is successful
| Field | Type | Label | Description |
| device | int64 | Device Id |
|
| session_id | int64 | Session Id |
Offer signal
| Field | Type | Label | Description |
| session_id | int64 | Session Id of offer |
|
| sdp | string | Offer SDP |
|
| peer_settings | PeerSettings | Deprecated Own Peer settings |
Need renegotiate session. For example when streams are changed.
| Field | Type | Label | Description |
| device | int64 | Device Id |
|
| session_id | int64 | Session Id |
Peer Settings
| Field | Type | Label | Description |
| can_pre_connect | google.protobuf.BoolValue | If peer can preconnect before answer |
|
| sends_offer | google.protobuf.BoolValue | The peer already has an offer. The server should request offer from this peer. |
|
| wait_for_candidates | google.protobuf.BoolValue | Peer prefers to receive an offer/answer with ICE candidates collected |
|
| client_info | ClientInfo | Description of this peer. Version, browser, OS, type, etc. |
WebRTC IceCandidate remove signal
Used to let the other party know about ICE candidate list change, usually from onIceCandidatesRemoved callback
| Field | Type | Label | Description |
| session_id | int64 |
|
|
| candidate | ICECandidate | repeated |
|
Changes the call display name
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| display_name | google.protobuf.StringValue |
|
| Field | Type | Label | Description |
| call_id | int64 |
|
Do Call. Right after a call client need to start sending CallInProgress
| Field | Type | Label | Description |
| peer | OutPeer |
|
|
| timeout | int64 |
|
Getting Call Information
| Field | Type | Label | Description |
| call_id | int64 |
|
Joining Call
| Field | Type | Label | Description |
| call_id | int64 |
|
Call this function to load call history
| Field | Type | Label | Description |
| next_offset | google.protobuf.BytesValue | Cursor |
|
| limit | int32 |
|
Rejecting Call
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| reason | RejectCallReason |
|
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| event_bus_id | string |
|
|
| device_id | int64 |
|
| Field | Type | Label | Description |
| peer | Peer |
|
|
| groups | GroupOutPeer | repeated |
|
| users | UserOutPeer | repeated |
|
| event_bus_id | string |
|
|
| display_name | google.protobuf.StringValue |
|
Calls + related peers
| Field | Type | Label | Description |
| calls | CallLogEntry | repeated |
|
| users | UserOutPeer | repeated |
|
| groups | GroupOutPeer | repeated |
|
| next_offset | google.protobuf.BytesValue |
|
Update about the call ending (all participants have left)
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| attempt_index | google.protobuf.Int32Value |
|
|
| reason | CallDisposedReason |
|
Update about incoming call handled
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| attempt_index | google.protobuf.Int32Value |
|
A new update about incoming call
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| event_bus_id | string |
|
|
| peer | Peer |
|
|
| display_name | google.protobuf.StringValue | Call visual name |
|
| attempt_index | google.protobuf.Int32Value |
|
|
| out_peer | OutPeer |
|
|
| video | bool |
|
Update about incoming call (Sent every 10 seconds)
| Field | Type | Label | Description |
| call_id | int64 |
|
|
| attempt_index | google.protobuf.Int32Value |
|
| Field | Type | Label | Description |
| advertiseSelf | AdvertiseSelf |
|
|
| advertiseMaster | AdvertiseMaster |
|
|
| advertisePeer | AdvertisePeer |
|
|
| candidate | Candidate |
|
|
| gotICECandidate | GotICECandidate |
|
|
| removedICECandidates | RemovedICECandidates |
|
|
| offer | Offer |
|
|
| answer | Answer |
|
|
| needOffer | NeedOffer |
|
|
| negotinationSuccessful | NegotinationSuccessful |
|
|
| enableConnection | EnableConnection |
|
|
| onRenegotiationNeeded | OnRenegotiationNeeded |
|
|
| closeSession | CloseSession |
|
|
| needDisconnect | NeedDisconnect |
|
|
| dTMF | DTMF |
|
|
| callStats | CallStats |
|
|
| callNameChanged | CallNameChanged |
|
| Name | Number | Description |
| CALLDISPOSEDREASON_UNKNOWN | 0 | |
| CALLDISPOSEDREASON_REJECTED | 1 | |
| CALLDISPOSEDREASON_BUSY | 2 | |
| CALLDISPOSEDREASON_ENDED | 3 | |
| CALLDISPOSEDREASON_ANSWER_TIMEOUT | 4 |
| Name | Number | Description |
| CALLMEMBERSTATE_UNKNOWN | 0 | |
| CALLMEMBERSTATE_RINGING | 1 | |
| CALLMEMBERSTATE_RINGING_REACHED | 4 | |
| CALLMEMBERSTATE_CONNECTING | 2 | |
| CALLMEMBERSTATE_CONNECTED | 3 | |
| CALLMEMBERSTATE_ENDED | 5 |
| Name | Number | Description |
| CALLSTATSTYPE_UNKNOWN | 0 | |
| CALLSTATSTYPE_TURN_SERVER_ROUND_TRIP_TIME | 1 | |
| CALLSTATSTYPE_ICE_CONNECTION_FAILED | 2 | |
| CALLSTATSTYPE_ICE_CONNECTION_CONNECTED | 3 | |
| CALLSTATSTYPE_ICE_CONNECTION_DID_NOT_CONNECT | 4 | |
| CALLSTATSTYPE_ICE_CONNECTION_CONNECTED_TIME | 5 | |
| CALLSTATSTYPE_PEER_CONNECTION_CREATE_ANSWER_FAILED | 6 | |
| CALLSTATSTYPE_PEER_CONNECTION_CREATE_OFFER_FAILED | 7 | |
| CALLSTATSTYPE_PEER_CONNECTION_SET_REMOTE_DESCRIPTION_FAILED | 8 | |
| CALLSTATSTYPE_PEER_CONNECTION_SET_LOCAL_DESCRIPTION_FAILED | 9 |
| Name | Number | Description |
| DTMFCODE_UNKNOWN | 0 | |
| DTMFCODE_ZERO | 1 | |
| DTMFCODE_ONE | 2 | |
| DTMFCODE_TWO | 3 | |
| DTMFCODE_THREE | 4 | |
| DTMFCODE_FOUR | 5 | |
| DTMFCODE_FIVE | 6 | |
| DTMFCODE_SIX | 7 | |
| DTMFCODE_SEVEN | 8 | |
| DTMFCODE_EIGHT | 9 | |
| DTMFCODE_NINE | 10 | |
| DTMFCODE_ASTERISK | 11 | |
| DTMFCODE_POUND | 12 | |
| DTMFCODE_A | 13 | |
| DTMFCODE_B | 14 | |
| DTMFCODE_C | 15 | |
| DTMFCODE_D | 16 |
| Name | Number | Description |
| REJECTCALLREASON_UNKNOWN | 0 | |
| REJECTCALLREASON_DECLINE | 1 | |
| REJECTCALLREASON_BUSY | 2 |
| Method Name | Request Type | Response Type | Description |
| GetCallInfo | RequestGetCallInfo | ResponseGetCallInfo | |
| LoadCalls | RequestLoadCalls | ResponseLoadCalls | |
| DoCall | RequestDoCall | ResponseDoCall | |
| JoinCall | RequestJoinCall | ResponseVoid | |
| RejectCall | RequestRejectCall | ResponseVoid | |
| ChangeCallDisplayName | RequestChangeCallDisplayName | ResponseVoid | |
| DeleteCall | RequestDeleteCall | ResponseVoid |
| .proto Type | Notes | C++ Type | Java Type | Python Type |
| double | double | double | float | |
| float | float | float | float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
| sfixed32 | Always four bytes. | int32 | int | int |
| sfixed64 | Always eight bytes. | int64 | long | int/long |
| bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |