Skip to main content
Module

x/periskope_maytapi_deno/index.ts>SessionControllingOperationsApi

periskope-org/maytapi-deno
Latest
class SessionControllingOperationsApi
import { SessionControllingOperationsApi } from "https://deno.land/x/periskope_maytapi_deno@v1.4.0/index.ts";

Constructors

new
SessionControllingOperationsApi(
configuration: Configuration,
requestFactory?: SessionControllingOperationsApiRequestFactory,
responseProcessor?: SessionControllingOperationsApiResponseProcessor,
)

Properties

private
api: ObservableSessionControllingOperationsApi

Methods

phoneIdBackupGet(phoneId: string, _options?: Configuration): Promise<BackupSuccess>

[DEPRECATED Multi-Device doesn't support this feature] Backups the material needed for opening the same chat screen for the current phone number. This call is useful when the session and also the status of the session is active. The response information can be used to open the chat screen with the POST restore call. If logout is called after getting the backup information, the data obtained from there will not be valid anymore. DEPRECATED Multi-Device doesn't support this feature.

phoneIdConfigGet(phoneId: string, _options?: Configuration): Promise<PhoneConfig>

Get phone specifig config for webhook and ack_delivery. If empty product webhook config would be used for delivery.

phoneIdConfigPost(
phoneId: string,
phoneIdConfigPostRequest: PhoneIdConfigPostRequest,
_options?: Configuration,
): Promise<PhoneConfig>

Set phone specifig config for webhook and ack_delivery. If empty product webhook config would be used for delivery. With this api you can define webhook for individual phones.

phoneIdDeleteGet(phoneId: string, _options?: Configuration): Promise<DeleteSuccess>

[DEPRECATED please use /factoryreset] Deletes the phone and closes the session of that number. DEPRECATED please use /factoryreset

phoneIdFactoryresetGet(phoneId: string, _options?: Configuration): Promise<JustSuccess>

Factory resets everything about phone instance to a new created instance state. This is a replacement for delete/create a new phone. Your phone instances can't be deleted anymore. This is implemented beacuse some of our customers were loosing their phone instance when their subscription(or trial) suspended. With the new system your phones would only set to disabled state and after you fix your subscription you can re-enable your phones either making a request(/screen etc.) to instance or from our control panel.

phoneIdLogoutGet(phoneId: string, _options?: Configuration): Promise<JustSuccess>

Logouts the number from the current session and converts the screen to qr-code screen.

phoneIdRedeployGet(phoneId: string, _options?: Configuration): Promise<PhoneIdRedeployGet200Response>

Redeploys docker instance of your phone. If your phone having any unexpected problems you can use this endpoint to reboot the instance.

phoneIdRestartGet(phoneId: string, _options?: Configuration): Promise<JustSuccess>

[DEPRECATED please use /redeploy] Restarts the session by refreshing the page. DEPRECATED please use /redeploy

phoneIdRestorePost(
phoneId: string,
backupData: BackupData,
_options?: Configuration,
): Promise<JustSuccess>

[DEPRECATED Multi-Device doesn't support this feature] Reloads the current session based on the reload data (can be obtained from POST backup). DEPRECATED Multi-Device doesn't support this feature.