Skip to content

relaya-ru/sdk-php

BranchesTags

Repository files navigation

Relaya PHP SDK

API for Relaya integrations and management

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

Install from Packagist:

composer require relaya/sdk-php

For local development in this repository:

composer install

Laravel

The package supports Laravel auto-discovery.

Publish configuration (optional):

php artisan vendor:publish --tag=relaya-sdk-config

Then configure .env, for example:

RELAYA_API_TOKEN=your_token
RELAYA_API_BASE_URL=https://api.relaya.ru/v1

Quick Start (Facade)

<?php

use Relaya\RelayaApi;

RelayaApi::configure(accessToken: 'YOUR_ACCESS_TOKEN');
$result = RelayaApi::AccountApi()->getAccountModules();
print_r($result);

Alias:

<?php

use Relaya\Api;

$result = Api::AccountApi()->getAccountModules();

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/relaya-sdk-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: BearerAuth
$config = Relaya\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Relaya\Sdk\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAccountModules();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountModules: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.relaya.ru/v1

Class Method HTTP request Description
AccountApi getAccountModules GET /account/modules List account modules
AccountApi getAccountModulesUsage GET /account/modules/usage Get account module usage
AccountApi putAccountModulesModuleCode PUT /account/modules/{moduleCode} Update account module
AuthApi authOauthProviderCallbackGet GET /auth/oauth/{provider}/callback OAuth callback
AuthApi authOauthTelegramCompletePost POST /auth/oauth/telegram/complete OAuth Telegram complete
AuthApi getAuthOauthProviderStart GET /auth/oauth/{provider}/start Start OAuth authorization
AuthApi getAuthOauthProviders GET /auth/oauth/providers Get OAuth providers availability
AuthApi getProfilesProfileIdIntegrationsIntegrationAuthQr GET /profiles/{profileId}/integrations/{integration}/auth/qr Get auth QR
AuthApi getProfilesProfileIdIntegrationsIntegrationAuthQrStatus GET /profiles/{profileId}/integrations/{integration}/auth/qr/status Get QR auth status
AuthApi getProfilesProfileIdIntegrationsIntegrationToken GET /profiles/{profileId}/integrations/{integration}/token Get bot token
AuthApi getUsersExists GET /users/exists Check if user exists
AuthApi postAuthEmailVerifyConfirm POST /auth/email/verify/confirm Confirm email verification
AuthApi postAuthEmailVerifyRequest POST /auth/email/verify/request Request email verification code
AuthApi postAuthOauthPendingCompleteEmail POST /auth/oauth/pending/complete-email Complete OAuth with email
AuthApi postAuthPhoneTelegramConfirm POST /auth/phone/telegram/confirm Confirm Telegram phone verification
AuthApi postAuthPhoneTelegramStart POST /auth/phone/telegram/start Start Telegram phone verification
AuthApi postAuthTokens POST /auth/tokens Create authentication token
AuthApi postProfilesProfileIdIntegrationsIntegrationAuth2fa POST /profiles/{profileId}/integrations/{integration}/auth/2fa Submit 2FA password
AuthApi postProfilesProfileIdIntegrationsIntegrationAuthLogout POST /profiles/{profileId}/integrations/{integration}/auth/logout Logout profile
AuthApi postProfilesProfileIdIntegrationsIntegrationAuthPhoneCode POST /profiles/{profileId}/integrations/{integration}/auth/phone/code Confirm phone auth code
AuthApi postProfilesProfileIdIntegrationsIntegrationAuthPhonePassword POST /profiles/{profileId}/integrations/{integration}/auth/phone/password Submit phone auth password
AuthApi postProfilesProfileIdIntegrationsIntegrationAuthPhoneStart POST /profiles/{profileId}/integrations/{integration}/auth/phone/start Start phone auth
AuthApi postProfilesProfileIdIntegrationsIntegrationAuthSmsPoll POST /profiles/{profileId}/integrations/{integration}/auth/sms/poll Poll authorization
AuthApi postProfilesProfileIdIntegrationsIntegrationAuthSmsStart POST /profiles/{profileId}/integrations/{integration}/auth/sms/start Start SMS authorization
AuthApi postProfilesProfileIdIntegrationsIntegrationAuthSmsVerify POST /profiles/{profileId}/integrations/{integration}/auth/sms/verify Send authorization code
AuthApi postUsers POST /users Register new user
AuthApi profilesProfileIdIntegrationsIntegrationOauthCallbackGet GET /profiles/{profileId}/integrations/{integration}/oauth/callback VK OAuth callback
AuthApi putProfilesProfileIdIntegrationsIntegrationToken PUT /profiles/{profileId}/integrations/{integration}/token Set bot token
BillingApi billingProviderWebhookPost POST /billing/provider/webhook Billing provider webhook
BillingApi getBillingTopups GET /billing/topups List top-up intents
BillingApi getBillingTopupsTopupId GET /billing/topups/{topupId} Get top-up status
BillingApi getBillingTransactions GET /billing/transactions List transactions
BillingApi postBillingTopups POST /billing/topups Create top-up intent
BillingApi postBillingTopupsTopupIdRefresh POST /billing/topups/{topupId}/refresh Refresh top-up status from provider
ChatsApi deleteProfilesProfileIdIntegrationsIntegrationFoldersFolderId DELETE /profiles/{profileId}/integrations/{integration}/folders/{folderId} Delete MAX folder
ChatsApi getProfilesProfileIdIntegrationsIntegrationFolders GET /profiles/{profileId}/integrations/{integration}/folders List MAX folders
ChatsApi postProfilesProfileIdIntegrationsIntegrationChatsByIds POST /profiles/{profileId}/integrations/{integration}/chats/by-ids Get chats by IDs
ChatsApi postProfilesProfileIdIntegrationsIntegrationChatsSubscription POST /profiles/{profileId}/integrations/{integration}/chats/subscription Subscribe/unsubscribe chat updates
ChatsApi postProfilesProfileIdIntegrationsIntegrationFolders POST /profiles/{profileId}/integrations/{integration}/folders Create MAX folder
ChatsApi putProfilesProfileIdIntegrationsIntegrationFoldersOrder PUT /profiles/{profileId}/integrations/{integration}/folders/order Reorder MAX folders
DashboardApi getUsersMeDashboardSummary GET /users/me/dashboard-summary Get dashboard summary
InboxApi getProfilesProfileIdIntegrationsIntegrationInboxConversations GET /profiles/{profileId}/integrations/{integration}/inbox/conversations List inbox conversations
InboxApi getProfilesProfileIdIntegrationsIntegrationInboxMessages GET /profiles/{profileId}/integrations/{integration}/inbox/messages List inbox messages
InboxApi getUsersMeInboxConversations GET /users/me/inbox/conversations List omnichannel inbox conversations
InboxApi getUsersMeInboxMessages GET /users/me/inbox/messages List omnichannel inbox messages
InboxApi postProfilesProfileIdIntegrationsIntegrationInboxConversationsAction POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/action Inbox conversation action
InboxApi postProfilesProfileIdIntegrationsIntegrationInboxConversationsAvatar POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/avatar Inbox conversation avatar
InboxApi postProfilesProfileIdIntegrationsIntegrationInboxRead POST /profiles/{profileId}/integrations/{integration}/inbox/read Mark inbox read
InboxApi postUsersMeInboxConversationsAction POST /users/me/inbox/conversations/action Toggle omnichannel conversation action
InboxApi postUsersMeInboxConversationsAvatar POST /users/me/inbox/conversations/avatar Set omnichannel conversation avatar
InboxApi postUsersMeInboxConversationsTitle POST /users/me/inbox/conversations/title Set omnichannel conversation title
InboxApi postUsersMeInboxRead POST /users/me/inbox/read Mark omnichannel conversation as read
InboxApi postUsersMeInboxSend POST /users/me/inbox/send Send omnichannel inbox message
IntegrationsApi deleteProfilesProfileIdIntegrationsIntegrationSession DELETE /profiles/{profileId}/integrations/{integration}/session Clear integration session
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationAuthQr GET /profiles/{profileId}/integrations/{integration}/auth/qr Get auth QR
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationAuthQrStatus GET /profiles/{profileId}/integrations/{integration}/auth/qr/status Get QR auth status
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationInboxConversations GET /profiles/{profileId}/integrations/{integration}/inbox/conversations List inbox conversations
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationInboxMessages GET /profiles/{profileId}/integrations/{integration}/inbox/messages List inbox messages
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationOverview GET /profiles/{profileId}/integrations/{integration}/overview Get profile overview
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationSession GET /profiles/{profileId}/integrations/{integration}/session Get integration session
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationSessionChats GET /profiles/{profileId}/integrations/{integration}/session/chats Get integration chats
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationStatus GET /profiles/{profileId}/integrations/{integration}/status Get profile status
IntegrationsApi getProfilesProfileIdIntegrationsIntegrationToken GET /profiles/{profileId}/integrations/{integration}/token Get bot token
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationAuth2fa POST /profiles/{profileId}/integrations/{integration}/auth/2fa Submit 2FA password
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationAuthLogout POST /profiles/{profileId}/integrations/{integration}/auth/logout Logout profile
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationAuthPhoneCode POST /profiles/{profileId}/integrations/{integration}/auth/phone/code Confirm phone auth code
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationAuthPhonePassword POST /profiles/{profileId}/integrations/{integration}/auth/phone/password Submit phone auth password
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationAuthPhoneStart POST /profiles/{profileId}/integrations/{integration}/auth/phone/start Start phone auth
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationInboxConversationsAction POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/action Inbox conversation action
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationInboxConversationsAvatar POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/avatar Inbox conversation avatar
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationInboxRead POST /profiles/{profileId}/integrations/{integration}/inbox/read Mark inbox read
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationMessages POST /profiles/{profileId}/integrations/{integration}/messages Send message
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationMessagesDelete POST /profiles/{profileId}/integrations/{integration}/messages/delete Delete message
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationMessagesEdit POST /profiles/{profileId}/integrations/{integration}/messages/edit Edit message
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationMessagesForward POST /profiles/{profileId}/integrations/{integration}/messages/forward Forward message
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationMessagesHistory POST /profiles/{profileId}/integrations/{integration}/messages/history Get chat history
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationMessagesReply POST /profiles/{profileId}/integrations/{integration}/messages/reply Reply message
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationSessionEvents POST /profiles/{profileId}/integrations/{integration}/session/events Get integration events
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationSessionStart POST /profiles/{profileId}/integrations/{integration}/session/start Start integration session
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationSessionStop POST /profiles/{profileId}/integrations/{integration}/session/stop Stop integration session
IntegrationsApi postProfilesProfileIdIntegrationsIntegrationSync POST /profiles/{profileId}/integrations/{integration}/sync Sync integration profile
IntegrationsApi profilesProfileIdIntegrationsIntegrationMessagesFilesPost POST /profiles/{profileId}/integrations/{integration}/messages/files Upload file
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksCheckPost POST /profiles/{profileId}/integrations/{integration}/webhooks/check Check webhook endpoint
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksDlqGet GET /profiles/{profileId}/integrations/{integration}/webhooks/dlq List webhook DLQ
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksDlqRedrivePost POST /profiles/{profileId}/integrations/{integration}/webhooks/dlq/redrive Redrive webhook DLQ
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksGet GET /profiles/{profileId}/integrations/{integration}/webhooks List webhooks
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksIdDelete DELETE /profiles/{profileId}/integrations/{integration}/webhooks/{id} Delete webhook
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksIdGet GET /profiles/{profileId}/integrations/{integration}/webhooks/{id} Get webhook
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksIdPatch PATCH /profiles/{profileId}/integrations/{integration}/webhooks/{id} Update webhook
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksIdTestPost POST /profiles/{profileId}/integrations/{integration}/webhooks/{id}/test Test webhook
IntegrationsApi profilesProfileIdIntegrationsIntegrationWebhooksPost POST /profiles/{profileId}/integrations/{integration}/webhooks Create webhook
IntegrationsApi putProfilesProfileIdIntegrationsIntegrationSession PUT /profiles/{profileId}/integrations/{integration}/session Set integration session
IntegrationsApi putProfilesProfileIdIntegrationsIntegrationToken PUT /profiles/{profileId}/integrations/{integration}/token Set bot token
MaxApi deleteProfilesProfileIdIntegrationsIntegrationFoldersFolderId DELETE /profiles/{profileId}/integrations/{integration}/folders/{folderId} Delete MAX folder
MaxApi deleteProfilesProfileIdIntegrationsIntegrationMessagesReactions DELETE /profiles/{profileId}/integrations/{integration}/messages/reactions Remove reaction
MaxApi getProfilesProfileIdIntegrationsIntegrationContacts GET /profiles/{profileId}/integrations/{integration}/contacts List contacts
MaxApi getProfilesProfileIdIntegrationsIntegrationContactsBlocked GET /profiles/{profileId}/integrations/{integration}/contacts/blocked List blocked contacts
MaxApi getProfilesProfileIdIntegrationsIntegrationDevices GET /profiles/{profileId}/integrations/{integration}/devices List active MAX devices
MaxApi getProfilesProfileIdIntegrationsIntegrationFolders GET /profiles/{profileId}/integrations/{integration}/folders List MAX folders
MaxApi getProfilesProfileIdIntegrationsIntegrationSessions GET /profiles/{profileId}/integrations/{integration}/sessions List active MAX sessions/devices
MaxApi getProfilesProfileIdIntegrationsIntegrationSettings GET /profiles/{profileId}/integrations/{integration}/settings Get settings
MaxApi getProfilesProfileIdIntegrationsIntegrationSettingsUser GET /profiles/{profileId}/integrations/{integration}/settings/user Get MAX account settings
MaxApi patchProfilesProfileIdIntegrationsIntegrationAccountProfile PATCH /profiles/{profileId}/integrations/{integration}/account/profile Update MAX profile name/description
MaxApi patchProfilesProfileIdIntegrationsIntegrationSettings PATCH /profiles/{profileId}/integrations/{integration}/settings Update settings
MaxApi patchProfilesProfileIdIntegrationsIntegrationSettingsUser PATCH /profiles/{profileId}/integrations/{integration}/settings/user Update MAX account settings
MaxApi postProfilesProfileIdIntegrationsIntegrationAuthSmsPoll POST /profiles/{profileId}/integrations/{integration}/auth/sms/poll Poll authorization
MaxApi postProfilesProfileIdIntegrationsIntegrationAuthSmsStart POST /profiles/{profileId}/integrations/{integration}/auth/sms/start Start SMS authorization
MaxApi postProfilesProfileIdIntegrationsIntegrationAuthSmsVerify POST /profiles/{profileId}/integrations/{integration}/auth/sms/verify Send authorization code
MaxApi postProfilesProfileIdIntegrationsIntegrationChatsByIds POST /profiles/{profileId}/integrations/{integration}/chats/by-ids Get chats by IDs
MaxApi postProfilesProfileIdIntegrationsIntegrationChatsSubscription POST /profiles/{profileId}/integrations/{integration}/chats/subscription Subscribe/unsubscribe chat updates
MaxApi postProfilesProfileIdIntegrationsIntegrationContactsByIds POST /profiles/{profileId}/integrations/{integration}/contacts/by-ids Get contacts by IDs
MaxApi postProfilesProfileIdIntegrationsIntegrationContactsLastOnline POST /profiles/{profileId}/integrations/{integration}/contacts/last-online Get contacts last online by IDs
MaxApi postProfilesProfileIdIntegrationsIntegrationContactsSearch POST /profiles/{profileId}/integrations/{integration}/contacts/search Search contact by phone
MaxApi postProfilesProfileIdIntegrationsIntegrationFolders POST /profiles/{profileId}/integrations/{integration}/folders Create MAX folder
MaxApi postProfilesProfileIdIntegrationsIntegrationMessagesReactions POST /profiles/{profileId}/integrations/{integration}/messages/reactions Send reaction
MaxApi postProfilesProfileIdIntegrationsIntegrationMessagesRead POST /profiles/{profileId}/integrations/{integration}/messages/read Mark chat read
MaxApi postProfilesProfileIdIntegrationsIntegrationMessagesTyping POST /profiles/{profileId}/integrations/{integration}/messages/typing Send typing status
MaxApi postProfilesProfileIdIntegrationsIntegrationMessagesUnread POST /profiles/{profileId}/integrations/{integration}/messages/unread Mark chat as unread
MaxApi postProfilesProfileIdIntegrationsIntegrationReboot POST /profiles/{profileId}/integrations/{integration}/reboot Reboot profile
MaxApi postProfilesProfileIdIntegrationsIntegrationVideosResolve POST /profiles/{profileId}/integrations/{integration}/videos/resolve Resolve video links by video ID
MaxApi profilesProfileIdIntegrationsIntegrationAvatarPost POST /profiles/{profileId}/integrations/{integration}/avatar Set profile picture
MaxApi putProfilesProfileIdIntegrationsIntegrationFoldersOrder PUT /profiles/{profileId}/integrations/{integration}/folders/order Reorder MAX folders
MessagesApi deleteProfilesProfileIdIntegrationsIntegrationMessagesReactions DELETE /profiles/{profileId}/integrations/{integration}/messages/reactions Remove reaction
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessages POST /profiles/{profileId}/integrations/{integration}/messages Send message
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesDelete POST /profiles/{profileId}/integrations/{integration}/messages/delete Delete message
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesEdit POST /profiles/{profileId}/integrations/{integration}/messages/edit Edit message
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesForward POST /profiles/{profileId}/integrations/{integration}/messages/forward Forward message
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesHistory POST /profiles/{profileId}/integrations/{integration}/messages/history Get chat history
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesReactions POST /profiles/{profileId}/integrations/{integration}/messages/reactions Send reaction
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesRead POST /profiles/{profileId}/integrations/{integration}/messages/read Mark chat read
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesReply POST /profiles/{profileId}/integrations/{integration}/messages/reply Reply message
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesTyping POST /profiles/{profileId}/integrations/{integration}/messages/typing Send typing status
MessagesApi postProfilesProfileIdIntegrationsIntegrationMessagesUnread POST /profiles/{profileId}/integrations/{integration}/messages/unread Mark chat as unread
MessagesApi postProfilesProfileIdIntegrationsIntegrationVideosResolve POST /profiles/{profileId}/integrations/{integration}/videos/resolve Resolve video links by video ID
MessagesApi profilesProfileIdIntegrationsIntegrationMessagesFilesPost POST /profiles/{profileId}/integrations/{integration}/messages/files Upload file
ModulesApi getAccountModules GET /account/modules List account modules
ModulesApi getAccountModulesUsage GET /account/modules/usage Get account module usage
ModulesApi putAccountModulesModuleCode PUT /account/modules/{moduleCode} Update account module
NotificationsApi getNotifications GET /notifications List notifications
NotificationsApi getNotificationsUnread GET /notifications/unread Get unread count
NotificationsApi postNotificationsMarkAll POST /notifications/mark-all Mark all as read
NotificationsApi postNotificationsMarkRead POST /notifications/mark-read Mark as read
ProfilesApi deleteProfilesProfileId DELETE /profiles/{profileId} Delete profile
ProfilesApi getProfiles GET /profiles List profiles
ProfilesApi getProfilesProfileId GET /profiles/{profileId} Get profile
ProfilesApi getProfilesProfileIdActions GET /profiles/{profileId}/actions Get profile actions
ProfilesApi getProfilesProfileIdIntegrationsIntegrationContacts GET /profiles/{profileId}/integrations/{integration}/contacts List contacts
ProfilesApi getProfilesProfileIdIntegrationsIntegrationContactsBlocked GET /profiles/{profileId}/integrations/{integration}/contacts/blocked List blocked contacts
ProfilesApi getProfilesProfileIdIntegrationsIntegrationOverview GET /profiles/{profileId}/integrations/{integration}/overview Get profile overview
ProfilesApi getProfilesProfileIdIntegrationsIntegrationStatus GET /profiles/{profileId}/integrations/{integration}/status Get profile status
ProfilesApi patchProfilesProfileId PATCH /profiles/{profileId} Update profile
ProfilesApi patchProfilesProfileIdIntegrationsIntegrationAccountProfile PATCH /profiles/{profileId}/integrations/{integration}/account/profile Update MAX profile name/description
ProfilesApi postProfiles POST /profiles Create profile
ProfilesApi postProfilesProfileIdIntegrationsIntegrationContactsByIds POST /profiles/{profileId}/integrations/{integration}/contacts/by-ids Get contacts by IDs
ProfilesApi postProfilesProfileIdIntegrationsIntegrationContactsLastOnline POST /profiles/{profileId}/integrations/{integration}/contacts/last-online Get contacts last online by IDs
ProfilesApi postProfilesProfileIdIntegrationsIntegrationContactsSearch POST /profiles/{profileId}/integrations/{integration}/contacts/search Search contact by phone
ProfilesApi postProfilesProfileIdIntegrationsIntegrationReboot POST /profiles/{profileId}/integrations/{integration}/reboot Reboot profile
ProfilesApi postProfilesProfileIdRenew POST /profiles/{profileId}/renew Renew profile
ProfilesApi profilesProfileIdIntegrationsIntegrationAvatarPost POST /profiles/{profileId}/integrations/{integration}/avatar Set profile picture
ProfilesApi putProfilesProfileIdAutoRenew PUT /profiles/{profileId}/auto-renew Update auto-renew
ScenariosApi usersMeScenariosGet GET /users/me/scenarios List account scenarios
ScenariosApi usersMeScenariosIdDelete DELETE /users/me/scenarios/{id} Delete account scenario
ScenariosApi usersMeScenariosPut PUT /users/me/scenarios Upsert account scenario
SessionsApi deleteProfilesProfileIdIntegrationsIntegrationSession DELETE /profiles/{profileId}/integrations/{integration}/session Clear integration session
SessionsApi deleteUsersMeSessionsSessionId DELETE /users/me/sessions/{sessionId} Revoke session
SessionsApi getProfilesProfileIdIntegrationsIntegrationDevices GET /profiles/{profileId}/integrations/{integration}/devices List active MAX devices
SessionsApi getProfilesProfileIdIntegrationsIntegrationSession GET /profiles/{profileId}/integrations/{integration}/session Get integration session
SessionsApi getProfilesProfileIdIntegrationsIntegrationSessionChats GET /profiles/{profileId}/integrations/{integration}/session/chats Get integration chats
SessionsApi getProfilesProfileIdIntegrationsIntegrationSessions GET /profiles/{profileId}/integrations/{integration}/sessions List active MAX sessions/devices
SessionsApi getUsersMeSessions GET /users/me/sessions List user sessions
SessionsApi postProfilesProfileIdIntegrationsIntegrationSessionEvents POST /profiles/{profileId}/integrations/{integration}/session/events Get integration events
SessionsApi postProfilesProfileIdIntegrationsIntegrationSessionStart POST /profiles/{profileId}/integrations/{integration}/session/start Start integration session
SessionsApi postProfilesProfileIdIntegrationsIntegrationSessionStop POST /profiles/{profileId}/integrations/{integration}/session/stop Stop integration session
SessionsApi postProfilesProfileIdIntegrationsIntegrationSync POST /profiles/{profileId}/integrations/{integration}/sync Sync integration profile
SessionsApi postUsersMeSessionsRevokeAll POST /users/me/sessions/revoke-all Revoke all sessions
SessionsApi postUsersMeSessionsRevokeOthers POST /users/me/sessions/revoke-others Revoke other sessions
SessionsApi putProfilesProfileIdIntegrationsIntegrationSession PUT /profiles/{profileId}/integrations/{integration}/session Set integration session
SettingsApi getProfilesProfileIdIntegrationsIntegrationSettings GET /profiles/{profileId}/integrations/{integration}/settings Get settings
SettingsApi getProfilesProfileIdIntegrationsIntegrationSettingsUser GET /profiles/{profileId}/integrations/{integration}/settings/user Get MAX account settings
SettingsApi patchProfilesProfileIdIntegrationsIntegrationSettings PATCH /profiles/{profileId}/integrations/{integration}/settings Update settings
SettingsApi patchProfilesProfileIdIntegrationsIntegrationSettingsUser PATCH /profiles/{profileId}/integrations/{integration}/settings/user Update MAX account settings
SystemApi docsGet GET /docs API reference
SystemApi getStatus GET /status Service status
TokensApi deleteUsersMeApiTokensId DELETE /users/me/api-tokens/{id} Revoke API token
TokensApi getUsersMeApiScopes GET /users/me/api-scopes List available API scopes
TokensApi getUsersMeApiTokens GET /users/me/api-tokens List API tokens
TokensApi postUsersMeApiTokens POST /users/me/api-tokens Create API token
TokensApi postUsersMeApiTokensIdRotate POST /users/me/api-tokens/{id}/rotate Rotate API token
UsersApi getUsersMe GET /users/me Get current user
UsersApi getUsersMeDashboardSummary GET /users/me/dashboard-summary Get dashboard summary
UsersApi getUsersMeInboxConversations GET /users/me/inbox/conversations List omnichannel inbox conversations
UsersApi getUsersMeInboxMessages GET /users/me/inbox/messages List omnichannel inbox messages
UsersApi postUsersMeInboxConversationsAction POST /users/me/inbox/conversations/action Toggle omnichannel conversation action
UsersApi postUsersMeInboxConversationsAvatar POST /users/me/inbox/conversations/avatar Set omnichannel conversation avatar
UsersApi postUsersMeInboxConversationsTitle POST /users/me/inbox/conversations/title Set omnichannel conversation title
UsersApi postUsersMeInboxRead POST /users/me/inbox/read Mark omnichannel conversation as read
UsersApi postUsersMeInboxSend POST /users/me/inbox/send Send omnichannel inbox message
UsersApi postUsersMePassword POST /users/me/password Change current user password
UsersApi usersMeScenariosGet GET /users/me/scenarios List account scenarios
UsersApi usersMeScenariosIdDelete DELETE /users/me/scenarios/{id} Delete account scenario
UsersApi usersMeScenariosPut PUT /users/me/scenarios Upsert account scenario
VkApi profilesProfileIdIntegrationsIntegrationOauthCallbackGet GET /profiles/{profileId}/integrations/{integration}/oauth/callback VK OAuth callback
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksCheckPost POST /profiles/{profileId}/integrations/{integration}/webhooks/check Check webhook endpoint
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksDlqGet GET /profiles/{profileId}/integrations/{integration}/webhooks/dlq List webhook DLQ
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksDlqRedrivePost POST /profiles/{profileId}/integrations/{integration}/webhooks/dlq/redrive Redrive webhook DLQ
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksGet GET /profiles/{profileId}/integrations/{integration}/webhooks List webhooks
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksIdDelete DELETE /profiles/{profileId}/integrations/{integration}/webhooks/{id} Delete webhook
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksIdGet GET /profiles/{profileId}/integrations/{integration}/webhooks/{id} Get webhook
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksIdPatch PATCH /profiles/{profileId}/integrations/{integration}/webhooks/{id} Update webhook
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksIdTestPost POST /profiles/{profileId}/integrations/{integration}/webhooks/{id}/test Test webhook
WebhooksApi profilesProfileIdIntegrationsIntegrationWebhooksPost POST /profiles/{profileId}/integrations/{integration}/webhooks Create webhook

Models

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-Profile-Token
  • Location: HTTP header

BearerAuth

  • Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: (devel)
    • Generator version: 7.20.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

Relaya MAX API PHP SDK

relaya.ru/

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 1

0.0.1 Latest
Mar 2, 2026

Contributors

Languages