{"info":{"_postman_id":"de3dad6d-6c64-4310-87ed-a9d226f9f4d5","name":"Messengers API[public]","description":"

Messenger Converter API – Public Webhook Documentation

This documentation provides details about the public version of the Messenger Converter API and the structure of incoming webhooks.

Webhooks 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.

🔐 Authentication

To make requests and receive webhooks, you must be authenticated using:

login – your account identifier
\n
token – your secure access token
\n

These credentials must be included in every request for proper authorization.

📡 Supported Sources

The API currently supports the following messenger platforms:

whatsapp
\n
telegram
\n
sms
\n
telegram-bot
\n
viber-bot
\n
vk
\n
max
\n
max-bot
\n
instagram
\n
fbm
\n
waba
\n
avito
\n

☎️ Phone Number Format

Phone numbers must be provided in the international E.164 format, without any symbols, spaces, or special characters.

✅ Correct format example: 12345678901
❌ Incorrect examples: +12 (345) 678-901, +12-345-678-901, 0123456789

Below you will find a detailed list of supported webhook types, payload examples, and content structures.

📩 `hook_type: message`

Used for incoming/outgoing messages.

{\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

🔄 `hook_type: message_status`

Indicates a change in message status (delivered, read, server ack, etc.).

{\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

💬 `hook_type: add_message_reaction`

Triggered when a user reacts to a message.

{\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

🖼️ `type: image`

Image content in message.

{\n  \"type\": \"image\",\n  \"src\": \"<image_url>\"\n}\n\n

type: call

{\n\"type\": \"call\",\n\"src\": \"\" //duration of call (can be empty)\n}\n\n

📎 `type: file`

File (e.g. ZIP, PDF) attachment.

{\n  \"type\": \"file\",\n  \"src\": \"<file_url>\"\n}\n\n

📍 `type: geo`

Geolocation shared via message.

{\n  \"type\": \"geo\",\n  \"src\": \"{\\\"latitude\\\":52.22709274291992,\\\"longitude\\\":20.95680809020996}\"\n}\n\n

👤 `type: contact`

Single contact shared.

{\n  \"type\": \"contact\",\n  \"src\": \"{\\\"firstName\\\":\\\"Contact Name\\\",\\\"phone\\\":\\\"<phone_number>\\\"}\"\n}\n\n

👥 `type: multi-contact`

Multiple contacts shared.

{\n  \"type\": \"multi-contact\",\n  \"src\": \"[{\\\"firstName\\\":\\\"Contact A\\\",\\\"phone\\\":\\\"<phone_number>\\\"}, {...}]\"\n}\n\n

📅 `type: scheduled-event`

An event with a date/time shared in chat.

{\n  \"type\": \"scheduled-event\",\n  \"src\": \"{\\\"title\\\":\\\"Event Title\\\",\\\"description\\\":\\\"Event details\\\",\\\"start\\\":<timestamp>}\"\n}\n\n

📬 Message Status Types (`hook_type: message_status`)

The content array in message_status webhooks contains objects describing the current state of a message.
Each object includes a type, which represents the delivery or read status.

Below are the possible type values and their meanings:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
`server`	Message was received by the server
`delivered`	Message was delivered to the device
`has_seen`	Message was read or played by recipient
`pending`	Message has not yet been delivered
`errored`	Delivery failed due to an error

\n
ℹ️ These values are derived from internal WhatsApp MessageAck statuses and normalized for webhook consumption.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5389397","collectionId":"de3dad6d-6c64-4310-87ed-a9d226f9f4d5","publishedId":"2sA3BuVoNW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-28T13:23:32.000Z"},"item":[{"name":"getInfo","event":[{"listen":"test","script":{"id":"d047a064-a171-47d5-a082-2bd4f239da73","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c2acea86-d5ba-4766-af67-29a48e6db72c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/getInfo","description":"

Description:
Retrieves detailed information about the current state and configuration of the connected account. Useful for checking whether the account is active, authenticated, and what settings are applied.

What it returns:

Current connection status (status)
\n
Activation state (activated, state)
\n
Hook configuration (e.g. webhookUrls)
\n
Authentication method (qr or code)
\n
Additional metadata and flags (e.g. isBeta, takeover, etc.)
\n

Required Authentication:
✅ login and token headers required.

Response Example:

{\n  \"state\": true,\n  \"activated\": true,\n  \"status\": \"ok\",\n  \"webhookUrls\": [\"https://your-webhook-url.com\"],\n  \"apiV\": \"stable/sXX\",\n  \"additional\": {\n    \"isBeta\": false,\n    \"config\": {\n      \"services\": {\n        \"authMethod\": \"qr\"\n      }\n    }\n  },\n  ...\n}\n\n

WhatsApp connection statuses `step`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Значение (`value`)	Сообщение (`message`)
`0`	Account just started to start
`0.1`	Account force stopping
`0.2`	Account stopping
`1.5`	Network error
`2.0`	False session
`2.2`	QR code received
`2.22`	Auth code received
`2.3`	Can not update QR
`2.33`	Can not update auth code
`2.5`	Another error
`3.0`	Connection with phone was timeouted and will be retried in 20 seconds (LEGAGY)
`3.7`	Trying to run two Whatsapp instances (LEGAGY)
`3.9`	Trying to reconnect with phone (LEGAGY)
`4`	Loading screen (доп. поле: `_percent_`)
`5`	Account started successfully

Telegram connection statuses `step`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Значение (`value`)	Сообщение (`message`)
`0`	Account just started to start
`0.1`	Account force stopping
`0.2`	Account stopping
`1.5`	Network error
`1.6`	Banned phone number
`1.9`	Invalid phone number
`2.1`	This account needs 2FA solving, API Docs 2.1
`2.2`	QR code received
`2.25`	This account needs challenge solving, API Docs 2.2
`2.3`	Can not update QR
`2.35`	Too many auth attempts
`2.5`	Another error during account launch
`5`	Account started successfully & realtime init done

SMS API connection statuses `step`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Значение (`value`)	Сообщение (`message`)
`5`	Account started successfully
`2.2`	Mobile app is not connected

","urlObject":{"path":["getInfo"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"eee920ab-67dc-42bd-9927-73425f3a737b","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/getInfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:22:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"36e-NB54pzy9rIXw/LJD4ncAyps9IP0\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=tiTqdxZviX4vaQFNjN9V24ie%2BSF0z6FXBq%2BGOfEEE6O6mxN2M4LrwEvpCREFiWgMm7XRu%2FD3Ykm9wTVmicf%2Fk6S10bYrtWS1szUxKeZGmxdK3UJ5H9Ddy6nqpMCgtSdmwtqYC0aZ4sNBQIpaTfYmDA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8df4d7d46ee6059d-IAD"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2070&sent=5&recv=6&lost=0&retrans=0&sent_bytes=1529&recv_bytes=858&delivery_rate=2188413&cwnd=211&unsent_bytes=0&cid=0000000000000000&ts=0&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"step\": null,\n \"state\": false,\n \"webhookUrls\": [\n \"https://your-webhook-url.com\"\n ],\n \"activated\": false,\n \"defaultState\": false,\n \"apiV\": \"stable/sXX\",\n \"additional\": {\n \"isBeta\": true,\n \"_id\": \"\",\n \"config\": {\n \"_id\": \"\",\n \"services\": {\n \"outgoingOnlyHook\": false,\n \"authMethod\": \"qr\",\n \"_id\": \"\",\n \"stateHook\": false\n },\n \"conflict\": {\n \"_id\": \"\",\n \"takeover\": false,\n \"takeoverTimeoutMs\": 10000\n },\n \"authPhone\": null\n }\n },\n \"_id\": \"\",\n \"owner\": \"\",\n \"login\": \"\",\n \"proxyString\": \"\",\n \"webhookUrl\": null,\n \"addedTime\": 1698663744088,\n \"__v\": 0,\n \"lastAuthorizedAt\": 1715693764960,\n \"status\": \"ok\",\n \"uuid\": \"\"\n}"},{"id":"f4c7e1d1-6b00-4ded-a3f6-80e840458d81","name":"error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/getInfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:22:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"36-Ziu29uvmJtaEBG4QsSpBS98vW9A\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=FuF5IRH1bhLpYGN3XlaL%2BChodHvK%2BPSG7yS9%2Bvt08XVix984wjDmZC3NVjq2q3wsInyu45n5%2FkXM78ipHGP0CWmX%2FQMfjKQWOpUc6FzEPUV3kmls3rMALkZ2ZTbNluylI2RVx5TgG%2F%2BKZAaWlW4u%2Fw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8df4d75a1958059d-IAD"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2103&sent=1&recv=3&lost=0&retrans=0&sent_bytes=0&recv_bytes=441&delivery_rate=0&cwnd=208&unsent_bytes=0&cid=0000000000000000&ts=0&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": {\n \"message\": \"Access denied\"\n }\n}"}],"_postman_id":"c2acea86-d5ba-4766-af67-29a48e6db72c"},{"name":"getInfoByToken","id":"e0b586b6-abf3-44af-9214-2efb46cdc1d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"skipDetails\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"/getInfoByToken","description":"

Description:
Returns information about all accounts connected under the provided token.
The response includes an array of objects, each structured similarly to the /getInfo response for an individual account.

Use Case:
Useful when managing multiple messenger accounts under the same token and you want to fetch their statuses and settings in bulk.

Request Body:

{ \n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\"\n}\n\n

Response Example:

[\n  {\n    \"login\": \"account_1\",\n    \"state\": true,\n    \"activated\": true,\n    \"status\": \"ok\",\n    ...\n  },\n  {\n    \"login\": \"account_2\",\n    \"state\": false,\n    \"activated\": false,\n    \"status\": \"ok\",\n    ...\n  }\n]\n\n

\n","urlObject":{"path":["getInfoByToken"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"42259aed-4e94-41fc-9a37-11e4a7c432d3","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"skipDetails\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"/getInfoByToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:30:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"3dd-pamA+wyKT+dhIVsiaKkiNCjGVqE\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=okFEbfSAwmV1%2Bjrm2Ux7Tffxggnwuv%2BdAcLGv0NF1JBkmvAaGsPn%2FyzHJEtOx%2F%2Bca4ltOJAImCvXsYlQ9rVKatIZ1wpBxDWX9pq14ktSUNsCjVp0JBeBNgZGpqTOooMXvMEa71o8Lq%2FHgkWxsbeYNw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8df4e2da1cbd824e-IAD"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2210&sent=1&recv=3&lost=0&retrans=0&sent_bytes=0&recv_bytes=424&delivery_rate=0&cwnd=239&unsent_bytes=0&cid=0000000000000000&ts=0&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"clients\": [{}], //all accounts of token in array\n \"summary\": {\n \"active\": 0,\n \"activated\": 0,\n \"demo\": 1,\n \"count\": 1,\n \"payment\": {\n \"mode\": \"per day\",\n \"balance\": 0\n }\n },\n \"status\": \"ok\",\n \"uuid\": \"60ab864a-e35d-469f-912a-9bb146dd5da7\"\n}"}],"_postman_id":"e0b586b6-abf3-44af-9214-2efb46cdc1d0"},{"name":"updateAccount","event":[{"listen":"test","script":{"id":"d047a064-a171-47d5-a082-2bd4f239da73","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c94418bd-b468-4263-891b-7975e622d15d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"proxyString\": \"\",\n \"webhookUrls\": []\n}","options":{"raw":{"language":"json"}}},"url":"/updateAccount","description":"

POST `/updateAccount`

Description:
Updates the settings of an existing messenger account. This can include changing webhook URLs, enabling/disabling certain features, or modifying account preferences.

Requirements:

login (string) – identifies the account to be updated
\n
token – for authentication
\n
Any settings to be updated should be included in the request body
\n

Request Body Example:

{\n  \"source\": \"telegram\",\n  \"login\": \"your_account_login\",\n  \"token\": \"your_api_token\",\n  \"webhookUrls\": [\"https://your-updated-webhook-url.com\"],\n  \"state\": true,\n  \"config\": {\n    \"services\": {\n      \"stateHook\": true\n    }\n  }\n}\n\n

Response Example:

{\n  \"status\": \"ok\",\n  \"uuid\": \"\"\n}\n\n

\n","urlObject":{"path":["updateAccount"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c94418bd-b468-4263-891b-7975e622d15d"},{"name":"addWebhook","id":"1775eede-d642-4140-8f87-ef25240d18e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\",\r\n \"webhookUrl\": \"{{webhookUrl}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/addWebhook","description":"

POST `/addWebhook`

Description:
Registers one or more webhook URLs for an existing account. These webhooks will be triggered on specific events (e.g. message received, message status updated, reactions, etc.).

Requirements:

login – account identifier
\n
token – for authentication
\n
webhookUrl – URL for webhook
\n

Request Body Example:

{\n  \"source\": \"telegram\",\n  \"login\": \"your_account_login\",\n  \"token\": \"your_api_token\",\n  \"webhookUrl\": \"https://your-webhook-url.com\"\n}\n\n

Response Example:

{\n  \"status\": \"ok\",\n  \"uuid\": \"c3350248-c91f-4b24-993d-xxxxxx\"\n}\n\n

\n","urlObject":{"path":["addWebhook"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1775eede-d642-4140-8f87-ef25240d18e1"},{"name":"deleteWebhook","id":"3fe2ab95-c6ed-4979-bffd-b7321d4fdf8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\",\r\n \"webhookUrl\": \"{{webhookUrl}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/addWebhook","description":"

POST `/addWebhook`

Description:
Registers a webhook URL for the specified messenger account and source.
This webhook will be used to deliver event notifications (messages, statuses, reactions, etc.).

Required Fields:

source – messenger platform (e.g., whatsapp, telegram, etc.)
\n
login – account login
\n
token – your API access token
\n
webhookUrl – URL to which webhook events will be sent
\n

Request Body Example:

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"webhookUrl\": \"https://your-webhook-url.com\"\n}\n\n

Response Example:

{\n  \"status\": \"ok\",\n  \"uuid\": \"c3350248-c91f-4b24-993d-xxxxxx\"\n}\n\n

\n","urlObject":{"path":["addWebhook"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3fe2ab95-c6ed-4979-bffd-b7321d4fdf8a"},{"name":"clearSession","id":"7f60058a-a9e0-4449-9f3d-be7d0c1c967b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/clearSession","description":"

POST `/clearSession`

Description:
Clears the current session of the specified messenger account.
This is useful when a session becomes invalid, the device is disconnected, or you want to force re-authentication.

Effect:

Logs out the account from the current session.
\n
Requires a new authentication step (e.g. QR code or code login) to reestablish the connection.
\n

Required Fields:

source – messenger platform (whatsapp, telegram, etc.)
\n
login – account login
\n
token – your API access token
\n

Request Body Example:

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\"\n}\n\n

Response Example:

{\n  \"status\": \"ok\",\n  \"uuid\": \"c3350248-c91f-4b24-993d-xxxxxx\"\n}\n\n

\n","urlObject":{"path":["clearSession"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"7f60058a-a9e0-4449-9f3d-be7d0c1c967b"},{"name":"getUserInfo","id":"6a449cf3-9f16-47f6-bf20-71c1784df2b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\",\r\n \"to\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/getUserInfo","description":"

POST `/getUserInfo`

Description:
Fetches basic profile information about a specific contact in the context of a connected account.
Depending on the platform, this can return details such as the name, profile picture, or status.

Use Case:
Useful for identifying unknown contacts, enriching chat UI, or verifying if a user exists.

Required Fields:

source – messenger platform (e.g., whatsapp, telegram, etc.)
\n
login – account login
\n
token – your API access token
\n
to – target contact's phone number or user ID (in international format without symbols)
\n

Request Body Example:

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"to\": \"12345678901\"\n}\n\n

Response Example:

{\n  \"number\": \"***********\",\n  \"isBusiness\": false,\n  \"isEnterprise\": false,\n  \"name\": \"Contact Name\",\n  \"pushname\": \"Display Name\",\n  \"shortName\": \"\",\n  \"type\": \"in\",\n  \"isMe\": false,\n  \"isUser\": true,\n  \"isGroup\": false,\n  \"isWAContact\": true,\n  \"isMyContact\": true,\n  \"isBlocked\": false,\n  \"pictureUrl\": \"https://example.com/path-to-profile-image.jpg\",\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n","urlObject":{"path":["getUserInfo"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6a449cf3-9f16-47f6-bf20-71c1784df2b3"},{"name":"sendMessage[v1]","id":"8263adc7-3ba2-418e-beaa-820e8d4314ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\",\r\n \"msg\": {\r\n \"to\": \"\",\r\n \"text\": \"{{text}}\",\r\n \"content\": [\r\n {\r\n \"type\": \"\",\r\n \"src\": \"\",\r\n \"filename\":\"\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/sendMessage","description":"

POST `/sendMessage`

Description:
Sends a message to a contact or group via the specified messenger platform.
Supports plain text, media attachments, location sharing, contact cards, and more.

🔐 Authentication (in body):

token: Your API access token
\n
login: Your account identifier
\n

📨 Request Body

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"msg\": {\n    \"to\": \"12345678901\",\n    \"text\": \"Your message here\",\n    \"content\": [\n      {\n        \"type\": \"image\",\n        \"src\": \"https://example.com/image.jpg\",\n        \"filename\": \"photo.jpg\"\n      }\n    ]\n  }\n}\n\n

✅ Success Response

{\n  \"status\": \"ok\",\n  \"uuid\": \"e58081c3-b762-4247-8288-856961a4d3a7\",\n  \"results\": [\n    {\n      \"status\": \"ok\",\n      \"text\": \"Your full message text\",\n      \"result\": {\n        \"thread\": \"12345678901@c.us\",\n        \"item\": \"MESSAGE_ID\",\n        \"timestamp\": 1744038792000000\n      }\n    }\n  ]\n}\n\n

results[0].status — status of message delivery attempt
\n
results[0].text — actual message content sent
\n
result.thread — conversation identifier
\n
result.item — internal message ID
\n
result.timestamp — message timestamp (microseconds)
\n

❌ Error Response

{\n  \"status\": \"error\",\n  \"error\": {\n    \"message\": \"Evaluation failed: TypeError: Cannot read properties of undefined (reading 'WidFactory')\"\n  }\n}\n\n

\n","urlObject":{"path":["sendMessage"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8263adc7-3ba2-418e-beaa-820e8d4314ba"},{"name":"sendMessage[v2]","id":"be3ffdc7-5901-4b7b-a205-5afe867695e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\",\r\n \"msg_to\": \"\",\r\n \"msg_text\": \"{{text}}\",\r\n \"msg_content_type\": \"\",\r\n \"msg_content_src\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/sendMessage","description":"

POST `/sendMessage` (Flat Parameters Version)

Description:
Alternate version of the /sendMessage method using flat parameters instead of nested msg object.
Functionally identical — used in simpler clients or tools where nested objects are harder to construct.

🔐 Authentication (in body):

token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"msg_to\": \"12345678901\",\n  \"msg_text\": \"Your message text\",\n  \"msg_content_type\": \"image\",\n  \"msg_content_src\": \"https://example.com/image.jpg\"\n}\n\n

msg_to – recipient's phone number or user ID
\n
msg_text – (optional) message text
\n
msg_content_type – (optional) type of media (image, file, geo, etc.)
\n
msg_content_src – (optional) URL or payload of media
\n

✅ Success Response

{\n  \"status\": \"ok\",\n  \"uuid\": \"e58081c3-b762-4247-8288-856961a4d3a7\",\n  \"results\": [\n    {\n      \"status\": \"ok\",\n      \"text\": \"Your full message text\",\n      \"result\": {\n        \"thread\": \"12345678901@c.us\",\n        \"item\": \"MESSAGE_ID\",\n        \"timestamp\": 1744038792000000\n      }\n    }\n  ]\n}\n\n

❌ Error Response

{\n  \"status\": \"error\",\n  \"error\": {\n    \"message\": \"Evaluation failed: TypeError: Cannot read properties of undefined (reading 'WidFactory')\"\n  }\n}\n\n

\n
☑️ Both versions of /sendMessage return the same structure. You can use either depending on your client’s capabilities.
\n

\n","urlObject":{"path":["sendMessage"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"be3ffdc7-5901-4b7b-a205-5afe867695e8"},{"name":"getChatMessageByItem","id":"97514465-cfcb-4546-ae9d-5fdb7c8ccbcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\",\r\n \"to\": \"{{to}}\",// or use \"thread\": {{thread}}\r\n \"item\": \"item\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/getChatMessageByItem","description":"

POST `/getChatMessageByItem`

Description:

Method to get message by item

🔐 Authentication (in body):

token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"to\": \"12345678901\",\n  \"item\": \"123123123123\"\n}\n\n

to – phone number or user id,
\n
item – message id
\n

✅ Success Response

{\n  \"status\": \"ok\",\n  \"uuid\": \"e58081c3-b762-4247-8288-856961a4d3a7\",\n  \"message\": [\n  ]\n}\n\n

❌ Error Response

{\n  \"status\": \"error\"\n}\n\n

\n","urlObject":{"path":["getChatMessageByItem"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"97514465-cfcb-4546-ae9d-5fdb7c8ccbcf"},{"name":"setState","id":"69d0cf71-a087-4a80-9792-8b4e1bf0f6cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\",\r\n \"setState\": true //or false\r\n}","options":{"raw":{"language":"json"}}},"url":"/setState","description":"

POST `/setState`

Description:
Turns the account on or off depending on the setState value.
Used to control whether the messenger account should be actively connected and processing messages.

🔐 Authentication (in body):

source: Messenger platform (whatsapp, telegram, etc.)
\n
token: Your API access token
\n
login: Your account identifier
\n
setState: true to activate, false to deactivate
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"setState\": true\n}\n\n

✅ Success Response (Account is authorized)

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

❌ Error Response (Authorization required)

{\n  \"status\": \"error\",\n  \"error\": {\n    \"message\": \"Account is not authorized\"\n  }\n}\n\n

\n
ℹ️ Before enabling an account, make sure it has been successfully authenticated using a QR code or code-based login method.
\n

\n","urlObject":{"path":["setState"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"69d0cf71-a087-4a80-9792-8b4e1bf0f6cc"},{"name":"forceStop","id":"cc5b3857-33f2-497d-8c85-426b27c2154e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/forceStop","description":"

POST `/forceStop`

Description:
Forcibly stops the messenger account session and terminates all background processes associated with it.
Use this when the account is stuck, unresponsive, or needs a full reset before re-authentication.

🔐 Authentication (in body):

source: Messenger platform (whatsapp, telegram, etc.)
\n
token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
⚠️ After calling this method, the account may need to be re-activated using /setState or re-authorized if the session becomes invalid.
\n

\n","urlObject":{"path":["forceStop"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"cc5b3857-33f2-497d-8c85-426b27c2154e"},{"name":"getQr","id":"b3e94c48-5547-472a-8e98-c0b67b1197da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"source\": \"\",\r\n \"token\": \"\",\r\n \"login\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/getQr","description":"

POST `/getQr`

Description:
Generates a QR code for account authentication.
This is used when the account requires QR-based login (e.g., for WhatsApp Web-style authentication).

🔐 Authentication (in body):

source: Messenger platform (whatsapp, etc.)
\n
token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"value\": \"12314adsgfadfgsDfawert5tewey6sdfh.\"\n}\n\n

value – string representing the QR code

\n
🟡 You can render the QR in your frontend using an ![](...) tag with the value.
\n

\n","urlObject":{"path":["getQr"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b3e94c48-5547-472a-8e98-c0b67b1197da"},{"name":"enablePhoneAuth","id":"2b707b40-01bf-4762-8bce-f06d598f2fec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"phone\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/enablePhoneAuth","description":"

POST `/enablePhoneAuth`

Description:
Initiates phone number–based authentication for the selected messenger platform.
Used when QR code login is not available or when a code needs to be sent to a phone number for verification.

🔐 Authentication (in body):

source: Messenger platform (whatsapp, etc.)
\n
token: Your API access token
\n
login: Your account identifier
\n
phone: Phone number in international format (digits only)
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"phone\": \"12345678901\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
📲 After calling this method, a confirmation code should be sent to the provided number or whown in /getAuthCode for WhatsApp. Use /solveChallenge to complete the login process.
\n

\n","urlObject":{"path":["enablePhoneAuth"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2b707b40-01bf-4762-8bce-f06d598f2fec"},{"name":"disablePhoneAuth","id":"6e1bd68d-8e66-4fa1-8d2e-9152148fe688","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"phone\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/disablePhoneAuth","description":"

POST `/disablePhoneAuth`

Description:
Disables phone-based authentication for the specified account.
After this call, the account will require QR code authentication again (if supported by the platform).

🔐 Authentication (in body):

source: Messenger platform (whatsapp, etc.)
\n
token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
🔁 You can re-enable phone-based auth later using /enablePhoneAuth.
\n

\n","urlObject":{"path":["disablePhoneAuth"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6e1bd68d-8e66-4fa1-8d2e-9152148fe688"},{"name":"[wa]getAuthCode","id":"cf99e5b7-4845-432d-b337-b92ed5f099af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/getAuthCode","description":"

POST `/getAuthCode`

Description:
Retrieves an authorization code for WhatsApp accounts that are using phone-based login.
This code is usually sent via SMS or call to the provided phone number and is required to complete the login process.

\n
⚠️ This method is only available for source: whatsapp.
\n

🔐 Authentication (in body):

source: Must be \"whatsapp\"
\n
token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n  \"value\": \"123456\" // The actual auth code sent to the user\n}\n\n

\n","urlObject":{"path":["getAuthCode"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"cf99e5b7-4845-432d-b337-b92ed5f099af"},{"name":"[tg]solveChallenge","id":"6a79de3c-0151-479c-8cde-8e886357e760","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"code\": \"{{code}}\"\n}","options":{"raw":{"language":"json"}}},"url":"/solveChallenge","description":"

POST `/solveChallenge`

Description:
Submits a verification code to complete the login process for Telegram accounts that require user challenge validation (such as 2FA or initial device login).

\n
⚠️ This method is only available for source: telegram.
\n

🔐 Authentication (in body):

source: Must be \"telegram\"
\n
token: Your API access token
\n
login: Your account identifier
\n
code: Code received via Telegram (e.g. SMS or in-app message)
\n

📥 Request Body Example

{\n  \"source\": \"telegram\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"code\": \"12345\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
✅ If the code is correct, the account will be successfully authenticated and ready to use.
\n

\n","urlObject":{"path":["solveChallenge"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6a79de3c-0151-479c-8cde-8e886357e760"},{"name":"[tg]twoFactorAuth","id":"7b2c6e10-1ee0-4df8-ae3c-c0604b213a0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"code\": \"{{code}}\"\n}","options":{"raw":{"language":"json"}}},"url":"/twoFactorAuth","description":"

POST `/twoFactorAuth`

Description:
Submits a two-factor authentication password required for completing login to a Telegram account.
This is used when 2FA is enabled on the Telegram account and must be provided after the initial login code.

\n
⚠️ This method is only available for source: telegram.
\n

🔐 Authentication (in body):

source: Must be \"telegram\"
\n
token: Your API access token
\n
login: Your account identifier
\n
password: The Telegram 2FA password set by the user
\n

📥 Request Body Example

{\n  \"source\": \"telegram\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"password\": \"your_2fa_password\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
🔒 Make sure the password is correct — otherwise, authentication will fail.
\n

\n","urlObject":{"path":["twoFactorAuth"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"7b2c6e10-1ee0-4df8-ae3c-c0604b213a0e"},{"name":"sendTyping","id":"79176fdb-96b3-4017-878e-f5c46ac9472a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"to\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/sendTyping","description":"

POST `/sendTyping`

Description:
Send to recipient status Typing for 20 seconds

\n
⚠️ This method is only available for source: whatsapp.
\n

🔐 Authentication (in body):

source: Must be \"whatsapp\"
\n
token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"to\": \"phone\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
🔒 Make sure the password is correct — otherwise, authentication will fail.
\n

\n","urlObject":{"path":["sendTyping"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"79176fdb-96b3-4017-878e-f5c46ac9472a"},{"name":"resetTyping","id":"21de8bd5-27f3-4394-80c7-ed263e9db65f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"to\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/resetTyping","description":"

POST `/resetTyping`

Description:
reset to recipient status Typing

\n
⚠️ This method is only available for source: whatsapp.
\n

🔐 Authentication (in body):

source: Must be \"whatsapp\"
\n
token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"to\": \"phone\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
🔒 Make sure the password is correct — otherwise, authentication will fail.
\n

\n","urlObject":{"path":["resetTyping"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"21de8bd5-27f3-4394-80c7-ed263e9db65f"},{"name":"sendRecording","id":"1da60f2e-c0a0-41f2-ae65-1e58d5a42e2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source\": \"\",\n \"token\": \"\",\n \"login\": \"\",\n \"to\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/sendRecording","description":"

POST `/sendRecording`

Description:
Sends status of audio message recording for 20 seconds

⚠️ This method is only available for source: whatsapp.

🔐 Authentication (in body):

source: Must be \"whatsapp\"
\n
token: Your API access token
\n
login: Your account identifier
\n

📥 Request Body Example

{\n  \"source\": \"whatsapp\",\n  \"token\": \"your_api_token\",\n  \"login\": \"your_account_login\",\n  \"to\": \"phone\"\n}\n\n

✅ Response Example

{\n  \"status\": \"ok\",\n  \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n\n

\n
🔒 Make sure the password is correct — otherwise, authentication will fail.
\n

\n","urlObject":{"path":["sendRecording"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1da60f2e-c0a0-41f2-ae65-1e58d5a42e2d"}],"event":[{"listen":"prerequest","script":{"id":"c3b0f171-4874-459c-bb62-b61bfbdc3c64","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"b983c77d-db24-4af2-8759-f549e0b075e6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"apiUrl","value":""},{"key":"source","value":""},{"key":"token","value":""},{"key":"login","value":""},{"key":"phone","value":""}]}

Messenger Converter API – Public Webhook Documentation

🔐 Authentication

📡 Supported Sources

☎️ Phone Number Format

📩 hook_type: message

🔄 hook_type: message_status

💬 hook_type: add_message_reaction

🖼️ type: image

📎 type: file

📍 type: geo

👤 type: contact

👥 type: multi-contact

📅 type: scheduled-event

📬 Message Status Types (hook_type: message_status)

WhatsApp connection statuses step

Telegram connection statuses step

SMS API connection statuses step

POST /updateAccount

POST /addWebhook

POST /addWebhook

POST /clearSession

POST /getUserInfo

POST /sendMessage

🔐 Authentication (in body):

📨 Request Body

✅ Success Response

❌ Error Response

POST /sendMessage (Flat Parameters Version)

🔐 Authentication (in body):

📥 Request Body

✅ Success Response

❌ Error Response

POST /getChatMessageByItem

Description:

🔐 Authentication (in body):

📥 Request Body

✅ Success Response

❌ Error Response

POST /setState

🔐 Authentication (in body):

📥 Request Body Example

✅ Success Response (Account is authorized)

❌ Error Response (Authorization required)

POST /forceStop

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /getQr

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /enablePhoneAuth

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /disablePhoneAuth

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /getAuthCode

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /solveChallenge

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /twoFactorAuth

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /sendTyping

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /resetTyping

🔐 Authentication (in body):

📥 Request Body Example

✅ Response Example

POST /sendRecording

📩 `hook_type: message`

🔄 `hook_type: message_status`

💬 `hook_type: add_message_reaction`

🖼️ `type: image`

📎 `type: file`

📍 `type: geo`

👤 `type: contact`

👥 `type: multi-contact`

📅 `type: scheduled-event`

📬 Message Status Types (`hook_type: message_status`)

WhatsApp connection statuses `step`

Telegram connection statuses `step`

SMS API connection statuses `step`

POST `/updateAccount`

POST `/addWebhook`

POST `/addWebhook`

POST `/clearSession`

POST `/getUserInfo`

POST `/sendMessage`

POST `/sendMessage` (Flat Parameters Version)

POST `/getChatMessageByItem`

POST `/setState`

POST `/forceStop`

POST `/getQr`

POST `/enablePhoneAuth`

POST `/disablePhoneAuth`

POST `/getAuthCode`

POST `/solveChallenge`

POST `/twoFactorAuth`

POST `/sendTyping`

POST `/resetTyping`

POST `/sendRecording`