Skip to main content
POST
social.connect.telegram.code.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
code
string
required

The pairing code from social.connect.telegram.code.create.

Required string length: 1 - 128

Response

The result

status
enum<string>
required

pending while the person has not sent the code; expired when it ran out.

Available options:
pending,
connected,
expired
expiresAt
string

When the code expires (pending and expired).

expiresIn
integer

Seconds until it expires.

Required range: -9007199254740991 <= x <= 9007199254740991
accountId
string

The connected account, when connected.

platform
string

Lowercase platform name (connected).

handle
string

Account handle without the @ (connected).

displayName
string

Display name (connected).

chatId
string

The connected chat's id (connected).

chatTitle
string

The chat's title (connected).

chatType
string

channel, group or supergroup (connected).

message
string

The platform's note (expired).