Open chats yourself
Let up to 500 fans chat with one of the creator’s Telegram accounts without us having seen them pay.
Questions? [email protected]
Let up to 500 fans chat with one of the creator’s Telegram accounts without us having seen them pay.
Questions? [email protected]
/api/external/v1/chat-gate/fans/openalso served at /api/external/chat-gate/fans/openNewLet up to 500 fans chat with one of the creator’s Telegram accounts without us having seen them pay.
Use it for a drop link paid in a browser, where we can’t tie the payment to the fan’s Telegram, and for chats that were already open in your app when you moved its gate to us.
It counts in Pay to Chat only; a subscription is what opens Sub to Chat. With payScope: "ONCE" the chat is open for good, with PER_CONVERSATION until you end the conversation. Such a fan reads status: "opened".
Each fan comes back with clearedAsk (an ask of your bot stood in that chat and is now forgotten) and unpinMessageId (its pinned message, to take down). No chat.unlocked follows, so on clearedAsk tell the fan they are in.
Send the creator's API key as a bearer token: Authorization: Bearer dpfn_…. See Authentication & API keys.
For a creator you manage or onboarded
POST /api/external/v1/creators/{creatorId}/chat-gate/fans/open — an agency's own key for a creator or AI persona it manages (needs canManageDrops), or your app owner's own key for an account your app onboarded. The X-Dropfans-Account header still works but is deprecated. See Acting for a creator.
Content type: application/json
| Name | Type | Required | Description |
|---|---|---|---|
account | string | Required | Telegram user id of the creator’s account (the business connection’s user.id). |
fans | string[] | Required | Telegram user ids, 1 to 500. |
{
"account": "5550001111",
"fans": [
"48213377",
"48213378"
]
}| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account | string | Telegram user id. | |||||||||||||||
mode | string | Who may chat: everyone, fans who paid (tip or drop) or subscribed, or subscribers only. One of: EVERYONE, PAY, SUB | |||||||||||||||
payScope | string | Pay to Chat: ONCE = paid once, open for good; PER_CONVERSATION = a conversation can be ended and the fan pays again.One of: ONCE, PER_CONVERSATION | |||||||||||||||
fans | object[] | Per fan.Show child attributes
|
{
"account": "5550001111",
"mode": "PAY",
"payScope": "PER_CONVERSATION",
"fans": [
{
"fan": "48213377",
"status": "opened",
"locked": false,
"clearedAsk": true,
"unpinMessageId": 4211
},
{
"fan": "48213378",
"status": "subscribed",
"locked": false,
"clearedAsk": false,
"unpinMessageId": null
}
]
}| Status | Body | When |
|---|---|---|
| 400 | {"error":"account must be a Telegram user id (digits, as a string)","code":"invalid_telegram_id"} | `account` is missing or not a Telegram user id. |
| 400 | {"error":"fans must be a list of 1 to 500 Telegram user ids","code":"invalid_request"} | No fans, too many, or one isn’t an id. |
| 401 | {"error":"Unauthorized","code":"unauthorized"} | Missing or invalid API key. |
| 403 | {"error":"This endpoint needs a key bound to an app with the chat_gate API category enabled — personal keys cannot use it.","code":"app_key_required","category":"chat_gate"} | A personal key: the chat gate answers back through app webhooks. |
| 409 | {"error":"The chat gate is for creator accounts.","code":"not_a_creator"} | The account is a fan account, suspended or banned. |
| 503 | {"error":"The chat gate is not available right now. Let the message through.","code":"unavailable"} | Something failed on our side. Fail open: let the message stand. |
| 400 | {"error":"X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.","code":"invalid_account_header"} | `X-Dropfans-Account` is not an account id. |
| 400 | {"error":"X-Dropfans-Account names a different account than the path — send one or the other.","code":"account_mismatch"} | Called under /v1/creators/{creatorId}/ with an `X-Dropfans-Account` naming another account. |
| 403 | {"error":"This key cannot act for that account.","code":"account_not_managed"} | The creator in the path (or `X-Dropfans-Account`) is one this key cannot act for: no ACCEPTED management by your agency and not an account your app onboarded (or it no longer holds a key bound to your app), a key minted for one creator, or someone is suspended, banned or deleted. An unknown id gets the same answer. |
| 403 | {"error":"The agency does not have permission for this on that account.","code":"permission_denied","permission":"canManageDrops"} | For a managed creator: the agency lacks `canManageDrops` on that account. |
| 403 | {"error":"This app does not have the chat_gate API category enabled. Contact support to enable it.","code":"api_category_disabled","category":"chat_gate"} | Your app has the Pay to Chat [API category](/developers/concepts/api-categories) switched off (the default for new apps). |
Every response carries the X-RateLimit-Tier header and, on limited tiers, the per-minute and per-day trios — read X-RateLimit-Remaining and X-RateLimit-Reset instead of hardcoding limits. Details in Rate limits.
curl -X POST "https://www.dropfans.io/api/external/v1/chat-gate/fans/open" \
-H "Authorization: Bearer $DROPFANS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account": "5550001111",
"fans": [
"48213377",
"48213378"
]
}'const res = await fetch(`https://www.dropfans.io/api/external/v1/chat-gate/fans/open`, {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"account": "5550001111",
"fans": [
"48213377",
"48213378"
]
}),
});
console.log(await res.json());import os
import requests
res = requests.post(
"https://www.dropfans.io/api/external/v1/chat-gate/fans/open",
headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
json={
"account": "5550001111",
"fans": [
"48213377",
"48213378",
],
},
)
print(res.json())