SSP Integration Telegram Interstitial

Request Telegram integration is implemented with a POST request containing a JSON object in its body.

POST http://{ssp_id}.xml.adx1.com/telegram-bid

The Simplest Request Body Sample

{
 "ip": "192.112.192.11",
 "user_agent": "Mozilla/5.0 (Linux, Android 14; K) AppleWebKit/537.36 (KHTML, lke Gecko) Chrome/129.0.6668.81 Mobile Safari/537.36 Telegram-Android/11.2.0 (Google Pixel 6; Android 14; SDK 34; HIGH)",
 "publisher_id": "792361"
}

Full Request Body Sample

{
 "ip": "192.112.192.11",
 "user_agent":"Mozilla/5.0 (Linux, Android 14; K) AppleWebKit/537.36 (KHTML, lke Gecko) Chrome/129.0.6668.81 Mobile Safari/537.36 Telegram-Android/11.2.0 (Google Pixel 6; Android 14; SDK 34; HIGH)",
 "publisher_id":"792361",
 "widget_id":"351352",
 "bid_floor":0.0001,
 "premium": true,
 "motivated": true,
 "language_code":"en",
 "telegram_id": "515279737",
 "blocked_categories": [18, 30],
 "number_of_bids": 3,
 "width": 150,
 "height": 100,
 "production": true
}

Request JSON Attributes

API Request Parameters

Mandatory Parameters

Parameter	Type	Description
ip	String	User's IP address (supports both IPv4 and IPv6 formats)
user_agent	String	Full user agent string from the client's device/browser
publisher_id	String	Unique identifier for the publisher account

Optional Parameters

Parameter	Type	Default	Description
language_code	String	-	ISO 639-1 2-letter language code (e.g., "en", "es")
widget_id	String	-	Identifier for the Mini App making the request
telegram_id	String	-	User's Telegram identifier number
bid_floor	Double	-	Minimum acceptable bid price (value depends on SSP's configured pricing model - CPC or CPM)
number_of_bids	Integer	1	Number of bid responses desired (default returns single bid)
blocked_categories	Integer[]	-	Array of category IDs to exclude (see Category Reference)
premium	Boolean	false	Flag indicating premium user status
motivated	Boolean	-	Indicates if user action was motivated (e.g., clicked intentionally)
width	Integer	-	Creative width in pixels (required for sized requests)
height	Integer	-	Creative height in pixels (required for sized requests)
production	Boolean	true	Set to false for test mode (returns sample responses)

Usage Examples

Basic Request

{
  "ip": "203.0.113.45",
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
  "publisher_id": "pub_12345",
  "language_code": "en"
}

Response Sample

[
   {
      "title":"test",
      "message": "test",
"banner":"https://us.boxif.xyz/nty/metrics/save.img?event=impressions&bid-id=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4&img=https%3A%2F%2Fcdn.amnew.net%2Ffiles%2F66d6d40333b3b_2024_09_03_09_16_51_image.webp",
"icon":"https://us.boxif.xyz/nty/metrics/save.img?event=impressions&bid-id=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4&img=https%3A%2F%2Fcdn.amnew.net%2Ffiles%2F66d6d40333b3b_2024_09_03_09_16_51_icon.webp",
"image_preload":"https://cdn.amnew.net/files/66d6d40333b3b_2024_09_03_09_16_51_image.webp",
"notification_url":"https://us.boxif.xyz/nty/metrics/save?event=impressions&bid-id=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4",
"brand": "Brand Name",
"button": "Button Text",   "link":"https://us.boxif.xyz/nty/postback/click?key=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4",
      "bid_price":0.0000093,
      "width": 150,
      "height": 100
   },
   {
      "title":"test",
      "message": "test",
"banner":"https://us.boxif.xyz/nty/metrics/save.img?event=impressions&bid-id=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4&img=https%3A%2F%2Fcdn.amnew.net%2Ffiles%2F66d6d40333b3b_2024_09_03_09_16_51_image.webp",
"icon":"https://us.boxif.xyz/nty/metrics/save.img?event=impressions&bid-id=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4&img=https%3A%2F%2Fcdn.amnew.net%2Ffiles%2F66d6d40333b3b_2024_09_03_09_16_51_icon.webp",
"image_preload":"https://cdn.amnew.net/files/66d6d40333b3b_2024_09_03_09_16_51_image.webp",
"notification_url":"https://us.boxif.xyz/nty/metrics/save?event=impressions&bid-id=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4",
"brand": "Brand Name",
"button": "Button Text",  "link":"https://us.boxif.xyz/nty/postback/click?key=v2-1728914821764-14-14065-1373881-17047345-5c5c-bf4e-e314-fc908803c0a4",
      "bid_price":0.0000093,
      "width": 150,
      "height": 100
   }
]