Integration, Telegram Embedded Banner

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

Parameter	Type	Required	Description
ip	String	Yes	User IP address (IPv4/IPv6 supported)
user_agent	String	Yes	User agent string
publisher_id	String	Yes	Publisher ID
language_code	String	No	User language in ISO alpha-2 format
widget_id	String	No	Mini App ID
telegram_id	String	No	Telegram user ID number
bid_floor	Double	No	Minimum bid (CPC/CPM based on SSP config)
number_of_bids	Integer	No	Number of bids to return (default: 1)
blocked_categories	Integer[]	No	List of blocked advertiser category IDs
premium	Boolean	No	Premium user flag (default: false)
motivated	Boolean	No	Indicates motivated user action
production	Boolean	No	Indicates whether the request is made in production mode. false is used for initial tests to ensure that ssp is integrated correctly. Test responses will be returned in this case. true is used if not specified

Response Sample

[
   {
"image":"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",   "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
   },
   {      "image":"https://us.boxif.xyz/nty/metrics/save.img?event=impressions&bid-id=v2-1728914821764-14-14065-1373881-068d4342-f9af-e153-437b-430ef038d5b5&img=https%3A%2F%2Fcdn.amnew.net%2Ffiles%2F66d6d40333b3b_2024_09_03_09_16_51_image.webp",
      "link":"https://us.boxif.xyz/nty/postback/click?key=v2-1728914821764-14-14065-1373881-068d4342-f9af-e153-437b-430ef038d5b5",
      "bid_price":0.0000093,
      "width": 150,
      "height": 100
   }
]

Response JSON Attributes

Parameter	Type	Description
image	String	Link to creative banner
link	String	Click URL
bid_price	Double	Bid price expressed in CPC or CPM depending on SSP configuration
width	Integer	Banner width in pixels
height	Integer	Banner height in pixels