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

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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

The body is of type object.

Response

The result

code
string
required

The pairing code: the person adds the bot to their channel or group as admin and sends it this code.

expiresAt
string
required

When the code expires.

botUsername
string
required

The bot to send the code to, without the @.

instructions
string[]
required

The pairing steps, as the platform states them.

expiresIn
integer

Seconds until the code expires.

Required range: -9007199254740991 <= x <= 9007199254740991