{"info":{"name":"ChatVendor API","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":"Generated from https://chatvendor.net/docs/openapi.json"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{apiKey}}","type":"string"}]},"variable":[{"key":"baseUrl","value":"https://chatvendor.net/api/v1"},{"key":"apiKey","value":"cv_live_…"}],"item":[{"name":"SMS","item":[{"name":"Queue an SMS","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/messages","host":["{{baseUrl}}"],"path":["messages"]},"body":{"mode":"raw","raw":"{\n    \"to\": \"+998901234567\",\n    \"message\": \"Your code is 483921\",\n    \"device_id\": \"\",\n    \"sim_id\": \"\",\n    \"priority\": \"\",\n    \"client_reference\": \"\",\n    \"schedule_at\": \"\",\n    \"expires_in\": 0,\n    \"callback_url\": \"\",\n    \"consent_category\": \"\",\n    \"default_region\": \"\"\n}"}}},{"name":"List SMS messages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/messages","host":["{{baseUrl}}"],"path":["messages"]}}},{"name":"SMS status and timeline","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/messages/:message","host":["{{baseUrl}}"],"path":["messages",":message"]}}},{"name":"Cancel a queued SMS","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/messages/:message/cancel","host":["{{baseUrl}}"],"path":["messages",":message","cancel"]}}},{"name":"List paired phones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/devices","host":["{{baseUrl}}"],"path":["devices"]}}},{"name":"One device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/devices/:device","host":["{{baseUrl}}"],"path":["devices",":device"]}}}]},{"name":"Webhooks","item":[{"name":"List webhook endpoints","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/webhooks","host":["{{baseUrl}}"],"path":["webhooks"]}}},{"name":"Create a webhook endpoint","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/webhooks","host":["{{baseUrl}}"],"path":["webhooks"]},"body":{"mode":"raw","raw":"{\n    \"url\": \"\",\n    \"events\": []\n}"}}},{"name":"Update a webhook endpoint","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/webhooks/:webhook","host":["{{baseUrl}}"],"path":["webhooks",":webhook"]}}},{"name":"Delete a webhook endpoint","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/webhooks/:webhook","host":["{{baseUrl}}"],"path":["webhooks",":webhook"]}}}]},{"name":"Telegram","item":[{"name":"Workspace, plan and number of channels","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/me","host":["{{baseUrl}}"],"path":["me"]}}},{"name":"Connected Telegram accounts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels","host":["{{baseUrl}}"],"path":["channels"]}}},{"name":"One channel","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id","host":["{{baseUrl}}"],"path":["channels",":id"]}}},{"name":"Chats of a channel","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs","host":["{{baseUrl}}"],"path":["channels",":id","dialogs"]}}},{"name":"Messages of a chat","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","messages"]}}},{"name":"Send a text message","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","messages"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"reply_to\": 0,\n    \"parse_mode\": \"\",\n    \"silent\": true,\n    \"schedule\": \"\"\n}"}}},{"name":"Send a file (multipart/form-data: file, caption, as=auto|document|voice)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/file","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","file"]}}},{"name":"Forward messages","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/forward","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","forward"]},"body":{"mode":"raw","raw":"{\n    \"ids\": [],\n    \"to_peer\": \"\",\n    \"drop_author\": true\n}"}}},{"name":"Delete messages","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/delete","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","delete"]},"body":{"mode":"raw","raw":"{\n    \"ids\": [],\n    \"revoke\": true\n}"}}},{"name":"Mark a chat as read","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/read","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","read"]}}},{"name":"Download media (?thumb=1 for a thumbnail)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/messages/:message/media","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","messages",":message","media"]}}},{"name":"User / group info","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/peers/:peer","host":["{{baseUrl}}"],"path":["channels",":id","peers",":peer"]}}},{"name":"Resolve @username, t.me link or phone to a peer","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/resolve","host":["{{baseUrl}}"],"path":["channels",":id","resolve"]}}},{"name":"Add a contact","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/contacts","host":["{{baseUrl}}"],"path":["channels",":id","contacts"]},"body":{"mode":"raw","raw":"{\n    \"phone\": \"\",\n    \"first_name\": \"\",\n    \"last_name\": \"\"\n}"}}},{"name":"Send an album (multipart/form-data: files[] 2–10, caption, reply_to, topic)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/album","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","album"]}}},{"name":"Send existing media by ref (sticker, saved GIF, media from any message)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/media","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","media"]},"body":{"mode":"raw","raw":"{\n    \"ref\": \"\",\n    \"caption\": \"\",\n    \"reply_to\": 0,\n    \"topic\": 0,\n    \"spoiler\": true,\n    \"schedule\": \"\"\n}"}}},{"name":"Press a bot keyboard button (by data, text or index)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/messages/:message/click","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","messages",":message","click"]},"body":{"mode":"raw","raw":"{\n    \"data\": \"\",\n    \"text\": \"\",\n    \"index\": 0\n}"}}},{"name":"Public t.me link of a channel/group message","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/messages/:message/link","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","messages",":message","link"]}}},{"name":"Comments under a post / replies in a topic","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/messages/:message/replies","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","messages",":message","replies"]}}},{"name":"Unread mentions (?reactions=1: unseen reactions to our messages)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/mentions","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","mentions"]}}},{"name":"Save the chat draft (empty text clears it)","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/dialogs/:peer/draft","host":["{{baseUrl}}"],"path":["channels",":id","dialogs",":peer","draft"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"reply_to\": 0,\n    \"topic\": 0\n}"}}},{"name":"Full-text search across all chats","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/search","host":["{{baseUrl}}"],"path":["channels",":id","search"]}}},{"name":"Translate text or messages with Telegram's translator","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/translate","host":["{{baseUrl}}"],"path":["channels",":id","translate"]},"body":{"mode":"raw","raw":"{\n    \"to\": \"\",\n    \"text\": \"\",\n    \"peer\": \"\",\n    \"ids\": []\n}"}}},{"name":"Link preview Telegram would attach to this text","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/preview","host":["{{baseUrl}}"],"path":["channels",":id","preview"]}}}]},{"name":"Contacts","item":[{"name":"Contact cards (tags, variables, points, referrals); id = Telegram account, wa_{id} or ig_{id}. Query: tag, q, var, limit, offset","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/contacts","host":["{{baseUrl}}"],"path":["channels",":id","contacts"]}}},{"name":"One contact card","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/contacts/:peer","host":["{{baseUrl}}"],"path":["channels",":id","contacts",":peer"]}}},{"name":"Change tags / variables / notes of a contact","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/contacts/:peer","host":["{{baseUrl}}"],"path":["channels",":id","contacts",":peer"]},"body":{"mode":"raw","raw":"{\n    \"tags\": [],\n    \"add_tags\": [],\n    \"remove_tags\": [],\n    \"vars\": {},\n    \"notes\": \"\"\n}"}}},{"name":"Add / deduct points (ref deduplicates)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/contacts/:peer/points","host":["{{baseUrl}}"],"path":["channels",":id","contacts",":peer","points"]},"body":{"mode":"raw","raw":"{\n    \"delta\": 0,\n    \"reason\": \"\",\n    \"ref\": \"\"\n}"}}},{"name":"Points leaderboard","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/leaderboard","host":["{{baseUrl}}"],"path":["channels",":id","leaderboard"]}}},{"name":"Tracked links ({{link:name}} placeholders) with click counts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/links","host":["{{baseUrl}}"],"path":["channels",":id","links"]}}},{"name":"Create / update a tracked link","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/links","host":["{{baseUrl}}"],"path":["channels",":id","links"]},"body":{"mode":"raw","raw":"{\n    \"name\": \"\",\n    \"url\": \"\",\n    \"tag\": \"\",\n    \"peer_id\": 0\n}"}}}]},{"name":"Telegram groups","item":[{"name":"Group members","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/:peer/members","host":["{{baseUrl}}"],"path":["channels",":id","chats",":peer","members"]}}},{"name":"Join a group or channel","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/join","host":["{{baseUrl}}"],"path":["channels",":id","chats","join"]},"body":{"mode":"raw","raw":"{\n    \"link\": \"\"\n}"}}},{"name":"Forum topics of a supergroup","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/:peer/topics","host":["{{baseUrl}}"],"path":["channels",":id","chats",":peer","topics"]}}},{"name":"Create a forum topic","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/:peer/topics","host":["{{baseUrl}}"],"path":["channels",":id","chats",":peer","topics"]},"body":{"mode":"raw","raw":"{\n    \"title\": \"\",\n    \"icon_color\": 0,\n    \"icon_emoji_id\": 0\n}"}}},{"name":"Rename / close / hide / pin a topic","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/:peer/topics/:topic","host":["{{baseUrl}}"],"path":["channels",":id","chats",":peer","topics",":topic"]},"body":{"mode":"raw","raw":"{\n    \"title\": \"\",\n    \"closed\": true,\n    \"hidden\": true,\n    \"pinned\": true\n}"}}},{"name":"Channel/supergroup switches (only the fields sent are applied)","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/:peer/settings","host":["{{baseUrl}}"],"path":["channels",":id","chats",":peer","settings"]},"body":{"mode":"raw","raw":"{\n    \"username\": \"\",\n    \"signatures\": true,\n    \"join_to_send\": true,\n    \"join_request\": true,\n    \"slowmode\": 0,\n    \"noforwards\": true,\n    \"discussion\": \"\",\n    \"reactions\": \"\",\n    \"history_hidden\": true,\n    \"forum\": true\n}"}}},{"name":"Invite links of a group/channel","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/:peer/invite-links","host":["{{baseUrl}}"],"path":["channels",":id","chats",":peer","invite-links"]}}},{"name":"Create an invite link","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/chats/:peer/invite-links","host":["{{baseUrl}}"],"path":["channels",":id","chats",":peer","invite-links"]},"body":{"mode":"raw","raw":"{\n    \"title\": \"\",\n    \"expire\": \"\",\n    \"usage_limit\": 0,\n    \"request_needed\": true\n}"}}}]},{"name":"Telegram more","item":[{"name":"Installed sticker sets","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/stickers/sets","host":["{{baseUrl}}"],"path":["channels",":id","stickers","sets"]}}},{"name":"Stickers of a set (each with a ref to send)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/stickers/sets/:name","host":["{{baseUrl}}"],"path":["channels",":id","stickers","sets",":name"]}}},{"name":"Saved GIFs (each with a ref to send)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/stickers/gifs","host":["{{baseUrl}}"],"path":["channels",":id","stickers","gifs"]}}},{"name":"Chat folders","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/folders","host":["{{baseUrl}}"],"path":["channels",":id","folders"]}}},{"name":"Create a chat folder","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/folders","host":["{{baseUrl}}"],"path":["channels",":id","folders"]},"body":{"mode":"raw","raw":"{\n    \"title\": \"\",\n    \"emoticon\": \"\",\n    \"include\": [],\n    \"exclude\": [],\n    \"contacts\": true,\n    \"non_contacts\": true,\n    \"groups\": true,\n    \"broadcasts\": true,\n    \"bots\": true,\n    \"exclude_muted\": true,\n    \"exclude_read\": true,\n    \"exclude_archived\": true\n}"}}},{"name":"Edit a chat folder","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/folders/:folder","host":["{{baseUrl}}"],"path":["channels",":id","folders",":folder"]}}},{"name":"Delete a chat folder","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/folders/:folder","host":["{{baseUrl}}"],"path":["channels",":id","folders",":folder"]}}},{"name":"Telegram Business settings (hours, location, greeting/away, intro, quick replies)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/business","host":["{{baseUrl}}"],"path":["channels",":id","business"]}}},{"name":"Quick-reply shortcuts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/business/quick-replies","host":["{{baseUrl}}"],"path":["channels",":id","business","quick-replies"]}}},{"name":"Add a message to a quick-reply shortcut (Premium)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/business/quick-replies","host":["{{baseUrl}}"],"path":["channels",":id","business","quick-replies"]},"body":{"mode":"raw","raw":"{\n    \"shortcut\": \"\",\n    \"text\": \"\"\n}"}}},{"name":"Send a quick reply to a chat","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/business/quick-replies/:shortcut/send","host":["{{baseUrl}}"],"path":["channels",":id","business","quick-replies",":shortcut","send"]},"body":{"mode":"raw","raw":"{\n    \"peer\": \"\"\n}"}}},{"name":"Business chat links (t.me/m/…)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/business/links","host":["{{baseUrl}}"],"path":["channels",":id","business","links"]}}},{"name":"Create a business chat link (Premium)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/business/links","host":["{{baseUrl}}"],"path":["channels",":id","business","links"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"title\": \"\"\n}"}}},{"name":"Passthrough to every connector endpoint (read): stars, gifts, calls, mini apps, secret chats, folders, stats… — see the connector catalogue in the docs","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/tg/:path","host":["{{baseUrl}}"],"path":["channels",":id","tg",":path"]}}},{"name":"Passthrough to every connector endpoint (write): JSON body or multipart; POST tg/raw {method, params} calls any TL method","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/tg/:path","host":["{{baseUrl}}"],"path":["channels",":id","tg",":path"]}}}]},{"name":"WhatsApp","item":[{"name":"WhatsApp: chats of a number","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/wa_:id/dialogs","host":["{{baseUrl}}"],"path":["channels","wa_:id","dialogs"]}}},{"name":"WhatsApp: messages of a chat (peer = phone in international format)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/wa_:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels","wa_:id","dialogs",":peer","messages"]}}},{"name":"WhatsApp: send text, an approved template, or reply buttons","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/wa_:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels","wa_:id","dialogs",":peer","messages"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"reply_to\": 0,\n    \"template\": \"\",\n    \"language\": \"\",\n    \"components\": [],\n    \"buttons\": []\n}"}}},{"name":"WhatsApp: send a file (multipart: file, caption, as=auto|document|voice)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/wa_:id/dialogs/:peer/file","host":["{{baseUrl}}"],"path":["channels","wa_:id","dialogs",":peer","file"]}}},{"name":"WhatsApp: mark the chat as read","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/wa_:id/dialogs/:peer/read","host":["{{baseUrl}}"],"path":["channels","wa_:id","dialogs",":peer","read"]}}},{"name":"WhatsApp: download media","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/wa_:id/dialogs/:peer/messages/:message/media","host":["{{baseUrl}}"],"path":["channels","wa_:id","dialogs",":peer","messages",":message","media"]}}},{"name":"WhatsApp: message templates of the number","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/wa_:id/templates","host":["{{baseUrl}}"],"path":["channels","wa_:id","templates"]}}}]},{"name":"Instagram","item":[{"name":"Instagram: Direct chats of the account (peer = IGSID; rows carry kind: comment | story_reply | story_mention)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/ig_:id/dialogs","host":["{{baseUrl}}"],"path":["channels","ig_:id","dialogs"]}}},{"name":"Instagram: messages of a chat","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/ig_:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels","ig_:id","dialogs",":peer","messages"]}}},{"name":"Instagram: send text or quick-reply buttons; reply_to + public_reply=true answers a comment row publicly, otherwise the first message to a commenter goes as a private reply","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/ig_:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels","ig_:id","dialogs",":peer","messages"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"buttons\": [],\n    \"reply_to\": 0,\n    \"public_reply\": true\n}"}}},{"name":"Instagram: send a file (multipart: file, caption, as=auto|document|voice)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/ig_:id/dialogs/:peer/file","host":["{{baseUrl}}"],"path":["channels","ig_:id","dialogs",":peer","file"]}}},{"name":"Instagram: mark seen","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/ig_:id/dialogs/:peer/read","host":["{{baseUrl}}"],"path":["channels","ig_:id","dialogs",":peer","read"]}}}]},{"name":"Messenger","item":[{"name":"Messenger (Facebook Page): chats (peer = PSID). Messages, file, read, media: the same paths as WhatsApp with fb_{id}","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/fb_:id/dialogs","host":["{{baseUrl}}"],"path":["channels","fb_:id","dialogs"]}}},{"name":"Messenger: send text (buttons = quick replies; reply_to + public_reply answers a comment in the thread)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/fb_:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels","fb_:id","dialogs",":peer","messages"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"reply_to\": 0,\n    \"buttons\": []\n}"}}}]},{"name":"Viber","item":[{"name":"Viber bot: chats (peer = local id; user ids are strings). Messages, file, read, media: the same paths as WhatsApp with vb_{id}","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/vb_:id/dialogs","host":["{{baseUrl}}"],"path":["channels","vb_:id","dialogs"]}}},{"name":"Viber: send text (buttons = reply keyboard, up to 24; a button may carry url)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/vb_:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels","vb_:id","dialogs",":peer","messages"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"buttons\": []\n}"}}}]},{"name":"Website chat","item":[{"name":"Website widget: visitor chats (peer = visitor id). Messages, file, read, media: the same paths as WhatsApp with web_{id}","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/web_:id/dialogs","host":["{{baseUrl}}"],"path":["channels","web_:id","dialogs"]}}},{"name":"Website widget: send text to a visitor (buttons render as chips; a button may carry url)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/web_:id/dialogs/:peer/messages","host":["{{baseUrl}}"],"path":["channels","web_:id","dialogs",":peer","messages"]},"body":{"mode":"raw","raw":"{\n    \"text\": \"\",\n    \"buttons\": []\n}"}}}]},{"name":"Bookings","item":[{"name":"Bookable services (duration, price)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/services","host":["{{baseUrl}}"],"path":["services"]}}},{"name":"Free time slots of a service on a date (?date=YYYY-MM-DD, Asia/Tashkent)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/services/:service/slots","host":["{{baseUrl}}"],"path":["services",":service","slots"]}}},{"name":"Bookings (filters: status, from, to, limit)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/bookings","host":["{{baseUrl}}"],"path":["bookings"]}}},{"name":"Book a slot (starts_at must be a free slot); channel_id + peer_id link it to a chat so reminders reach the customer","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/bookings","host":["{{baseUrl}}"],"path":["bookings"]},"body":{"mode":"raw","raw":"{\n    \"service_id\": 0,\n    \"starts_at\": \"\",\n    \"name\": \"\",\n    \"phone\": \"\",\n    \"note\": \"\",\n    \"channel_id\": \"\",\n    \"peer_id\": 0,\n    \"status\": \"\"\n}"}}},{"name":"Change status (confirmed / cancelled / done / no_show), move (starts_at) or note","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/bookings/:id","host":["{{baseUrl}}"],"path":["bookings",":id"]},"body":{"mode":"raw","raw":"{\n    \"status\": \"\",\n    \"starts_at\": \"\",\n    \"note\": \"\",\n    \"notify\": true\n}"}}}]},{"name":"Marketing","item":[{"name":"Saved audiences (segments) with rules and the cached size","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/segments","host":["{{baseUrl}}"],"path":["segments"]}}},{"name":"Count contacts for ad-hoc rules (tags_any, tags_none, vars, active_days, silent_days, purchased, min_points, has_phone, networks, lead_status…)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/segments/preview","host":["{{baseUrl}}"],"path":["segments","preview"]},"body":{"mode":"raw","raw":"{\n    \"rules\": {\n        \"tags_any\": \"vip\",\n        \"active_days\": 30\n    }\n}"}}},{"name":"Members of a segment (channel_id, peer_id, title, phone, tags, points); ?limit=&offset=","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/segments/:id/contacts","host":["{{baseUrl}}"],"path":["segments",":id","contacts"]}}},{"name":"Drip campaigns (entry rule, steps, enrolled)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns","host":["{{baseUrl}}"],"path":["campaigns"]}}},{"name":"A campaign with per-step / per-variant stats (sent, replied, converted) and enrolment counts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id","host":["{{baseUrl}}"],"path":["campaigns",":id"]}}},{"name":"Put a contact into the campaign now (the first step follows its day/hour rule)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/enrol","host":["{{baseUrl}}"],"path":["campaigns",":id","enrol"]},"body":{"mode":"raw","raw":"{\n    \"channel_id\": \"wa_12\",\n    \"peer_id\": \"998901234567\"\n}"}}},{"name":"Open reminders of the team (?done=1 for finished, ?all=1 for both)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tasks","host":["{{baseUrl}}"],"path":["tasks"]}}},{"name":"Create a reminder; channel_id + peer_id tie it to a chat, user_id assigns it","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tasks","host":["{{baseUrl}}"],"path":["tasks"]},"body":{"mode":"raw","raw":"{\n    \"title\": \"\",\n    \"due_at\": \"2026-10-01T09:00:00+05:00\",\n    \"note\": \"\",\n    \"user_id\": 0,\n    \"channel_id\": \"\",\n    \"peer_id\": \"\"\n}"}}},{"name":"Mark a reminder done (undo=true reopens)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tasks/:id/done","host":["{{baseUrl}}"],"path":["tasks",":id","done"]}}}]},{"name":"Sales","item":[{"name":"Products of the workspace (name, price, picture, category, stock)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shop/products","host":["{{baseUrl}}"],"path":["shop","products"]}}},{"name":"Orders (filters: status, peer_id, product_id, limit)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shop/orders","host":["{{baseUrl}}"],"path":["shop","orders"]}}},{"name":"Create an order for a contact and get the Payme / Click pay link; send=true posts it into the chat (gateway=telegram: a bot invoice paid with Stars or a provider token)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shop/orders","host":["{{baseUrl}}"],"path":["shop","orders"]},"body":{"mode":"raw","raw":"{\n    \"channel_id\": \"\",\n    \"peer_id\": 0,\n    \"product_id\": 0,\n    \"gateway\": \"\",\n    \"send\": true,\n    \"text\": \"\",\n    \"promo\": \"\"\n}"}}},{"name":"One order with its pay link","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shop/orders/:id","host":["{{baseUrl}}"],"path":["shop","orders",":id"]}}},{"name":"Mark an order paid by hand (fires payment_ok rules, tags, subscription clock)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shop/orders/:id/paid","host":["{{baseUrl}}"],"path":["shop","orders",":id","paid"]}}},{"name":"Cancel a pending order or refund a paid one (revokes tags/access)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shop/orders/:id/cancel","host":["{{baseUrl}}"],"path":["shop","orders",":id","cancel"]}}}]},{"name":"AI","item":[{"name":"AI analysis of a message photo/file","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/channels/:id/ai/analyze","host":["{{baseUrl}}"],"path":["channels",":id","ai","analyze"]},"body":{"mode":"raw","raw":"{\n    \"peer\": \"\",\n    \"message_id\": 0,\n    \"prompt\": \"\",\n    \"provider_id\": 0,\n    \"json_schema\": {}\n}"}}},{"name":"Chat completion with your own provider key","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/ai/chat","host":["{{baseUrl}}"],"path":["ai","chat"]},"body":{"mode":"raw","raw":"{\n    \"messages\": [],\n    \"system\": \"\",\n    \"provider_id\": 0,\n    \"max_tokens\": 0\n}"}}},{"name":"Your AI providers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/ai/providers","host":["{{baseUrl}}"],"path":["ai","providers"]}}}]},{"name":"Leads","item":[{"name":"List leads","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads","host":["{{baseUrl}}"],"path":["leads"]}}},{"name":"Create a lead (account_id may be a channel reference such as wa_12); amount = deal value for the pipeline","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads","host":["{{baseUrl}}"],"path":["leads"]},"body":{"mode":"raw","raw":"{\n    \"account_id\": \"\",\n    \"peer_id\": 0,\n    \"amount\": 0,\n    \"source\": \"\",\n    \"title\": \"\",\n    \"status\": \"\",\n    \"tags\": [],\n    \"score\": 0,\n    \"notes\": \"\"\n}"}}},{"name":"One lead","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads/:leadId","host":["{{baseUrl}}"],"path":["leads",":leadId"]}}},{"name":"Update a lead","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads/:leadId","host":["{{baseUrl}}"],"path":["leads",":leadId"]}}},{"name":"Delete a lead","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads/:leadId","host":["{{baseUrl}}"],"path":["leads",":leadId"]}}}]},{"name":"Scenarios","item":[{"name":"Scenario runs","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/scenario-runs","host":["{{baseUrl}}"],"path":["scenario-runs"]}}},{"name":"Approve, reject or cancel a run","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/scenario-runs/:runId/decide","host":["{{baseUrl}}"],"path":["scenario-runs",":runId","decide"]},"body":{"mode":"raw","raw":"{\n    \"decision\": \"\"\n}"}}}]}]}