Skip to main content
GET
/
api
/
updates
/
poll
Poll for updates
curl --request GET \
  --url http://localhost:8080/api/updates/poll \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "result": [
    {
      "update_id": 100000001,
      "message": {
        "message_id": 42,
        "text": "Hello"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key with bmx_ prefix. Obtain via /api/auth/api-keys.

Query Parameters

​
bot_id
integer
required

Bot ID to poll updates for

​
offset
integer
default:0

Acknowledge updates with update_id < offset (Telegram getUpdates semantics)

​
limit
integer
default:100

Maximum number of updates to return

Required range: x <= 100
​
timeout
integer
default:30

Seconds to wait for updates before returning empty result

Required range: x <= 60

Response

Telegram-compatible getUpdates response

Telegram-compatible getUpdates response

​
ok
boolean
Example:

true

​
result
object[]