Recommend a Flat
recommend_configUse when the customer describes the trip instead of a speed: country (or up to 5), days and what will be connected (devices: phone, phone_laptop, small_group, family, creator_posting, creator_live, creator_hd_live, creator_pro). Picks the speed from the roamflat speed guide and returns it server-quoted together with the step below and the step above (where offered), each with price, networks, a one-line reason and its buy_url, plus trip totals and an optional budget check. A speed that needs 5G in a country without 5G falls back to the highest speed there and says so. Prices are the same as quote_flat. Give destination (one country) or destinations (several) — one of the two is required; a call without a country fails with invalid_argument.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | Yes | Days of mobile data (1–30). | |
| flat | No | Optional: which Flat of the country, as get_flats numbers them. Omit = the cheapest Flat that allows the speed. | |
| bucket | No | Optional language-region bucket the customer shops in, e.g. en-gb, de-de (sets currency and link locale). Defaults from language. | |
| budget | No | Optional budget for the whole trip in the quoted currency; options above it are marked. | |
| devices | No | phone = one phone (5 Mbps); phone_laptop = phone + laptop; small_group = a travel router for two or three devices; family = one travel router for the whole family; creator_posting = stories, reels, TikToks; creator_live = going live from the phone; creator_hd_live = Full HD live streams; creator_pro = multi-camera live and 4K uploads. Default phone. | |
| currency | No | Optional ISO 4217 override for prices. | |
| language | No | ISO language of the conversation, e.g. en, de, ja. Localizes country names and sets the language/currency of links and prices. | |
| networks | No | Optional: operator names from get_flats that must be included (the cheapest Flat holding all of them is used). Ignored when flat is given. | |
| destination | No | Country in ANY language or its ISO code, e.g. "Japan", "Japon", "jp". Map a city to its country first. One country per Flat. Required unless destinations is given. | |
| per_country | No | Optional days per country for a multi-country trip. | |
| destinations | No | Several countries (max 5), any language or ISO codes. Use instead of destination for a multi-country trip. Required unless destination is given. |