{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"de3dad6d-6c64-4310-87ed-a9d226f9f4d5","name":"Messengers API[public]","description":"## Messenger Converter API – Public Webhook Documentation\n\nThis documentation provides details about the public version of the Messenger Converter API and the structure of incoming webhooks.\n\nWebhooks are triggered by events such as incoming messages, delivery statuses, reactions, shared media, and more. Each event includes metadata about the source platform, message content, sender, and recipient.\n\n### 🔐 Authentication\n\nTo make requests and receive webhooks, you **must be authenticated** using:\n\n- `login` – your account identifier\n    \n- `token` – your secure access token\n    \n\nThese credentials must be included in every request for proper authorization.\n\n### 📡 Supported Sources\n\nThe API currently supports the following messenger platforms:\n\n- `whatsapp`\n    \n- `telegram`\n    \n- `sms`\n    \n- `telegram-bot`\n    \n- `viber-bot`\n    \n- `vk`\n    \n- `max`\n    \n- `max-bot`\n    \n- `instagram`\n    \n- `fbm`\n    \n- `waba`\n    \n- `avito`\n    \n\n### ☎️ Phone Number Format\n\nPhone numbers must be provided in the **international E.164 format**, without any symbols, spaces, or special characters.\n\n✅ Correct format example: `12345678901`  \n❌ Incorrect examples: `+12 (345) 678-901`, `+12-345-678-901`, `0123456789`\n\n---\n\nBelow you will find a detailed list of supported webhook types, payload examples, and content structures.\n\n---\n\n#### 📩 `hook_type: message`\n\nUsed for incoming/outgoing messages.\n\n``` json\n{\n  \"from\": \"<sender_id>\",\n  \"to\": \"<receiver_id>\",\n  \"time\": <timestamp>,\n  \"text\": \"<text_message_or_null>\",\n  \"source\": \"whatsapp\",\n  \"thread\": \"<chat_thread_id>\",\n  \"item\": \"<message_id>\",\n  \"outgoing\": <true_or_false>,\n  \"replyTo\": \"<original_message_id_or_null>\",\n  \"content\": [],\n  \"hook_type\": \"message\"\n}\n\n ```\n\n---\n\n#### 🔄 `hook_type: message_status`\n\nIndicates a change in message status (delivered, read, server ack, etc.).\n\n``` json\n{\n  \"from\": \"<sender_id>\",\n  \"to\": \"<receiver_id>\",\n  \"time\": <timestamp>,\n  \"text\": null,\n  \"source\": \"whatsapp\",\n  \"thread\": \"<chat_thread_id>\",\n  \"item\": \"<message_id>\",\n  \"outgoing\": true,\n  \"replyTo\": null,\n  \"content\": [\n    { \"type\": \"server\" } // or \"delivered\", etc.\n  ],\n  \"hook_type\": \"message_status\"\n}\n\n ```\n\n---\n\n#### 💬 `hook_type: add_message_reaction`\n\nTriggered when a user reacts to a message.\n\n``` json\n{\n  \"from\": \"<user_id>\",\n  \"to\": \"<user_id>\",\n  \"time\": <timestamp>,\n  \"text\": null,\n  \"source\": \"whatsapp\",\n  \"thread\": \"<chat_thread_id>\",\n  \"item\": \"<message_id>\",\n  \"outgoing\": false,\n  \"content\": [\n    { \"type\": \"reaction\", \"src\": \"👍\" }\n  ],\n  \"replyTo\": \"<original_message_id>\",\n  \"hook_type\": \"add_message_reaction\"\n}\n\n ```\n\n---\n\n#### 🖼️ `type: image`\n\nImage content in message.\n\n``` json\n{\n  \"type\": \"image\",\n  \"src\": \"<image_url>\"\n}\n\n ```\n\n---\n\n`type: call`\n\n``` json\n{\n\"type\": \"call\",\n\"src\": \"\" //duration of call (can be empty)\n}\n\n ```\n\n#### 📎 `type: file`\n\nFile (e.g. ZIP, PDF) attachment.\n\n``` json\n{\n  \"type\": \"file\",\n  \"src\": \"<file_url>\"\n}\n\n ```\n\n---\n\n#### 📍 `type: geo`\n\nGeolocation shared via message.\n\n``` json\n{\n  \"type\": \"geo\",\n  \"src\": \"{\\\"latitude\\\":52.22709274291992,\\\"longitude\\\":20.95680809020996}\"\n}\n\n ```\n\n---\n\n#### 👤 `type: contact`\n\nSingle contact shared.\n\n``` json\n{\n  \"type\": \"contact\",\n  \"src\": \"{\\\"firstName\\\":\\\"Contact Name\\\",\\\"phone\\\":\\\"<phone_number>\\\"}\"\n}\n\n ```\n\n---\n\n#### 👥 `type: multi-contact`\n\nMultiple contacts shared.\n\n``` json\n{\n  \"type\": \"multi-contact\",\n  \"src\": \"[{\\\"firstName\\\":\\\"Contact A\\\",\\\"phone\\\":\\\"<phone_number>\\\"}, {...}]\"\n}\n\n ```\n\n---\n\n#### 📅 `type: scheduled-event`\n\nAn event with a date/time shared in chat.\n\n``` json\n{\n  \"type\": \"scheduled-event\",\n  \"src\": \"{\\\"title\\\":\\\"Event Title\\\",\\\"description\\\":\\\"Event details\\\",\\\"start\\\":<timestamp>}\"\n}\n\n ```\n\n---\n\n### 📬 Message Status Types (`hook_type: message_status`)\n\nThe `content` array in `message_status` webhooks contains objects describing the current state of a message.  \nEach object includes a `type`, which represents the delivery or read status.\n\nBelow are the possible `type` values and their meanings:\n\n| Type | Description |\n| --- | --- |\n| `server` | Message was received by the server |\n| `delivered` | Message was delivered to the device |\n| `has_seen` | Message was read or played by recipient |\n| `pending` | Message has not yet been delivered |\n| `errored` | Delivery failed due to an error |\n\n> ℹ️ These values are derived from internal WhatsApp `MessageAck` statuses and normalized for webhook consumption. \n  \n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"5389397","collectionId":"de3dad6d-6c64-4310-87ed-a9d226f9f4d5","publishedId":"2sA3BuVoNW","public":true,"publicUrl":"https://documenter-api.postman.tech/view/5389397/2sA3BuVoNW","privateUrl":"https://go.postman.co/documentation/5389397-de3dad6d-6c64-4310-87ed-a9d226f9f4d5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.6","publishDate":"2024-04-28T13:23:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3BuVoNW"}