Telegram dashboard

SDK Reference · Resource

Telegram dashboard

Connect and configure the Telegram client dashboard.

getConnection()updateConnection()deleteConnection()createLink()

method

getConnection()

Get the Telegram dashboard connection

Returns connection state and bot details for the authenticated account.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.telegram.getConnection(options: TelegramDashboardGetConnectionOptions = {}): Promise<TelegramDashboardGetConnectionResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.telegram.getConnection();

Returns

TelegramConnectionResponse

The operation completed successfully.

typeTelegramConnectionResponse8fields

FieldTypeRequirementDescription

available

boolean

Required

—

status

string

Required

—

bot_username

string

Required

—

telegram_username

string

Optional

—

locale

string

Required

—

timezone

string

Required

—

linked_at

string

Optional

—

pending_expires_at

string

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.getConnectionWithResponse(options): Promise<ApiResponse<TelegramDashboardGetConnectionResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.telegram.get_connection(*, accept_language: str | Unset=UNSET) -> TelegramConnectionResponse

Asyncawait async_client.telegram.get_connection(*, accept_language: str | Unset=UNSET) -> TelegramConnectionResponse

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.telegram.get_connection()

Async example

result = await async_client.telegram.get_connection()

Returns

TelegramConnectionResponse

The operation completed successfully.

classTelegramConnectionResponse8fields

FieldTypeRequirementDescription

available

bool

Required

—

status

str

Required

—

bot_username

str

Required

—

locale

str

Required

—

timezone

str

Required

—

telegram_username

str

Optional

—

linked_at

datetime.datetime | None

Optional

—

pending_expires_at

datetime.datetime | None

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.get_connection_with_response(*, accept_language: str | Unset=UNSET) -> ApiResponse[TelegramConnectionResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->telegram()->getConnection($acceptLanguage = null, string $contentType = self::contentTypes['getConnection'][0])

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->telegram()->getConnection();

Returns

TelegramConnectionResponse

The operation completed successfully.

classTelegramConnectionResponse8fields

FieldTypeRequirementDescription

available

bool

Required

|

status

string

Required

|

botUsername

string

Required

|

telegramUsername

string

Required

| [optional]

locale

string

Required

|

timezone

string

Required

|

linkedAt

DateTime

Required

| [optional]

pendingExpiresAt

DateTime

Required

| [optional]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->telegram()->getConnectionWithResponse($acceptLanguage = null, string $contentType = self::contentTypes['getConnection'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->telegram()->getConnectionWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['getConnection'][0])

  Returns the OpenAPI Generator response tuple.

• $client->telegram()->getConnectionAsync($acceptLanguage = null, string $contentType = self::contentTypes['getConnection'][0])

  Returns a Guzzle promise for the decoded result.

• $client->telegram()->getConnectionAsyncWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['getConnection'][0])

  Returns a Guzzle promise for the response tuple.

• $client->telegram()->getConnectionRequest($acceptLanguage = null, string $contentType = self::contentTypes['getConnection'][0])

  Builds the PSR-7 request without sending it.

method

updateConnection()

Update Telegram dashboard preferences

Changes the language or timezone used by the Telegram dashboard.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.telegram.updateConnection(options: TelegramDashboardUpdateConnectionOptions = {}): Promise<TelegramDashboardUpdateConnectionResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	PatchedTelegramConnectionUpdateRequest	Optional	—

Example

const result = await client.telegram.updateConnection({
  body: {}
});

Returns

TelegramConnectionResponse

The operation completed successfully.

typeTelegramConnectionResponse8fields

FieldTypeRequirementDescription

available

boolean

Required

—

status

string

Required

—

bot_username

string

Required

—

telegram_username

string

Optional

—

locale

string

Required

—

timezone

string

Required

—

linked_at

string

Optional

—

pending_expires_at

string

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.updateConnectionWithResponse(options): Promise<ApiResponse<TelegramDashboardUpdateConnectionResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.telegram.update_connection(*, body: PatchedTelegramConnectionUpdateRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> TelegramConnectionResponse

Asyncawait async_client.telegram.update_connection(*, body: PatchedTelegramConnectionUpdateRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> TelegramConnectionResponse

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	PatchedTelegramConnectionUpdateRequest	Optional	—

Example

result = client.telegram.update_connection(
        body=models.PatchedTelegramConnectionUpdateRequest.from_dict({}),
    )

Async example

result = await async_client.telegram.update_connection(
        body=models.PatchedTelegramConnectionUpdateRequest.from_dict({}),
    )

Returns

TelegramConnectionResponse

The operation completed successfully.

classTelegramConnectionResponse8fields

FieldTypeRequirementDescription

available

bool

Required

—

status

str

Required

—

bot_username

str

Required

—

locale

str

Required

—

timezone

str

Required

—

telegram_username

str

Optional

—

linked_at

datetime.datetime | None

Optional

—

pending_expires_at

datetime.datetime | None

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.update_connection_with_response(*, body: PatchedTelegramConnectionUpdateRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[TelegramConnectionResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->telegram()->updateConnection($acceptLanguage = null, $patchedTelegramConnectionUpdateRequest = null, string $contentType = self::contentTypes['updateConnection'][0])

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
patchedTelegramConnectionUpdateRequest	PatchedTelegramConnectionUpdateRequest	Optional	—

Example

$result = $client->telegram()->updateConnection(
    patchedTelegramConnectionUpdateRequest: new Dto\PatchedTelegramConnectionUpdateRequest([]),
);

Returns

TelegramConnectionResponse

The operation completed successfully.

classTelegramConnectionResponse8fields

FieldTypeRequirementDescription

available

bool

Required

|

status

string

Required

|

botUsername

string

Required

|

telegramUsername

string

Required

| [optional]

locale

string

Required

|

timezone

string

Required

|

linkedAt

DateTime

Required

| [optional]

pendingExpiresAt

DateTime

Required

| [optional]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->telegram()->updateConnectionWithResponse($acceptLanguage = null, $patchedTelegramConnectionUpdateRequest = null, string $contentType = self::contentTypes['updateConnection'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->telegram()->updateConnectionWithHttpInfo($acceptLanguage = null, $patchedTelegramConnectionUpdateRequest = null, string $contentType = self::contentTypes['updateConnection'][0])

  Returns the OpenAPI Generator response tuple.

• $client->telegram()->updateConnectionAsync($acceptLanguage = null, $patchedTelegramConnectionUpdateRequest = null, string $contentType = self::contentTypes['updateConnection'][0])

  Returns a Guzzle promise for the decoded result.

• $client->telegram()->updateConnectionAsyncWithHttpInfo($acceptLanguage = null, $patchedTelegramConnectionUpdateRequest = null, string $contentType = self::contentTypes['updateConnection'][0])

  Returns a Guzzle promise for the response tuple.

• $client->telegram()->updateConnectionRequest($acceptLanguage = null, $patchedTelegramConnectionUpdateRequest = null, string $contentType = self::contentTypes['updateConnection'][0])

  Builds the PSR-7 request without sending it.

method

deleteConnection()

Disconnect the Telegram dashboard

Revokes the Telegram identity link and all future bot sessions.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.telegram.deleteConnection(options: TelegramDashboardDeleteConnectionOptions = {}): Promise<TelegramDashboardDeleteConnectionResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.telegram.deleteConnection();

Returns

void

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.deleteConnectionWithResponse(options): Promise<ApiResponse<TelegramDashboardDeleteConnectionResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.telegram.delete_connection(*, accept_language: str | Unset=UNSET) -> None

Asyncawait async_client.telegram.delete_connection(*, accept_language: str | Unset=UNSET) -> None

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.telegram.delete_connection()

Async example

result = await async_client.telegram.delete_connection()

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.delete_connection_with_response(*, accept_language: str | Unset=UNSET) -> ApiResponse[None]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->telegram()->deleteConnection($acceptLanguage = null, string $contentType = self::contentTypes['deleteConnection'][0])

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->telegram()->deleteConnection();

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->telegram()->deleteConnectionWithResponse($acceptLanguage = null, string $contentType = self::contentTypes['deleteConnection'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->telegram()->deleteConnectionWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['deleteConnection'][0])

  Returns the OpenAPI Generator response tuple.

• $client->telegram()->deleteConnectionAsync($acceptLanguage = null, string $contentType = self::contentTypes['deleteConnection'][0])

  Returns a Guzzle promise for the decoded result.

• $client->telegram()->deleteConnectionAsyncWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['deleteConnection'][0])

  Returns a Guzzle promise for the response tuple.

• $client->telegram()->deleteConnectionRequest($acceptLanguage = null, string $contentType = self::contentTypes['deleteConnection'][0])

  Builds the PSR-7 request without sending it.

method

createLink()

Create a Telegram account link

Creates a single-use, short-lived Telegram deep link for this account.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.telegram.createLink(options: TelegramDashboardCreateLinkOptions = {}): Promise<TelegramDashboardCreateLinkResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.telegram.createLink();

Returns

TelegramLinkResponse

The resource or action result was created successfully.

typeTelegramLinkResponse3fields

FieldTypeRequirementDescription

status

string

Required

—

bot_url

string

Required

—

expires_at

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.createLinkWithResponse(options): Promise<ApiResponse<TelegramDashboardCreateLinkResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.telegram.create_link(*, accept_language: str | Unset=UNSET) -> TelegramLinkResponse

Asyncawait async_client.telegram.create_link(*, accept_language: str | Unset=UNSET) -> TelegramLinkResponse

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.telegram.create_link()

Async example

result = await async_client.telegram.create_link()

Returns

TelegramLinkResponse

The resource or action result was created successfully.

classTelegramLinkResponse3fields

FieldTypeRequirementDescription

status

str

Required

—

bot_url

str

Required

—

expires_at

datetime.datetime

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.telegram.create_link_with_response(*, accept_language: str | Unset=UNSET) -> ApiResponse[TelegramLinkResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->telegram()->createLink($acceptLanguage = null, string $contentType = self::contentTypes['createLink'][0])

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->telegram()->createLink();

Returns

TelegramLinkResponse

The resource or action result was created successfully.

classTelegramLinkResponse3fields

FieldTypeRequirementDescription

status

string

Required

|

botUrl

string

Required

|

expiresAt

DateTime

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->telegram()->createLinkWithResponse($acceptLanguage = null, string $contentType = self::contentTypes['createLink'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->telegram()->createLinkWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['createLink'][0])

  Returns the OpenAPI Generator response tuple.

• $client->telegram()->createLinkAsync($acceptLanguage = null, string $contentType = self::contentTypes['createLink'][0])

  Returns a Guzzle promise for the decoded result.

• $client->telegram()->createLinkAsyncWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['createLink'][0])

  Returns a Guzzle promise for the response tuple.

• $client->telegram()->createLinkRequest($acceptLanguage = null, string $contentType = self::contentTypes['createLink'][0])

  Builds the PSR-7 request without sending it.