Accounts & connections · Account Settings

Get TG bot commands

Fetches TG bot commands.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/telegram-commands
Coming soongetTelegramCommands

Telegram is coming soon. Telegram accounts cannot be connected yet: GET /v1/connect/telegram returns 403 feature_not_available, so this endpoint has no account to act on for now.

Guides: Telegram, Conversation starters

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/telegram-commands" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • dataarray of object
    • commandstring

      1 to 32 characters. Matches ^[a-z0-9_]+$.

    • descriptionstring

      1 to 256 characters.

200 response
{
  "data": [
    {
      "command": "string",
      "description": "A short description"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Account Settings