{"info":{"_postman_id":"57017540-f87f-495b-a750-9ffc719478a6","name":"Сhategy","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"31634267","collectionId":"57017540-f87f-495b-a750-9ffc719478a6","publishedId":"2s9Ykhhjkn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-20T10:44:41.000Z"},"item":[{"name":"Available endpoints","item":[{"name":"v1","item":[{"name":"Delivery","id":"da5d709e-47b8-4838-a556-e6a7d5e2f819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chategy.io/api/v1/delivery","description":"

\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

Short description	Sending messages with the specified parameters
Authorization	required
HTTP – method	POST
URL	https://api.chategy.io/api/v1/delivery
Response option	Successful with http code 200, unsuccessful with code 422

","urlObject":{"protocol":"https","path":["api","v1","delivery"],"host":["api","chategy.io"],"query":[{"disabled":true,"description":{"content":"

string | required | The phone number of the message recipient. The international format is 995598464533

\n","type":"text/plain"},"key":"phone","value":""},{"disabled":true,"description":{"content":"

string | required | Message text. The standard length for a single message is 160 characters for Latin letters.

\n","type":"text/plain"},"key":"text","value":""},{"disabled":true,"description":{"content":"

string | optional | The sender's name. You can specify the names of senders available to the client. If the parameter is missing or invalid, it is replaced by “CHATEGY.IO ”

\n","type":"text/plain"},"key":"sender_name","value":""},{"disabled":true,"description":{"content":"

string | optional | A label for marking shipments.

\n","type":"text/plain"},"key":"utm_mark","value":""},{"disabled":true,"description":{"content":"

string | optional | URL to which information will be automatically sent when the sending status is updated.

\n","type":"text/plain"},"key":"callback_url","value":""},{"disabled":true,"description":{"content":"

string | optional | The ID of the message. It is generated on the client side and is required in a unique way to use idempotence.

\n","type":"text/plain"},"key":"external_id","value":""},{"disabled":true,"description":{"content":"

array | optional | Channels and the sequence of sending the message.\nwhatsapp - Whatsapp.\ntdlib - numeric Telegram.\nTelegram - Telegram Bot.\nnotify - VK and OK.\nmax-MAX.

\n","type":"text/plain"},"key":"dispatch_routing[]","value":""},{"disabled":true,"description":{"content":"

datetime | optional | The delayed dispatch date must be at least 1 minute and no more than 1 month from the current moment. The time zone in which the delayed dispatch date UTC+0 is accepted. Specified in the format YYYY-MM-DD HH:MM: SS.

\n","type":"text/plain"},"key":"scheduled_at","value":""},{"disabled":true,"description":{"content":"

string | optional | Priority of sending the message. Available values are \"high\", \"medium\" and \"low\". If there is no parameter, the optimal value is determined automatically.

\n","type":"text/plain"},"key":"priority","value":""},{"disabled":true,"description":{"content":"

string | optional | Client name in telegram. Used only when sending via tdlib channel. Accepted in the format - username, @username

\n","type":"text/plain"},"key":"username","value":""},{"disabled":true,"description":{"content":"

string | optional | Message ID of the message (from webhook) we are replying to

\n","type":"text/plain"},"key":"reply_to_message_id","value":""},{"disabled":true,"description":{"content":"

string | optional | Client tdlib ID, used instead of phone number or name, when sending in a channel personal Telegram tdlib. This parameter can be used both for sending to private chats and for sending to group chats (if tdlib_user_id > 0 is a private chat, if <0 is a group chat (the group ID is always negative)

\n","type":"text/plain"},"key":"tdlib_user_id","value":""},{"disabled":true,"description":{"content":"

boolean | optional | The default value of the parameter is true. If true, a simulation of typing a message in whatsapp will occur, if false, the message will leave instantly

\n","type":"text/plain"},"key":"simulate_typing","value":""},{"disabled":true,"description":{"content":"

string | optional | Customer's lid ID on the WhatsApp side. Used only when sending to WhatsApp. Accepted for sending as an integer or integer with @lid suffix (Example: 43445322325 or 43445322325@lid)

\n","type":"text/plain"},"key":"whatsapp_lid","value":null}],"variable":[]}},"response":[{"id":"357b93c7-2b80-4c89-b364-98aea163d8c5","name":"Successful result","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chategy.io/api/v1/delivery?text=test&phone=995598464533","protocol":"https","host":["api","chategy.io"],"path":["api","v1","delivery"],"query":[{"key":"text","value":"test","description":"string | required | Message text. The standard length for a single message is 160 characters for Latin letters."},{"key":"phone","value":"995598464533","description":"string | required | The phone number of the message recipient. The international format is 995598464533"},{"key":"sender_name","value":"CHATEGY.IO","description":"string | optional | The sender's name. You can specify the names of senders available to the client. If the parameter is missing or invalid, it is replaced by “CHATEGY.IO ”","disabled":true},{"key":"utm_mark","value":"example_mark","description":"string | optional | A label for marking shipments.","disabled":true},{"key":"callback_url","value":"http://example-url.com","description":"string | optional | URL to which information will be automatically sent when the sending status is updated.","disabled":true},{"key":"external_id","value":"1","description":"string | optional | The ID of the message. It is generated on the client side and is required in a unique way to use idempotence.","disabled":true},{"key":"dispatch_routing[]","value":"sms","description":"array | optional | Channels and the sequence of sending the message.","disabled":true},{"key":"scheduled_at","value":"2023-11-21 20:30:00","description":"datetime | optional | The delayed dispatch date must be at least 1 minute and no more than 1 month from the current moment. The time zone in which the delayed dispatch date UTC+0 is accepted. Specified in the format YYYY-MM-DD HH:MM: SS.","disabled":true},{"key":"priority","value":"high","description":"string | optional | Priority of sending the message. Available values are \"high\", \"medium\" and \"low\". If there is no parameter, the optimal value is determined automatically.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Nov 2023 09:34:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5noOkF08-W8VoIBHH_h"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"delivery\": {\n \"callback_url\": null,\n \"dispatch_routing\": [\n \"sms\"\n ],\n \"external_id\": null,\n \"id\": 94396942,\n \"phone\": \"+995598464533\",\n \"priority\": \"low\",\n \"scheduled_at\": null,\n \"sender_name\": \"CHATEGY.IO\",\n \"status_description\": \"Accepted\",\n \"status_id\": 6,\n \"sum\": \"0.0\",\n \"total_sms\": 1,\n \"traffic_category\": 0,\n \"utm_mark\": null\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"3e2f4585-8419-4919-ad61-b2dcd9812b2f","name":"Error, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text"}],"url":{"raw":"https://api.chategy.io/api/v1/delivery?phone=995598464533&sender_name=CHATEGY.IO&utm_mark=example_mark&callback_url=http://example-url.com&external_id=1&dispatch_routing[]=whatsapp&scheduled_at=2023-11-21 20:30:00&priority=high","protocol":"https","host":["api","chategy.io"],"path":["api","v1","delivery"],"query":[{"key":"text","value":"Тест","description":"string | required","disabled":true},{"key":"phone","value":"995598464533","description":"string | required"},{"key":"sender_name","value":"CHATEGY.IO","description":"string | optional"},{"key":"utm_mark","value":"example_mark","description":"string | optional"},{"key":"callback_url","value":"http://example-url.com","description":"string | optional"},{"key":"external_id","value":"1","description":"string | optional"},{"key":"dispatch_routing[]","value":"whatsapp","description":"string | optional"},{"key":"scheduled_at","value":"2023-11-21 20:30:00","description":"string | optional"},{"key":"priority","value":"high","description":"string | optional"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 21 Nov 2023 16:10:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"158"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5mvO51eK7dyDMEAejqj"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"errors\": {\n \"text\": [\n \"the text cannot be empty\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"},{"id":"b28a0a7e-db79-4e0c-83e7-bdbe46ad817c","name":"Error, 401","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chategy.io/api/v1/delivery?text=Тест&phone=995598464533","protocol":"https","host":["api","chategy.io"],"path":["api","v1","delivery"],"query":[{"key":"text","value":"Тест","description":"string | required | Message text. The standard length for a single message is 160 characters for Latin letters or 70 for non-Latin letters."},{"key":"phone","value":"995598464533","description":"string | required | Phone number of the message recipient. The international format is 79991112233, 89991112233 is available for Russian numbers"},{"key":"sender_name","value":"CHATEGY.IO","description":"string | optional | Sender's name. You can specify the names of senders available to the client. If the parameter is missing or invalid, it is replaced by “PUSHSMS.RU ”","disabled":true},{"key":"utm_mark","value":"example_mark","description":"string | optional | Label for marking shipments.","disabled":true},{"key":"callback_url","value":"http://example-url.com","description":"string | optional | URL to which information will be automatically sent when the sending status is updated.","disabled":true},{"key":"external_id","value":"1","description":"string | optional | Message ID. It is generated on the client side and is required in a unique way to use idempotence.","disabled":true},{"key":"dispatch_routing[]","value":"sms","description":"array | optional | Channels and message sending sequence.","disabled":true},{"key":"scheduled_at","value":"2023-11-21 20:30:00","description":"datetime | optional | The date of delayed dispatch must be at least 1 minute and no more than 1 month from the current moment. The time zone in which the delayed dispatch date UTC+0 is accepted. Specified in the format YYYY-MM-DD HH:MM: SS.","disabled":true},{"key":"priority","value":"high","description":"string | optional | Priority of sending the message. Available values are \"high\", \"medium\" and \"low\". If there is no parameter, the optimal value is determined automatically.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Nov 2023 09:32:15 GMT"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5noGpbub8BIkKwA-oTC"}],"cookie":[],"responseTime":null,"body":"{\"meta\":{\"code\":401,\"message\":\"Not authorized!\",\"status\":\"fail\"}}"}],"_postman_id":"da5d709e-47b8-4838-a556-e6a7d5e2f819"},{"name":"Bulk Delivery","id":"0b4db990-ac84-4b22-b382-f7b96fae3b95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chategy.ioapi/v1/bulk_delivery?text=test&phones_numbers[]=995598464533","urlObject":{"protocol":"https","path":["v1","bulk_delivery"],"host":["api","chategy.ioapi"],"query":[{"description":{"content":"

string | required | Message text. The standard length for a single message is 160 characters for Latin letters or 70 for non-Latin letters.

\n","type":"text/plain"},"key":"text","value":"test"},{"description":{"content":"

array | required | Phone numbers of the message recipient. The international format is 995598464533. Example: +995598464533, 995598464533, +995598464533

\n","type":"text/plain"},"key":"phones_numbers[]","value":"995598464533"},{"disabled":true,"description":{"content":"

string | optional | Sender's name. If the parameter is missing or invalid, it is replaced by “CHATEGY.IO”

\n","type":"text/plain"},"key":"sender_name","value":"PUSHSMS.RU"},{"disabled":true,"description":{"content":"

datetime | optional | The date of delayed dispatch must be at least 1 minute and no more than 1 month from the current moment. The time zone in which the delayed dispatch date UTC+0 is accepted. Specified in the format YYYY-MM-DD HH:MM: SS. Example: 2021-11-11 20:30:00

\n","type":"text/plain"},"key":"scheduled_at","value":"2023-12-11 20:30:00"},{"disabled":true,"description":{"content":"

string | optional | Label for marking shipments

\n","type":"text/plain"},"key":"utm_mark","value":"example_mark"},{"disabled":true,"description":{"content":"

array | optional | Channels and message sending sequence.\nwhatsapp - Whatsapp.\ntdlib - numeric Telegram.\nTelegram - Telegram Bot.\nnotify - VK and OK.\nmax-MAX.

\n","type":"text/plain"},"key":"dispatch_routing[]","value":"whatsapp"},{"disabled":true,"description":{"content":"

array | optional | Client name in telegram. Used only when sending via tdlib channel. Accepted in the format - username, @username

\n","type":"text/plain"},"key":"usernames[]","value":"username"},{"disabled":true,"description":{"content":"

string | optional | tdlib client ID, used instead of phone number or name, when sending to via tdlib routing. This parameter can be used both for sending to private chats and for sending to group chats (if tdlib_user_id > 0 is a private chat, if <0 is a group chat (the group ID is always negative)

\n","type":"text/plain"},"key":"tdlib_user_id","value":""}],"variable":[]}},"response":[{"id":"67f833d3-f7d0-448c-9d37-6117000d4f2f","name":"Successful result","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chategy.io/api/v1/bulk_delivery?text=test&phones_numbers[]=995598464533&sender_name=CHATEGY.IO&scheduled_at=2023-12-11 20:30:00&utm_mark=example_mark&dispatch_routing[]=whatsapp","protocol":"https","host":["api","chategy.io"],"path":["api","v1","bulk_delivery"],"query":[{"key":"text","value":"test","description":"string | required | Message text. The standard length for a single message is 160 characters for Latin letters or 70 for non-Latin letters."},{"key":"phones_numbers[]","value":"995598464533","description":"array | required | Phone numbers of the message recipient. The international format is 79991112233. Example: +79991234567, 84956785422, +79851323233"},{"key":"sender_name","value":"CHATEGY.IO","description":"string | optional | Sender's name. If the parameter is missing or invalid, it is replaced by “CHATEGY.IO”"},{"key":"scheduled_at","value":"2023-12-11 20:30:00","description":"datetime | optional | The date of delayed dispatch must be at least 1 minute and no more than 1 month from the current moment. The time zone in which the delayed dispatch date UTC+0 is accepted. Specified in the format YYYY-MM-DD HH:MM: SS. Example: 2021-11-11 20:30:00"},{"key":"utm_mark","value":"example_mark","description":"string | optional | Label for marking shipments"},{"key":"dispatch_routing[]","value":"whatsapp","description":"array | optional | Channels and message sending sequence."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 09:39:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5txapkanYesqgsBtzKB"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"bulk_delivery\": {\n \"dispatch_routing\": [\n \"whatsapp\"\n ],\n \"phones_numbers\": [\n \"995598464533\"\n ],\n \"scheduled_at\": \"2023-12-11T20:30:00Z\",\n \"sender_name\": \"CHATEGY.IO\",\n \"state\": 2,\n \"text\": \"test\",\n \"url_shorting\": false,\n \"utm_mark\": \"example_mark\"\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"829a9ab9-1dc5-4469-a8e6-37f51495722e","name":"Error, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chategy.io/api/v1/bulk_delivery?phones_numbers[]=995598464533&sender_name=CHATEGY.IO&scheduled_at=2023-12-11 20:30:00&utm_mark=example_mark&dispatch_routing[]=whatsapp","protocol":"https","host":["api","chategy.io"],"path":["api","v1","bulk_delivery"],"query":[{"key":"text","value":"test","description":"string | required | Message text. The standard length for a single message is 160 characters for Latin letters or 70 for non-Latin letters.","disabled":true},{"key":"phones_numbers[]","value":"995598464533","description":"array | required | Phone numbers of the message recipient. The international format is 995598464533. Example: +995598464533, 995598464533, +995598464533"},{"key":"sender_name","value":"CHATEGY.IO","description":"string | optional | Sender's name. If the parameter is missing or invalid, it is replaced by “CHATEGY.IO”"},{"key":"scheduled_at","value":"2023-12-11 20:30:00","description":"datetime | optional | The date of delayed dispatch must be at least 1 minute and no more than 1 month from the current moment. The time zone in which the delayed dispatch date UTC+0 is accepted. Specified in the format YYYY-MM-DD HH:MM: SS. Example: 2021-11-11 20:30:00"},{"key":"utm_mark","value":"example_mark","description":"string | optional | Label for marking shipments"},{"key":"dispatch_routing[]","value":"whatsapp","description":"array | optional | Channels and message sending sequence."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 09:40:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"158"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5txe4ckiRHR4rEBdJMC"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"errors\": {\n \"text\": [\n \"the text cannot be empty\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"}],"_postman_id":"0b4db990-ac84-4b22-b382-f7b96fae3b95"},{"name":"Information about the delivery (the status of the shipment)","id":"0bf5e58d-666e-4d35-b559-a672ef4dbed0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/api/v1/delivery/:id","urlObject":{"protocol":"https","path":["api","v1","delivery",":id"],"host":["api","chategy.io"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"6948f242-86ec-4280-954b-7a6ce268425e","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chategy.io/api/v1/delivery/:id","protocol":"https","host":["api","chategy.io"],"path":["api","v1","delivery",":id"],"variable":[{"key":"id","value":"94396942","description":"integer | обязателеный | integer"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 09:49:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5tx8ef5lO_d4bgBdnAC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"delivery\": {\n \"callback_url\": null,\n \"external_id\": null,\n \"id\": 94396942,\n \"operator\": {\n \"brand_name\": \"Georgia\",\n \"country\": \"Georgia\",\n \"id\": 81,\n \"name\": \"Georgia\",\n \"slug\": \"georgia\"\n },\n \"phone\": \"+995598464533\",\n \"scheduled_at\": null,\n \"sender_name\": \"CHATEGY.IO\",\n \"status\": {\n \"description\": \"Forbidden\",\n \"status_id\": 49\n },\n \"sum\": \"0.00\",\n \"total_sms\": 1,\n \"traffic_category\": 0,\n \"utm_mark\": null\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"}],"_postman_id":"0bf5e58d-666e-4d35-b559-a672ef4dbed0"},{"name":"Information about the phone number","id":"fd03bd53-d92c-4a79-8eee-ea6694dc6207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/api/v1/operators/search","urlObject":{"protocol":"https","path":["api","v1","operators","search"],"host":["api","chategy.io"],"query":[{"disabled":true,"description":{"content":"

string | required | Phone number in international format. Special characters are allowed.

\n","type":"text/plain"},"key":"phone","value":"995598464533"}],"variable":[]}},"response":[{"id":"6764e906-94eb-41cd-83fc-802a8b5e5fc3","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chategy.io/api/v1/operators/search?phone=995598464533","protocol":"https","host":["api","chategy.io"],"path":["api","v1","operators","search"],"query":[{"key":"phone","value":"995598464533","description":"string | required | Phone number in international format. Special characters are allowed."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 09:46:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"190"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5txxFm-ixgyfr4BuLaB"}],"cookie":[],"responseTime":null,"body":"{\n \"formatted_phone\": \"+995598464533\",\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"operator\": {\n \"brand_name\": \"Georgia\",\n \"country\": \"Georgia\",\n \"id\": 81,\n \"name\": \"Georgia\",\n \"slug\": \"georgia\"\n }\n}"}],"_postman_id":"fd03bd53-d92c-4a79-8eee-ea6694dc6207"},{"name":"Viewing account information","id":"0861edce-b6c6-42a0-a50e-9817bbf9bd5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/api/v1/account","urlObject":{"protocol":"https","path":["api","v1","account"],"host":["api","chategy.io"],"query":[],"variable":[]}},"response":[{"id":"2f50924c-ce56-4848-b394-ffb2f661e317","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":"https://api.chategy.io/api/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 09:48:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"173"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5tx6S9-yyctcKoAPAlm"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"account\": {\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6ODEzLCJkYXRldGltZSI6MTYwMDcyMDU5MH0.iSZxL5MA5LL6ViIKOfdCTvMJ9Lc_KQzuXm0\",\n \"total_amount\": \"780.70\",\n \"customer_id\": 8143,\n \"dispatch_routing\": [\n \"sms\"\n ],\n \"subscription_paid_until\": \"2025-07-01\",\n \"sender_names\": [\n \"push813\",\n \"testname\",\n \"PUSHSMS.RU\"\n ],\n \"tdlib_session\": 3,\n \"whatsapp_session\": 1,\n \"subscription_status\": \"active\",\n \"subscription_cost\": \"100.00\"\n }\n}"}],"_postman_id":"0861edce-b6c6-42a0-a50e-9817bbf9bd5e"},{"name":"UTM tags","id":"34d9a9d9-76d7-49f3-907d-b1b6851c0cd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/api/v1/utm_mark","urlObject":{"protocol":"https","path":["api","v1","utm_mark"],"host":["api","chategy.io"],"query":[],"variable":[]}},"response":[{"id":"0ed13d4a-ae04-4f18-b86c-a2afeb2cc1eb","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":"https://api.chategy.io/api/v1/utm_mark"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 10:12:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5tzNfQPiGvG3HEBv1uB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"utm_marks\": []\n}"}],"_postman_id":"34d9a9d9-76d7-49f3-907d-b1b6851c0cd4"},{"name":"Sending files","id":"4cdbbf3c-4138-4456-a444-3f21cd6e4507","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"

file | required | allowed file

\n","type":"file","value":null,"disabled":true}]},"url":"https://api.chategy.io/api/v1/send_file","description":"

\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

Brief description	Send files with specified parameters. File is sent with a link to download, link is active for 7 days (text = file_name + link_to_file). Exception is whatsapp and tdlib, a photo up to 10 mb is sent.
Authorization	Required
HTTP-method	POST
URL	https://api.pushsms.ru/api/v1/send_file
Response options	Successful with http code 200, unsuccessful with code 422

Formats supported

documents:

application/pdf
\n
application/msword
\n
application/vnd.openxmlformats-officedocument.wordprocessingml.document
\n
application/vnd.ms-powerpoint
\n
application/vnd.openxmlformats-officedocument.presentationml.presentatio
\n
application/vnd.ms-excel
\n
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
\n
application/zip
\n
application/x-7z-compressed
\n

audio:

audio/ogg
\n
audio/opus
\n
audio/mpeg
\n
audio/mpeg3
\n
audio/x-mpeg-3
\n
audio/AMR
\n
audio/aac
\n
audio/x-hx-aac-adts
\n
audio/AMR-WB
\n
audio/AMR-WB+
\n
audio/3gpp
\n
audio/3gpp2
\n

images:

image/jpeg
\n
image/png
\n
image/webp
\n

video:

video/mp4

contacts:

text/x-vcard

Size supported

The maximum size of the received file for sending is 100 mb
\n
If the image is less than 10 mb - send as a photo (natively), if more - as a file. Applicable for whatsapp and tdlib sending channels.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","send_file"],"host":["api","chategy.io"],"query":[{"disabled":true,"description":{"content":"

string | required | \n File name. Must contain the file extension.\nExample: file_name.docx

\n","type":"text/plain"},"key":"file_name","value":""},{"disabled":true,"description":{"content":"

string | required | \n Phone number of the message recipient. International format 19991112233\nOptional parameter if username is used in tdlib channel

\n","type":"text/plain"},"key":"phone","value":""},{"disabled":true,"description":{"content":"

caption | optional | Description below the file. Used to send to whatsapp.

\n","type":"text/plain"},"key":"caption","value":""},{"disabled":true,"description":{"content":"

string | optional | Internal client ID.

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

string | optional | Native sending of images. If document is set to document, a file is sent, if image is set to image, a picture is sent. Used for sending to whatsapp.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

string | optional | Sender name (SMS only) . You can specify the sender names available to the client. If the parameter is missing or invalid, it is replaced with the default.

\n","type":"text/plain"},"key":"sender_name","value":""},{"disabled":true,"description":{"content":"

string | optional | Метка для маркировки отправок.

\n","type":"text/plain"},"key":"utm_mark","value":""},{"disabled":true,"description":{"content":"

string | optional | URL to which the information will be automatically sent when the sending status is updated. Structure in the corresponding section.

\n","type":"text/plain"},"key":"callback_url","value":""},{"disabled":true,"description":{"content":"

string | optional | Message identifier. Generated on the client side and is required in a unique form to use idempotency.

\n","type":"text/plain"},"key":"external_id","value":""},{"disabled":true,"description":{"content":"

array | optional | Channels and sequence of message sending. Controls the cascade sending functionality.

\n","type":"text/plain"},"key":"dispatch_routing[]","value":""},{"disabled":true,"description":{"content":"

datetime | optional | The date of deferred sending should be not less than 1 minute and not more than 1 month from the current moment. The time zone in which the delayed send date is accepted is UTC+0. Specified in the format YYYYY-MM-DD HH:MM:SS. Example: 2021-11-11 20:30:00

\n","type":"text/plain"},"key":"scheduled_at","value":""},{"disabled":true,"description":{"content":"

string | optional | The priority for sending the message. The available values are \"high\", \"medium\" and \"low\". If no parameter is available, the optimal value is automatically determined.

\n","type":"text/plain"},"key":"priority","value":""},{"disabled":true,"description":{"content":"

string | optional | The name of the client in Telegram. It is used only when sending via tdlib channel. Accepted in the format - username, @username

\n","type":"text/plain"},"key":"username","value":""},{"disabled":true,"description":{"content":"

string | optional | Message ID of the message (from webhook) we are replying to

\n","type":"text/plain"},"key":"reply_to_message_id","value":""},{"disabled":true,"description":{"content":"

string | optional | Client tdlib ID, used instead of phone number or name, when sending in a channel personal Telegram tdlib

\n","type":"text/plain"},"key":"tdlib_user_id","value":""},{"disabled":true,"description":{"content":"

boolean | optional | Default value - true. With the value - true, the tipping is triggered. False - the text description under the file is sent without tipping.

\n","type":"text/plain"},"key":"simulate_typing","value":null}],"variable":[]}},"response":[{"id":"e06829c4-e243-48fc-b725-a43e7f7f1495","name":"Successful result","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"file | required | allowed file ","type":"file","value":null}],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chategy.io/api/v1/send_file?file_name=file_name.doc&phone=9951234567890&caption=Important doc&customer_id=813&type=document&utm_mark=Doc&callback_url=example_url.com&external_id=12345&dispatch_routing[]=whatsapp&priority=high","protocol":"https","host":["api","chategy.io"],"path":["api","v1","send_file"],"query":[{"key":"file_name","value":"file_name.doc","description":"string | required | \n File name. Must contain the file extension.\nExample: file_name.docx"},{"key":"phone","value":"9951234567890","description":"string | required | \n Phone number of the message recipient. International format 19991112233\nOptional parameter if username is used in tdlib channel"},{"key":"caption","value":"Important doc","description":"caption | optional | Description below the file. Used to send to whatsapp."},{"key":"customer_id","value":"813","description":"string | optional | Internal client ID."},{"key":"type","value":"document","description":"string | optional | Native sending of images. If document is set to document, a file is sent, if image is set to image, a picture is sent. Used for sending to whatsapp. "},{"key":"sender_name","value":"SENDERNAME","description":"string | optional | Sender name (SMS only) . You can specify the sender names available to the client. If the parameter is missing or invalid, it is replaced with the default.","disabled":true},{"key":"utm_mark","value":"Doc","description":"string | optional | Label for marking message dispatches."},{"key":"callback_url","value":"example_url.com","description":"string | optional | URL to which the information will be automatically sent when the sending status is updated. Structure in the corresponding section."},{"key":"external_id","value":"12345","description":"string | optional | Message identifier. Generated on the client side and is required in a unique form to use idempotency."},{"key":"dispatch_routing[]","value":"whatsapp","description":"array | optional | Channels and sequence of message sending. Controls the cascade sending functionality."},{"key":"scheduled_at","value":"2024-02-08 00:30:00","description":"datetime | optional | The date of deferred sending should be not less than 1 minute and not more than 1 month from the current moment. The time zone in which the delayed send date is accepted is UTC+0. Specified in the format YYYYY-MM-DD HH:MM:SS. Example: 2021-11-11 20:30:00","type":"text","disabled":true},{"key":"priority","value":"high","description":"string | optional | The priority for sending the message. The available values are \"high\", \"medium\" and \"low\". If no parameter is available, the optimal value is automatically determined."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Feb 2024 16:04:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F7GgNhBrTqIJPCEACfeh"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"delivery\": {\n \"callback_url\": \"example_url.com\",\n \"dispatch_routing\": [\n \"whatsapp\"\n ],\n \"external_id\": \"12345\",\n \"id\": 108286044,\n \"phone\": \"+9951234567890\",\n \"priority\": \"high\",\n \"scheduled_at\": null,\n \"sender_name\": \"SENDERNAME\",\n \"reply_to_message_id\": null,\n \"simulate_typing\": false,\n \"status_description\": \"Received\",\n \"status_id\": 6,\n \"sum\": \"0.0\",\n \"total_sms\": 3,\n \"traffic_category\": 0,\n \"utm_mark\": \"Doc\"\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}\n"},{"id":"4df58a6b-eb6e-4c72-b2a0-9c48c0f60212","name":"Error, 422","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"file | required | allowed file ","type":"file","value":null}],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chatpush.ru/api/v1/send_file?file_name=file_name.doc&phone=71234567890&caption=Важный документ&customer_id=813&type=document&sender_name=PUSHSMS.RU&utm_mark=Документ&callback_url=example_url.ru&external_id=12345&dispatch_routing[]=whatsapp&priority=high","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","send_file"],"query":[{"key":"file_name","value":"file_name.doc","description":"string | обязательный | \n Название файла. Должно содержать расширение файла.\nПример: file_name.docx"},{"key":"phone","value":"71234567890","description":"string | обязательный | \n Телефон получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233"},{"key":"caption","value":"Важный документ","description":"caption | необязательный | Описание под файлом. Используется для отправки в whatsapp. "},{"key":"customer_id","value":"813","description":"string | необязательный | Внутренний ID клиента."},{"key":"type","value":"document","description":"string | необязательный | Нативная отправка кратинок. При значении document - отправляется файл, при значении image - отправляется картинка. Используется для отправки в whatsapp. "},{"key":"sender_name","value":"PUSHSMS.RU","description":"string | необязательный | Имя отправителя. Можно указывать доступные для клиента имена отправителей. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU”"},{"key":"utm_mark","value":"Документ","description":"string | необязательный | Метка для маркировки отправок."},{"key":"callback_url","value":"example_url.ru","description":"string | необязательный | URL-адрес, на который будет автоматически высылаться информация при обновлении статуса отправки. Структура в соответствующем разделе."},{"key":"external_id","value":"12345","description":"string | необязательный | Идентификатор сообщения. Генерируется на стороне клиента и необходим в уникальном виде для использования идемпотентности."},{"key":"dispatch_routing[]","value":"whatsapp","description":"array | необязательный | Каналы и последовательность отправки сообщения. Управление функционалом каскадной отправки."},{"key":"scheduled_at","value":"2024-02-08 00:30:00","description":"datetime | необязательный | Дата отложенной отправки должна быть не меньше 1 минуты и не больше 1 месяца с текущего момента. Часовой пояс, в котором принимается дата отложенной отправки UTC+0. Указывается в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. Пример: 2021-11-11 20:30:00","type":"text","disabled":true},{"key":"priority","value":"high","description":"string | необязательный | Приоритет отправки сообщения. Доступные значения: \"high\", \"medium\" и \"low\". При отсутствии параметра оптимальное значение определяется автоматически."}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 07 Feb 2024 16:11:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"127"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F7Ggk8NGC8NuzKYACfUC"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"errors\": {\n \"base\": [\n \"invalid mime type\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"}],"_postman_id":"4cdbbf3c-4138-4456-a444-3f21cd6e4507"},{"name":"Delete delivery","id":"f39ddf23-72ed-42f0-98de-2ccfd7bdd12e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.chategy.io/api/v1/delivery/:delivery_id","description":"

\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

Short description	Deletes sent messages in the Whatsapp and Telegram messenger via TDLib
Authorization	Required
HTTP – method	DELETE
URL	https://api.chategy.io/api/v1/delivery/:delivery_id
Response option	Successful with http code 200, unsuccessful with code 422

Deletion only works for messages sent through the TDLib channel (i.e., Telegram via TDLib) and Whatsapp.
\n
If the message is not found or has already been deleted, a 422 error is returned with a corresponding description.
\n
Only messages sent through the Jetapi service can be deleted.
\n
Deletion is only performed if the message has a successful final status of “Delivered” in the system.
\n
Deletion occurs on all devices.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","delivery",":delivery_id"],"host":["api","chategy","io"],"query":[],"variable":[{"description":{"content":"

integer | required | ID of the message to be deleted, obtained from the delivery.id field in the JSON response of the delivery method.

\n","type":"text/plain"},"type":"any","value":"","key":"delivery_id"}]}},"response":[{"id":"c76e820e-cc6f-4c98-96a1-3e57d041725b","name":"Successful result","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.jchategy.io/api/v1/delivery/:message_id","protocol":"https","host":["api","jchategy","io"],"path":["api","v1","delivery",":message_id"],"variable":[{"key":"message_id","value":"434"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"7ab25937-a466-4303-9aa8-ceb0ee2c0235","name":"Error, 422","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chategy.io/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chategy","io"],"path":["api","v1","delivery",":delivery_id"],"variable":[{"key":"delivery_id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"tdlib_delivery\": [\n \"tdlib_delivery not found\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"2e28ae30-48dc-4b98-952a-fbf5eed8188d","name":"Error, 422 (for tdlib)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chategy.io/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chategy","io"],"path":["api","v1","delivery",":delivery_id"],"variable":[{"key":"delivery_id","value":"22"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"tdlib_delivery\": [\n \"tdlib_delivery not found\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"9bd4bc0e-4810-4260-90d9-345edcdbda3b","name":"Error, 422 (for whatsapp)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chategy.io/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chategy","io"],"path":["api","v1","delivery",":delivery_id"],"variable":[{"key":"delivery_id","value":"322"}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"delivery\": [\n \"delivery not found\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"fe6290cf-5ace-49c1-ab5c-267127cd6995","name":"Error, 422 (dispatch_type invalid)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chategy.io/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chategy","io"],"path":["api","v1","delivery",":delivery_id"],"variable":[{"key":"delivery_id","value":"3223"}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"dispatch_type\": [\n \"dispatch_type invalid\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"27708dae-5169-4bdd-8113-611301113072","name":"Error, 422 (not complete)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chategy.io/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chategy","io"],"path":["api","v1","delivery",":delivery_id"],"variable":[{"key":"delivery_id","value":"323"}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"delivery\": [\n \"delivery not_complete\"\n ]\n },\n \"status_id\": null\n }\n}"}],"_postman_id":"f39ddf23-72ed-42f0-98de-2ccfd7bdd12e"}],"id":"32e538cd-2e11-441d-98ff-a6bd2ab1ee71","_postman_id":"32e538cd-2e11-441d-98ff-a6bd2ab1ee71","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"463f10ad-f6ac-4b61-b979-7b8c36d37e21","id":"463f10ad-f6ac-4b61-b979-7b8c36d37e21","name":"Available endpoints","type":"folder"}}},{"name":"Additional information","item":[],"id":"e6150245-56e7-4695-8484-7b3f44c2587e","description":"

Callback of the sending status

Общие сведения

\n
The mechanics in which the server makes a POST request automatically at the specified callback_url in the delivery request. The server request is made after updating the status of the shipment to the final one (delivered, delivery refused, etc.). The request is repeated every 2 minutes 10 times until it receives the HTTP code 200 in response.
\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

Key	Data type	Description
delivery	object	The sending object
delivery.sender_name	string	The name of the sender of the shipment
delivery.id	integer	Internal sending ID
status	object	Status Object
status.status_id	integer	Status ID from the “Status List”
status.description	string	Brief description of the status
status.dispatch_routing	string	The channel through which the final status was received. Acceptable values: “sms\", “whatsapp\", “tdlib”, “telegram\", “notify”

JSON:

{\n  \"delivery\": {\n    \"sender_name\": \"CHATEGY.IO\",\n    \"id\": 26,\n    \"status\": {\n      \"status_id\": 26, \n      \"description\": \"some text\", \n      \"dispatch_routing\": \"whatsapp\"\n    }\n  }\n}\n\n

Idempotence of requests

For some integrations, reliable protection against duplicate requests is required in order to avoid unnecessary shipments and debits of funds.
CHATEGY provides such protection through the idempotent query mechanism.
To implement the mechanism in the available API methods, the IDEMPOTENCY KEY is used, which can be obtained in the personal account.
All relevant requests in headers must contain the following:

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

Key	Value
checksum	{checksum_value}

Generating checksum_value:

checksum_value is generated by converting parameters using HMAC SHA-256. The parameters should be presented as a string, which consists of parameter values pre-sorted alphabetically by key. The IDEMPOTENCY KEY is used as the secret key when applying HMAC SHA-256 conversion.

Example generation checksum_value on Ruby:

params = {\n   text: \"text\",\n   phone: \"9951233456789\",\n   external_id: \"100\"\n}\nidempotency_key = \"Z5F2idBj\"\nparams_string = params.keys.sort.map{|e| params[e]}.join\n\"10071233456789text\"\ndigest = OpenSSL::Digest.new('sha256')\nchecksum_value = OpenSSL::HMAC.hexdigest(digest, idempotency_key, params_string)\n\"ebb290126ea4302ebca339f5efe419b4a67edfe57e1ea844e7cec85ccef53f23\"\n\n

Example request by curl:

curl --location --request POST 'https://api.chategy.io/api/v1/delivery?text=textsms&phone=9951233456789&external_id=100' \\\n--header 'Authorization: Bearer {your token}'\n--header 'checksum: {checksum_value}'\n\n

If the checksum value is incorrectly generated, the response will have: HTTP code 400 (Bad Request) and will contain JSON:

{\n  \"meta\": {\n    \"status\": \"fail\",\n    \"message\": \"Invalid checksum\",\n    \"code\": 400\n  }\n}\n\n

If the key does not match, the response will have: HTTP code 409 (Conflict) and will contain JSON:

{\n  \"meta\": {\n    \"status\": \"fail\",\n    \"message\": \"Request with current params has already been received\",\n    \"code\": 409\n  }\n}\n\n

Cascading sending (WhatsApp, Telegram)

General information

Before you start sending using WhatsApp, Telegram you need to link them to your account.

Next, you can specify a list of channels through which an attempt will be made to deliver a message. The transition to the next channel (an attempt to send through this channel) occurs when the status of the inability to deliver via the current channel is received. Within the framework of the service and API, the parameter that controls this property is called dispatch routing or dispatch routing.

Usage

Our service currently provides 5 sending channels - sms, whatsapp, tdlib (numbered telegram), telegram (telegram bot).
You can use cascading sending when sending via partner services or via the API. Routing of shipments from partner services is controlled by setting the default value in the personal account, the same value is applied if the dispatch_routing parameter is not specified in the API, invalid or empty.
The value that comes in the API parameter dispatch_routing must consist of an array of strings, is filtered for uniqueness and leaves only the available options from the first paragraph.
The position of the channel in the list corresponds to the order of attempts to send to this channel. Example: a request to send with the value dispatch_routing: [\"whatsapp\", \"sms\"] is received; first, a request to send via WhatsApp will be made, with a successful response, the delivery cycle will stop, if the message via WhatsApp is not delivered, the service will switch to SMS delivery.

List of service statuses

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

Short description	ID	Explanation	Type	Description
telecommunication_company_error	0	Operator error	final	Message not delivered. The operator reported an error when sending.
enroute	1	Passed to the operator	intermediate	The operator accepted the request to send the message, the delivery status will appear later.
delivered	2	Delivered	final	The message has been delivered to the recipient.
expired	3	Expired	Final	Message not delivered. Possible reasons: the subscriber was out of the access zone for a long time or his phone ran out of memory for new messages.
deleted	4	Deleted	final	Message deleted.
undeliverable	5	Unable to deliver	final	Message could not be delivered. The recipient is offline or has banned receiving messages.
accepted	6	Accepted	intermediate	The message is accepted by us for sending and in the process of transmission to the operator.
unknown	7	Failed to deliver	final	Message not delivered. The operator reported an unknown error.
rejected	8	Rejected	final	The operator rejected the delivery. A possible reason is the client's refusal to receive an SMS.
internal_server_error	9	Server error	final	The server could not process the request and shut down. We are already dealing with this problem.
unhandled_error	10	Unhandled error	final	Unknown operator error. Our specialists are already dealing with this problem.
incorrect_number	11	Invalid number	final	The wrong phone number is specified in the delivery request.
forbidden	12	Forbidden	final	One of the restrictions has worked: on sending duplicates, on sending messages too often to one recipient, on numbers from the blacklist, on texts prohibited by the spam filter or names of senders.
not_enough_money	13	Insufficient funds	final	Top up your account for sending SMS or mailing in messengers.
waiting_for_sending	14	Waiting to be sent	intermediate	The message is in the queue to be sent, it will be sent to the operator soon.
in_progress	15	In processing	intermediate	The message is being processed by the system. Its status will be updated in the near future.
read	16	Read	final	Message read by recipient.
too_many_requests	17	Request limit exceeded	final	Telegram informed us that you sent too many requests, check the status of your phone at the link: https://t.me/SpamBot .
cancelled	18	Cancelled	final	Message delivery has been cancelled.
smpp_queue_expired	20	Unable to deliver	final	The operator reported a critical error when trying to send.
moderating	21	On moderation	intermediate	Message on moderation. According to the results of processing, an email will be sent with an explanation of the decision.
moderation_declined	22	Moderation rejected	final	The message did not pass moderation. The reason: look in the mail.
external_restriction	25	Restrictions on sending	final	One of the restrictions worked: on sending duplicates, on flooding (sending messages to one recipient too often), on numbers from the blacklist, on texts prohibited by the spam filter or names of senders.
length_restriction	26	Message length limits	final	The message was not sent because in settings there is a limit on the length of messages sent.
kazakhstan_restriction	27	Restrictions on sending to Kazakhstan	final	Sending promotional messages after 22:00 is prohibited in Kazakhstan.
operator_restriction	28	Operator restriction	final	The message is blocked due to operator restriction for you.
payment_transaction_error	31	Payment error	final	The server could not make the payment. We are already dealing with this problem.
subscription_expired	32	The subscription to messengers has not been paid	final	The message has not been delivered, since you have not paid for access to the message sending service. Top up your account in your personal account to continue sending messages.
incorrect_delivery_params	33	Invalid sending parameters	final	The parameters in the delivery request were passed incorrectly. For more information, see [API documentation.](https://docs.chatpush.ru /#/)
foreign_delivery_restricted	34	Restrictions on sending	final	One of the restrictions worked: on sending duplicates, on flooding (sending messages to one recipient too often), on numbers from the blacklist, on texts prohibited by the spam filter or names of senders.
rate_limit_error	35	The limit of delivery requests has been exceeded	final	When more than 1 message per minute is sent to the messenger, they queue up, an error is displayed if the number of messages in the queue is exceeded.
blocked_by_subscription_expired	36	Subscription suspended	final	Subscription suspended.
daily_limit_error	37	The daily limit of delivery requests has been exceeded	final	The daily limit for sending messages has been exceeded.
whatsapp_unregistered_number	44	WhatsApp unregistered number	final	This number is not registered in the messenger.
whatsapp_session_doesnt_exist	45	WhatsApp session not started	final	Message not delivered because your WhatsApp is not authorized in the message sending service. To log in, scan the QR code.
smsc_dos_error	46	Waiting to be sent	intermediate	Message in the queue to be sent, will be sent to the operator soon.
smsc_not_enough_money	47	Unprocessed error	final	Unknown operator error. Our specialists are already dealing with this problem.
smsc_unavailable_number	48	Unavailable number	final	The operator could not deliver a message to this phone number.
aggregate_forbidden	49	Prohibited	final	Operator's ban on sending from common names.
tdlib_not_authorized	50	Telegram is not authorized	final	Sending to Telegram has stopped, you need to log in.
customer_settings_delivery_time_restriction_cancel	51	Restriction on sending time settings	final	The message is blocked due to a restriction on sending time settings.
smpp_connection_error	69	Unable to deliver	final	The operator reported a critical error when trying to send.
smpp_sending_limit_error	88	Unable to deliver	final	The operator reported a critical error when trying to send.
smpp_transmitter_not_allowed_region	257	Unable to deliver	final	Failed to deliver the message if it is an SMS: the operator cannot deliver the message. This may be due to the fact that the subscriber is offline or has forbidden receiving messages. If this is a delivery to messengers: the message could not be delivered due to the fact that the sender's phone is offline.
blacklisted_number_error	555	Blacklisted	final	Subscriber is blacklisted by the client or the message sending service.
source_addr_forbidden	1281	Name blocked by operator	final	Name blocked by operator.
smpp_num_blacklisted	1282	Unable to deliver	final	There is a problem with the recipient's number. It is possible that there was an attempt to send to a direction prohibited for the client (for example, sending to non-Russian numbers may be prohibited) or the recipient himself forbade receiving a certain class of messages.
template_violation	1283	Invalid text or template	final	The operator rejected the delivery due to violations of the text parameters.
smpp_msg_blacklisted	1284	Rejected	final	The text of the message contains forbidden words.
smpp_not_enough_money	1285	Unable to deliver	final	The operator reported a critical error when trying to send.
smpp_foreign_delivery_restricted	1286	Restrictions on sending	final	One of the restrictions worked: on sending duplicates, on flooding (sending messages to one recipient too often), on numbers from the blacklist, on texts prohibited by the spam filter or names of senders.
smpp_down_msisdn	1287	Operator error	Final	Operator error. Our specialists are already dealing with this problem.
smpp_megafon_wrong_provider	1288	Unable to deliver	final	The operator reported a critical error when trying to send.
smpp_beeline_wrong_provider	1293	Unable to deliver	final	The operator reported a critical error when trying to send.
smpp_beeline_partner_blocked	1299	Unable to deliver	final	Failed to deliver the message if it is an SMS: the operator cannot deliver the message. This may be due to the fact that the subscriber is offline or has forbidden receiving messages. If this is a delivery to messengers: the message could not be delivered due to the fact that the sender's phone is offline.
smpp_anti_spam_block	2291	The subscriber has enabled the spam filter	final	The subscriber has forbidden receiving SMS.

List of traffic categories

\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

Short description	ID	Explanation
advert	0	Advertising
transaction	1	Transactional
service	2	Service

","_postman_id":"e6150245-56e7-4695-8484-7b3f44c2587e","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"463f10ad-f6ac-4b61-b979-7b8c36d37e21","id":"463f10ad-f6ac-4b61-b979-7b8c36d37e21","name":"Available endpoints","type":"folder"}}}],"id":"463f10ad-f6ac-4b61-b979-7b8c36d37e21","description":"

Authorization

The project uses token-based authorization. You can get the necessary access_token in the corresponding section of your personal account

All relevant requests in headers must contain the following:

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

Key	Value
Authorization	Bearer {access_token}
Content-Type	application/json

Пример:

curl -X GET https://api.chategy.io/api/v1/account -H 'Authorization: Bearer {your token}'\n\n

If these parameters are missing or disabled in all relevant resources, the response will have: HTTP code 401 (Not authorized) and will contain JSON:

{\n  \"meta\": {\n    \"status\": \"fail\",\n    \"message\": \"Not authorized!\",\n    \"code\": 401\n  }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"06bb01da-0669-482e-a6e4-9745a8ebad1c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"89129838-3b5c-483f-8bf2-a1ddfd80232d","type":"text/javascript","exec":[""]}}],"_postman_id":"463f10ad-f6ac-4b61-b979-7b8c36d37e21"},{"name":"Developer's","item":[{"name":"Instance Management","item":[{"name":"Creating an instance","id":"51595fbe-eb7a-4c2a-88b1-fde3ebf1b8a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"instance\" : {\n \"phone\" : \"995555846453\",\n \"email\" : \"example_mail@gmail.com\",\n \"password\" : \"example123\",\n \"external_id\" : \"77777\",\n \"dispatch_routing\" : [\"whatsapp\"]\n}\n}","options":{"raw":{"language":"json"}}},"url":"https://chategy.io/api/tmp/instances","description":"

\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

Key	Required	Data type	Description
email	yes	string	Email of the registered client
phone	yes	string	Phone number of the registered client
password	none	string	Password of the registered client. Validation: 1. greater than or equal to 7 characters 2. letters and numbers are required
dispatch_routing	no	array	Default channel for sending registered client
external_id	string	none	External ID
renew_subscription	string	no	False - auto-renewal is disabled, true - auto-renewal is enabled. If there is no default parameter, the value is = true

","urlObject":{"protocol":"https","path":["api","tmp","instances"],"host":["chategy.io"],"query":[],"variable":[]}},"response":[{"id":"84f14f83-9ddc-498d-9dee-2dadf6248adc","name":"Successful result","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"instance\" : {\n \"phone\" : \"79260846453\",\n \"email\" : \"example_mail@mail.ru\",\n \"password\" : \"example123\",\n \"external_id\" : \"77777\",\n \"dispatch_routing\" : [\"whatsapp\"]\n}\n}","options":{"raw":{"language":"json"}}},"url":"https://chategy.io/api/tmp/instances"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 10:58:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Vary","value":"Accept"},{"key":"ETag","value":"W/\"56565e2961084d39fee8946f6c43d5c1\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"24aad114-8386-4ad7-b714-5d9267b09df2"},{"key":"X-Runtime","value":"0.767932"}],"cookie":[],"responseTime":null,"body":"{\n \"instance\": {\n \"id\": 3748,\n \"customer_id\": 20322,\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6MjAzMjIsImRhdGV0aW1lIjoxNzAxMDgyNjk4fQ.R4rmzpSNC2rSGk5QQfTooK3I3niDMYclz-6uFmD7-Vg\",\n \"idempotency_key\": \"78avGOJp\",\n \"renew_subscription\": true,\n \"external_id\": \"77777\"\n },\n \"meta\": {\n \"status\": \"success\",\n \"code\": 200\n }\n}"},{"id":"f75dfc00-7466-4666-ac68-ea824db70b24","name":"Error, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"instance\" : {\n \"phone\" : \"79260846453\",\n \"email\" : \"example_mail@mail.ru\",\n \"password\" : \"example123\",\n \"external_id\" : \"77777\",\n \"dispatch_routing\" : [\"whatsapp\"]\n}\n}","options":{"raw":{"language":"json"}}},"url":"https://chategy.io/api/tmp/instances"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 10:59:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Vary","value":"Accept"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"11659583-3c40-4197-b0fd-8122132d7f3f"},{"key":"X-Runtime","value":"0.017535"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"status\": \"fail\",\n \"code\": 422,\n \"message\": \"Unprocessable entity\",\n \"errors\": {\n \"email\": [\n \"already exists\"\n ],\n \"phone\": [\n \"already exists\"\n ]\n }\n }\n}"}],"_postman_id":"51595fbe-eb7a-4c2a-88b1-fde3ebf1b8a6"},{"name":"Getting information about an instance (customer_id)","id":"e6df5d0a-828b-431b-97cf-afa1c3f032f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/developer/v1/instances/:curstomer_id","urlObject":{"protocol":"https","path":["developer","v1","instances",":curstomer_id"],"host":["api","chategy.io"],"query":[],"variable":[{"id":"6cadd695-face-43b6-ab4d-84565db819fe","description":{"content":"

integer | обязательный | уникальный идентификатор клиента

\n","type":"text/plain"},"type":"any","value":"2032","key":"curstomer_id"}]}},"response":[{"id":"09ae8ed6-5665-4bd0-bdf8-b84717c39ea3","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/instances/:curstomer_id","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","instances",":curstomer_id"],"variable":[{"key":"curstomer_id","value":"203","description":"integer | required | unique client ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:20:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t25nAma30LDxQAAD9k"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"instance\": {\n \"id\": 373,\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6MTA4MywiZGF0ZXRpbWUiOjE3NDkzMTg3MDl9.--9FYWaoc6P09r7gUlp7BoZZ\",\n \"external_id\": \"0001\",\n \"customer_id\": 203,\n \"subscription_paid_until\": \"2025-10-31\",\n \"renew_subscription\": false,\n \"tdlib_session\": 3,\n \"whatsapp_session\": 0,\n \"whatsapp_queue_size\": 0,\n \"whatsapp_queue_limit\": 1000,\n \"whatsapp_phone\": null,\n \"subscription_status\": \"active\",\n \"subscription_cost\": \"600.00\"\n }\n}"},{"id":"82e8159e-3c93-4637-8849-351da1c34a71","name":"Error, 404","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/instances/:curstomer_id","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","instances",":curstomer_id"],"variable":[{"key":"curstomer_id","value":"2032","description":"integer | required | unique client ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:22:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t3C5hLP7pJWTgAAM7j"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 404,\n \"message\": \"Not found\",\n \"status\": \"fail\"\n }\n}"}],"_postman_id":"e6df5d0a-828b-431b-97cf-afa1c3f032f4"},{"name":"Getting information about an instance (external_id)","id":"69797b80-5a9b-4bdf-bd6e-55bac02b08fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/developer/v1/instances/","description":"

Response Parameters

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

Key	Data Type	Description
`id`	integer	Unique instance identifier
`token`	string	Bearer token
`customer_id`	integer	Unique customer identifier
`renew_subscription`	boolean	Instance subscription auto-renewal status. `false` - auto-renewal disabled, `true` - auto-renewal enabled.
`tdlib_session`	integer	Telegram authorization status. Status codes: 0,1,2,3 0 - Awaiting phone number input, 1 - Awaiting code input, 2 - Awaiting password input, 3 - Authorized
`whatsapp_session`	integer	WhatsApp authorization status. Status codes: (0 or 1) 0 - Not authorized, 1 - Authorized
`whatsapp_phone`	string	Authorized user's phone number
`whatsapp_queue_size`	integer	Current number of messages in the WhatsApp queue for this instance. Indicates real-time load on the messaging system.
`whatsapp_queue_limit`	integer	Maximum size of WhatsApp message queue for this instance. Defines the limit of messages that can be queued for sending.
`external_id`	integer	External ID
`subscription_cost`	number	Instance subscription cost
`subscription_paid_until`	datetime	Subscription expiration date
`subscription_status`	string	Instance status. `Active` - active `Inactive` - inactive

","urlObject":{"protocol":"https","path":["developer","v1","instances",""],"host":["api","chategy.io"],"query":[{"disabled":true,"description":{"content":"

string | required | External client ID on the developer's side.

\n","type":"text/plain"},"key":"external_id","value":null},{"disabled":true,"description":{"content":"

integer | optional | Number of records, default 100, can be in the range [1, 100]

\n","type":"text/plain"},"key":"per_page","value":null},{"disabled":true,"description":{"content":"

integer | optional | Number of filtered instances, excluding pagination.

\n","type":"text/plain"},"key":"total_count","value":null},{"disabled":true,"description":{"content":"

integer | optional | Specific page, default = 1.

\n","type":"text/plain"},"key":"page","value":null}],"variable":[]}},"response":[{"id":"8f89b77d-47ab-4048-a885-a200a435b96b","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/instances/?external_id=77777","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","instances",""],"query":[{"key":"external_id","value":"77777"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:20:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t25nAma30LDxQAAD9k"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\",\n \"page\": 1,\n \"total_count\": 1,\n \"per_page\": 100\n },\n \"instances\": [\n {\n \"id\": 6329,\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6Mjc4MDcsImRhdGV0aW1lIjoxNzI0MjUxNzcwfQ.3y2y5MxrX1WCXdVA2atmr71d1XGrwY\",\n \"external_id\": \"77777\",\n \"customer_id\": 27807,\n \"subscription_paid_until\": \"2025-10-09\",\n \"renew_subscription\": false,\n \"tdlib_session\": 3,\n \"whatsapp_session\": 0,\n \"whatsapp_queue_size\": 0,\n \"whatsapp_queue_limit\": 50,\n \"whatsapp_phone\": null,\n \"subscription_status\": \"inactive\",\n \"subscription_cost\": \"600.00\"\n }\n ]\n}"},{"id":"fee76e93-3e44-4d18-92ac-6e5f7eed4fba","name":"Error, 404","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/instances/:curstomer_id","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","instances",":curstomer_id"],"variable":[{"key":"curstomer_id","value":"2032","description":"integer | required | unique client ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:22:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t3C5hLP7pJWTgAAM7j"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 404,\n \"message\": \"Not found\",\n \"status\": \"fail\"\n }\n}"}],"_postman_id":"69797b80-5a9b-4bdf-bd6e-55bac02b08fe"},{"name":"Getting information about all instanes","id":"ecdc0fa9-9c55-44ff-b088-346a721de954","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/developer/v1/instances","description":"

Response Parameters

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

Key	Data Type	Description
`id`	integer	Unique instance identifier
`token`	string	Bearer token
`customer_id`	integer	Unique customer identifier
`renew_subscription`	boolean	Instance subscription auto-renewal status. `false` - auto-renewal disabled, `true` - auto-renewal enabled.
`tdlib_session`	integer	Telegram authorization status. Status codes: 0,1,2,3 0 - Awaiting phone number input, 1 - Awaiting code input, 2 - Awaiting password input, 3 - Authorized
`whatsapp_session`	integer	WhatsApp authorization status. Status codes: (0 or 1) 0 - Not authorized, 1 - Authorized
`whatsapp_phone`	string	Authorized user's phone number
`whatsapp_queue_size`	integer	Current number of messages in the WhatsApp queue for this instance. Indicates real-time load on the messaging system.
`whatsapp_queue_limit`	integer	Maximum size of WhatsApp message queue for this instance. Defines the limit of messages that can be queued for sending.
`external_id`	integer	External ID
`subscription_cost`	number	Instance subscription cost
`subscription_paid_until`	datetime	Subscription expiration date
`subscription_status`	string	Instance status. `Active` - active `Inactive` - inactive

","urlObject":{"protocol":"https","path":["developer","v1","instances"],"host":["api","chategy.io"],"query":[{"disabled":true,"description":{"content":"

integer | optional | Number of records, default 100, can be in the range [1, 100]

\n","type":"text/plain"},"key":"per_page","value":""},{"disabled":true,"description":{"content":"

integer | optional | Number of filtered instances, excluding pagination.

\n","type":"text/plain"},"key":"total_count","value":""},{"disabled":true,"description":{"content":"

integer | optional | Specific page, default = 1.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"81f9b5b3-0c67-41ca-8716-7cdf2189998b","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/instances?per_page=2","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","instances"],"query":[{"key":"per_page","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:20:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t25nAma30LDxQAAD9k"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\",\n \"page\": 1,\n \"total_count\": 5,\n \"per_page\": 100\n },\n \"instances\": [\n {\n \"id\": 336,\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0CI6NzEyLCJkYXRldGltZSI6MTcxOTgzNjc4Mn0.7UUCZCWDwvSBGUlZ44twU2Jdbt0CY\",\n \"external_id\": \"234\",\n \"customer_id\": 712,\n \"subscription_paid_until\": \"2025-04-01\",\n \"renew_subscription\": false,\n \"tdlib_session\": 0,\n \"whatsapp_session\": 0,\n \"whatsapp_queue_size\": 0,\n \"whatsapp_queue_limit\": 50,\n \"whatsapp_phone\": null,\n \"subscription_status\": \"inactive\",\n \"subscription_cost\": \"1999.00\"\n },\n {\n \"id\": 361,\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6NzYwLCJkYXRldGltZSI6MTcyNDkyNzcxMH0.lOIkZrATvJYwPiC3gdpdkRlZTw4\",\n \"external_id\": \"113\",\n \"customer_id\": 760,\n \"subscription_paid_until\": \"2024-12-27\",\n \"renew_subscription\": false,\n \"tdlib_session\": 0,\n \"whatsapp_session\": 0,\n \"whatsapp_queue_size\": 0,\n \"whatsapp_queue_limit\": 50,\n \"whatsapp_phone\": null,\n \"subscription_status\": \"inactive\",\n \"subscription_cost\": \"12.00\"\n }\n ]\n}"}],"_postman_id":"ecdc0fa9-9c55-44ff-b088-346a721de954"},{"name":"Instance data changes","id":"a1767c3d-913f-46ac-a3d2-1faa28e9de62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"url":"https://api.chategy.io/developer/v1/instances/:instance_id?renew_subscription=true&external_id&dispatch_routing[]&email&phone&password","urlObject":{"protocol":"https","path":["developer","v1","instances",":instance_id"],"host":["api","chategy.io"],"query":[{"description":{"content":"

boolean | required | List of events. false - do not renew the subscription, true - renew the subscription

\n","type":"text/plain"},"key":"renew_subscription","value":"true"},{"description":{"content":"

string | optional | External ID of the instance in the developers system

\n","type":"text/plain"},"key":"external_id","value":null},{"description":{"content":"

array | optional | Default instance sending channel

\n","type":"text/plain"},"key":"dispatch_routing[]","value":null},{"description":{"content":"

string | optional | Instance email

\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"

string | optional | Instance phone

\n","type":"text/plain"},"key":"phone","value":null},{"description":{"content":"

string | optional | Instance password

\n","type":"text/plain"},"key":"password","value":null}],"variable":[{"description":{"content":"

integer | required | unique identifier of the instance

\n","type":"text/plain"},"type":"any","value":"3748","key":"instance_id"}]}},"response":[{"id":"9ab9e465-7d41-4d09-a0f6-d2afa3c1bac6","name":"Successful result","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:instance_id?renew_subscription=true","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":instance_id"],"query":[{"key":"renew_subscription","value":"true","description":"boolean | required | List of events. false - do not renew the subscription, true - renew the subscription"}],"variable":[{"key":"instance_id","value":"3748","description":"integer | required | unique identifier of the instance"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:35:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"109"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t3tVKNuXAAkcgAA9Fi"}],"cookie":[],"responseTime":null,"body":"{\n \"instance\": {\n \"customer_id\": 20322,\n \"id\": 3748,\n \"renew_subscription\": true\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"}],"_postman_id":"a1767c3d-913f-46ac-a3d2-1faa28e9de62"},{"name":"Activating an instance subscription","id":"646aa049-ff28-41ce-b480-4a2b9a9d0176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chategy.io/developer/v1/instances/:id/renew_subscription","urlObject":{"protocol":"https","path":["developer","v1","instances",":id","renew_subscription"],"host":["api","chategy.io"],"query":[],"variable":[{"description":{"content":"

integer | required | unique identifier of the instance

\n","type":"text/plain"},"type":"any","value":"3748","key":"id"}]}},"response":[{"id":"be56bf8d-7a74-4b95-86b2-25c77b74649f","name":"Successful result","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:id/renew_subscription","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":id","renew_subscription"],"variable":[{"key":"id","value":"3748","description":"integer | required | unique identifier of the instance"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:38:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"102"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t34DmyNjdJHXQABTOh"}],"cookie":[],"responseTime":null,"body":"{\n \"instance\": {\n \"id\": 3748,\n \"subscription_paid_until\": \"2023-12-27\"\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"1190afd3-decb-498e-bd9b-d91d791c54ef","name":"Error, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:id/renew_subscription","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":id","renew_subscription"],"variable":[{"key":"id","value":"3748","description":"integer | required | unique identifier of the instance"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:40:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"123"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t4BYEDTqnVGhIABMui"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"errors\": {\n \"base\": [\n \"not enough money\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": 1\n }\n}"}],"_postman_id":"646aa049-ff28-41ce-b480-4a2b9a9d0176"},{"name":"Interrupting WhatsApp authorization","id":"90ed6fcd-6e1c-4d60-a451-427f74ef79d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.chategy.io/developer/v1/instances/:instance_id/delete_container_session","urlObject":{"protocol":"https","path":["developer","v1","instances",":instance_id","delete_container_session"],"host":["api","chategy.io"],"query":[],"variable":[{"id":"e9fd07e1-8a18-4d1e-8ce1-b809ac94fa27","type":"any","value":"3748","key":"instance_id"}]}},"response":[{"id":"8273ede6-f6d1-448b-a27d-59a2d64a71fd","name":"Successful result","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:instance_id/delete_container_session","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":instance_id","delete_container_session"],"variable":[{"key":"instance_id","value":"3748"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 11:47:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t4YAUjnPjl8sUABxOB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"}],"_postman_id":"90ed6fcd-6e1c-4d60-a451-427f74ef79d8"}],"id":"f1cd40bf-ee77-4e10-be3f-f2a79cee21a7","_postman_id":"f1cd40bf-ee77-4e10-be3f-f2a79cee21a7","description":""},{"name":"Webhooks","item":[{"name":"Creating a webhook","id":"2c94dd00-767a-446c-b728-8cc4f62e61c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chategy.io/developer/v1/webhooks?url=https://example.com&types[]=whatsapp_log_out","urlObject":{"protocol":"https","path":["developer","v1","webhooks"],"host":["api","chategy.io"],"query":[{"description":{"content":"

string | required | The address to which the notification is sent

\n","type":"text/plain"},"key":"url","value":"https://example.com"},{"description":{"content":"

array | required | List of events

\n","type":"text/plain"},"key":"types[]","value":"whatsapp_log_out"}],"variable":[]}},"response":[{"id":"1e9a8c39-b47a-415a-a7f4-72ad5a01ae62","name":"Successful result","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/webhooks?url=https://example.com&types[]=whatsapp_log_out","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","webhooks"],"query":[{"key":"url","value":"https://example.com","description":"string | required | The address to which the notification is sent"},{"key":"types[]","value":"whatsapp_log_out","description":"array | required | List of events"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 12:13:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"116"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t5yvTM1WXUUOsAAVxF"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"webhook\": {\n \"id\": 57,\n \"types\": [\n \"whatsapp_log_out\"\n ],\n \"url\": \"https://example.com\"\n }\n}"},{"id":"cc0e88ba-9a66-4879-bebf-60e05606a294","name":"Error, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/webhooks?url=https://example.com&types[]=whatsapp_log_ou","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","webhooks"],"query":[{"key":"url","value":"https://example.com","description":"string | required | The address to which the notification is sent"},{"key":"types[]","value":"whatsapp_log_ou","description":"array | required | List of events"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 12:13:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"135"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t51F346PSznl4ACuwi"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"errors\": {\n \"types\": [\n \"types invalid\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"}],"_postman_id":"2c94dd00-767a-446c-b728-8cc4f62e61c2"},{"name":"Getting an entry","id":"4747c99f-6705-40ca-9a73-eafc156fb87c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/developer/v1/webhooks/:id","urlObject":{"protocol":"https","path":["developer","v1","webhooks",":id"],"host":["api","chategy.io"],"query":[],"variable":[{"description":{"content":"

integer | required | unique identifier of a specific record

\n","type":"text/plain"},"type":"any","value":"57","key":"id"}]}},"response":[{"id":"f68a5c3d-f37a-4b81-a2d0-1696308e66bb","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/webhooks/:id","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","webhooks",":id"],"variable":[{"key":"id","value":"57","description":"integer | required | unique identifier of a specific record"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 12:17:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"116"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t6B8S795p2BOMAA5Mk"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"webhook\": {\n \"id\": 57,\n \"types\": [\n \"whatsapp_log_out\"\n ],\n \"url\": \"https://example.com\"\n }\n}"}],"_postman_id":"4747c99f-6705-40ca-9a73-eafc156fb87c"},{"name":"Getting all the records","id":"25824bbf-0e94-4fad-9683-02ebae077d73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chategy.io/developer/v1/webhooks","urlObject":{"protocol":"https","path":["developer","v1","webhooks"],"host":["api","chategy.io"],"query":[],"variable":[]}},"response":[{"id":"ac9a8f02-459f-4475-a4ab-aa5501b51925","name":"Successful result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":"https://api.chategy.io/developer/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 12:28:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t6mOZ408rQZhcABC1E"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"webhooks\": [\n {\n \"id\": 57,\n \"types\": [\n \"whatsapp_log_out\"\n ],\n \"url\": \"https://example.com\"\n }\n ]\n}"}],"_postman_id":"25824bbf-0e94-4fad-9683-02ebae077d73"},{"name":"Deleting an entry","id":"80e0be87-80ba-495e-b44d-b69617c924cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.chategy.io/developer/v1/webhooks/:id","urlObject":{"protocol":"https","path":["developer","v1","webhooks",":id"],"host":["api","chategy.io"],"query":[],"variable":[{"description":{"content":"

integer | required | unique identifier of a specific record

\n","type":"text/plain"},"type":"any","value":"22","key":"id"}]}},"response":[{"id":"9d60ca56-a8ce-4574-b647-3cb7bb5e769d","name":"Successful result","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/webhooks/:id","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","webhooks",":id"],"variable":[{"key":"id","value":"55","description":"integer | required | unique identifier of a specific record"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 12:26:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t6h2Dwo7ntd10ACYPj"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"}],"_postman_id":"80e0be87-80ba-495e-b44d-b69617c924cd"},{"name":"Changing an entry","id":"1fee7b97-45cb-498f-a205-c569f453371c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"url":"https://api.chategy.io/developer/v1/webhooks/:id?types[]=whatsapp_log_out&url=https://example2.com","urlObject":{"protocol":"https","path":["developer","v1","webhooks",":id"],"host":["api","chategy.io"],"query":[{"description":{"content":"

array | required | Collected list

\n","type":"text/plain"},"key":"types[]","value":"whatsapp_log_out"},{"description":{"content":"

string | required | The address to which the notification is sent

\n","type":"text/plain"},"key":"url","value":"https://example2.com"}],"variable":[{"description":{"content":"

integer | required | unique identifier of a specific record

\n","type":"text/plain"},"type":"any","value":"57","key":"id"}]}},"response":[{"id":"70921d40-65c2-48ad-976c-81515a3076ce","name":"Successful result","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chategy.io/developer/v1/webhooks/:id?types[]=whatsapp_log_out&url=https://example2.com","protocol":"https","host":["api","chategy.io"],"path":["developer","v1","webhooks",":id"],"query":[{"key":"types[]","value":"whatsapp_log_out","description":"array | required | Collected list"},{"key":"url","value":"https://example2.com","description":"string | required | The address to which the notification is sent"}],"variable":[{"key":"id","value":"57","description":"integer | required | unique identifier of a specific record"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 27 Nov 2023 12:32:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"117"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5t60ItNgaqeHlcACkTj"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"webhook\": {\n \"id\": 57,\n \"types\": [\n \"whatsapp_log_out\"\n ],\n \"url\": \"https://example2.com\"\n }\n}"}],"_postman_id":"1fee7b97-45cb-498f-a205-c569f453371c"}],"id":"c2d4b8a6-9943-432b-8b29-6ca924ee4872","description":"

List of webhook events

\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

Types	Description
whatsapp_log_out	Information about deauthorization of the client in whatsapp
whatsapp_log_in	Information about the client's authorization in whatsapp
whatsapp_incoming_msg	Information about incoming and outgoing messages to an authorized whatsapp account. Messages are collected from the moment of authorization.
tdlib_incoming_msg	Information about incoming and outgoing messages to an authorized Telegram account.
whatsapp_status_msg	Information about the statuses of outgoing messages from an authorized WhatsApp account.

Notification example - whatsapp_log_out

{\n  \"type\": \"whatsapp_log_out\"\n  \"payload\": {\n      \"customer_id\": 591,\n      \"email\": \"example@gmail.ru\",\n      \"phone\": \"+9959123456789\"\n      \"status\": {\n        \"status_id\": 1,\n        \"description\": \"disconnected\"\n      }\n    }\n  }\n}\n\n

Notification example - whatsapp_log_in

{\n  \"type\": \"whatsapp_log_in\",\n  \"payload\": {\n    \"instance\": {\n      \"id\": 368,\n      \"status\": {\n        \"description\": \"connected\",\n        \"status_id\": 0\n      },\n      \"phone\": \"+420774948868\",\n      \"email\": \"rerweq@fsdfs\",\n      \"customer_id\": 1050\n    }\n  }\n}\n\n

Parameters

\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

Key	Data Type	Description
instance	object	Instance object
id	integer	Instance ID
customer_id	integer	Internal Client ID
email	string	Client's email
phone	string	Client's phone
status	object	Status object
status_id	integer	Status ID
description	string	Short description of the status

Notification example - whatsapp_incoming_msg

\n
Notifications have a different structure, depending on the content of the message. Below are examples of text notifications and file notifications. The system takes the image/file and converts it into a download link.
\n

Outgoing:

{\n  \"type\": \"whatsapp_incoming_msg\",\n  \"payload\": {\n    \"instance\": {\n      \"id\": 6329,\n      \"customer_id\": 2707\n    },\n    \"new_message\": {\n      \"message\": {\n        \"id\": \"true_95555558974@c.us_d292906746THISISBOT\",\n        \"timestamp\": 1764069292,\n        \"type\": \"document\",\n        \"reply_to_message_id\": null,\n        \"file_data\": {\n          \"mime_type\": \"application/msword\",\n          \"caption\": \"file new\",\n          \"download_url\": \"https://production-docs.storage.yandexcloud.net/delivery_files_new/83a38f/e901c444/288d0008/fd5702ea/test.doc?X-Amz-AlgorithHMAC-SHA256&X-Amz-Credential=bipj3XwGMXa8-wO4T3mc/20251125/ru-central1/s3/aws4_request&X-A-Date=20251125T111456Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Signature=cd3955e831bb20c736f5dee570667a8e12017e51471e2872d61df0ee8760e\"\n        }\n      },\n      \"direction\": \"outgoing\",\n      \"sender_id\": \"996453558974@c.us\",\n      \"chat_id\": \"95555558974@c.us\",\n      \"sender_name\": \"Test\",\n      \"chat_lid\": \"4846447809451@lid\",\n      \"pushname\": \"Test1\",\n      \"chat_phone\": \"95555558974\",\n      \"sender_phone_number\": \"996453558974\",\n      \"recipient_id\": \"995555558974@c.us\",\n      \"recipient_phone_number\": \"995555558974\"\n    },\n    \"delivery_id\": 29290746\n  }\n}\n\n

Outgoing with the file:

{\n  \"type\": \"whatsapp_incoming_msg\",\n  \"payload\": {\n    \"new_message\": {\n      \"message\": {\n        \"id\": \"true_995555558974@c.us_2A7B9368F38D549F6339\",\n        \"timestamp\": 1764081041,\n        \"type\": \"image\",\n        \"reply_to_message_id\": null,\n        \"file_data\": {\n          \"mime_type\": \"image/jpeg\",\n          \"caption\": null,\n          \"download_url\": \"https://production-docs.storage.yandexcloud.net/delivery_files_new/a99c05ed/aaac1071/87037d32/0bb618ca/1764081046_media.jpg?X-Amz-Algorithm=AWS4-HMAC-SH2F20251125/ru-central1/s3/aws4_request&X-Amz-Date=20251125T143046Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Signature=feb45c97ca3d533d45e0838bd2bcba01d7ee714c9771902e64a30f026986837a\"\n        }\n      },\n      \"direction\": \"outgoing\",\n      \"sender_id\": \"996453558974@c.us\",\n      \"chat_id\": \"995555558974@c.us\",\n      \"sender_name\": \"Тестовый\",\n      \"chat_lid\": \"4846447809341@lid\",\n      \"pushname\": \"Chatpush\",\n      \"chat_phone\": \"995555558974\",\n      \"sender_phone_number\": \"996453558974\",\n      \"recipient_id\": \"995555558974@c.us\",\n      \"recipient_phone_number\": \"995555558974\"\n    },\n    \"delivery_id\": null,\n    \"customer_id\": 4140\n  }\n}\n\n

Incoming:

{\n  \"type\": \"whatsapp_incoming_msg\",\n  \"payload\": {\n    \"instance\": {\n      \"id\": 6329,\n      \"customer_id\": 2707\n    },\n    \"new_message\": {\n      \"message\": {\n        \"id\": \"false_995555558974@c.us_3B55D8ECE08DAC8198EB\",\n        \"timestamp\": 1764069562,\n        \"type\": \"text\",\n        \"text\": \"text\",\n        \"reply_to_message_id\": null\n      },\n      \"direction\": \"incoming\",\n      \"sender_id\": \"995555558974@c.us\",\n      \"chat_id\": \"995555558974@c.us\",\n      \"sender_name\": \"\\u202a+995555558974\\u202c\",\n      \"chat_lid\": \"48464478093451@lid\",\n      \"pushname\": \"Test\",\n      \"chat_phone\": \"995555558974\",\n      \"sender_phone_number\": \"995555558974\"\n    },\n    \"delivery_id\": null\n  }\n}\n\n

Incoming with the file:

{\n  \"type\": \"whatsapp_incoming_msg\",\n  \"payload\": {\n    \"instance\": {\n      \"id\": 6329,\n      \"customer_id\": 27807\n    },\n    \"new_message\": {\n      \"message\": {\n        \"id\": \"false_995555558974@c.us_3B56F737211AAED838CC\",\n        \"timestamp\": 1764069613,\n        \"type\": \"document\",\n        \"reply_to_message_id\": null,\n        \"file_data\": {\n          \"mime_type\": \"image/jpeg\",\n          \"caption\": \"text\",\n          \"download_url\": \"https://production-docs.storage.yandexcloud.net/delivery_files_new/36f0d65a/d834a720/e8493c3c/2c9e8af9/1764069615_media.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=bipj3XwGMXa8-wO4T3mc/20251125//s3/aws4_request&X-Amz-Date=20251125T112&X-Aires=172800&X-Amz-SignedHeaders=host&X-Amz-Signature=c02ce108e06634c7f24958be34606aa2b9892a1f787458a8b0c8afeb1e0bb5c8\"\n        }\n      },\n      \"direction\": \"incoming\",\n      \"sender_id\": \"995555558974@c.us\",\n      \"chat_id\": \"995555558974@c.us\",\n      \"sender_name\": \"\\u202a+995555558974\\u202c\",\n      \"chat_lid\": \"48464478022451@lid\",\n      \"pushname\": \"Test\",\n      \"chat_phone\": \"995555558974\",\n      \"sender_phone_number\": \"995555558974\"\n    },\n    \"delivery_id\": null\n  }\n}\n\n

Parameters

Key	Data Type	Description
`type`	string	Webhook type
`payload.instance.id`	integer	Internal instance ID
`payload.instance.customer_id`	integer	Internal customer ID
`payload.new_message.message.id`	string	Internal WhatsApp message ID
`payload.new_message.message.timestamp`	integer	Timestamp when the message was sent
`payload.new_message.message.type`	string	Type of transmitted object
`payload.new_message.message.text`	string	Message text (for text messages)
`payload.new_message.message.reply_to_message_id`	string	ID of the message being replied to
`payload.new_message.direction`	string	Message type. incoming - incoming, outgoing - outgoing
`payload.new_message.sender_id`	string	Message sender ID
`payload.new_message.chat_id`	string	ID of the chat where the conversation takes place
`payload.new_message.sender_name`	string	User name in WhatsApp
`payload.new_message.chat_lid`	string	Chat lid ID. For outgoing - where we send to, for incoming - where we receive from
`payload.new_message.pushname`	string	User name as the contact saved themselves in WhatsApp
`payload.new_message.chat_phone`	integer	Recipient number. For outgoing - where we send to, for incoming - where we receive from
`payload.new_message.sender_phone_number`	string	Sender phone number
`payload.new_message.recipient_id`	string	ID of the chat where the conversation takes place
`payload.new_message.recipient_phone_number`	integer	Recipient number
`payload.delivery_id`	integer	Internal delivery ID. When sending not from the system, the parameter will be empty

Additional fields for messages with files

\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

Key	Data Type	Description
`payload.new_message.message.file_data`	object	Delivery object
`payload.new_message.message.file_data.mime_type`	string	File format
`payload.new_message.message.file_data.caption`	string	Description under the file
`payload.new_message.message.file_data.download_url`	string	File download link

_ Notification example - tdlib_incoming_msg_

Outgoing:

{\n\"payload\": {\n\"chat_id\": 37916707,\n\"chat_type\": \"person\",\n\"delivery_id\": 170405,\n\"direction\": \"outgoing\",\n\"instance\": {\n\"customer_id\": 77,\n\"id\": 2822\n},\n\"message\": {\n\"id\": 978172510208,\n\"text\": \"this is a test message\",\n\"timestamp\": 1691585795,\n\"type\": \"FormattedText\"\n},\n\"sender_id\": 4335465,\n\"sender_name\": \"test\",\n\"sender_phone_number\": \"995550846453\",\n\"recipient_id\": 37916707,\n\"recipient_phone_number\": \"971568961134\",\n\"recipient_username\": \"test2\"\n},\n\"type\": \"tdlib_incoming_msg\"\n}\n\n

Incoming:

{\n\"payload\": {\n\"chat_id\": 379163707,\n\"chat_type\": \"person\",\n\"delivery_id\": null,\n\"direction\": \"incoming\",\n\"instance\": {\n\"customer_id\": 530,\n\"id\": 316\n},\n\"message\": {\n\"id\": 49283072,\n\"text\": \"text\",\n\"timestamp\": 1700828134,\n\"type\": \"formattedText\"\n},\n\"sender_id\": 379163707,\n\"sender_name\": \"mdyageleva\",\n\"sender_phone_number\": \"995550846453\"\n},\n\"type\": \"tdlib_incoming_msg\"\n}\n\n

Parameters

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

Key	Data Type	Description
`type`	string	Webhook type
`payload.instance.id`	integer	Internal instance ID
`payload.instance.customer_id`	integer	Internal customer ID
`payload.chat_id`	integer	ID of the chat where the conversation takes place
`payload.chat_type`	string	Chat type
`payload.delivery_id`	integer	Internal delivery ID. When sending not from the system (via chat), the parameter will be empty
`payload.direction`	string	Message type. Incoming - incoming, outgoing - outgoing
`payload.message.id`	integer	Internal message ID
`payload.message.timestamp`	integer	Timestamp when the message was sent
`payload.message.type`	string	Type of transmitted object
`payload.message.reply_to_message_id`	string	ID of the message being replied to
`payload.sender_id`	integer	Message sender ID
`payload.sender_name`	string	Sender name
`payload.sender_phone_number`	string	Sender phone number
`payload.recipient_id`	integer	Recipient ID
`payload.recipient_phone_number`	string	Recipient phone number
`payload.recipient_username`	string	Recipient username

Additional fields for messages with files

\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

Key	Data Type	Description
`payload.message.file_data`	object	Delivery object
`payload.message.file_data.mime_type`	string	File format
`payload.message.file_data.caption`	string	Description under the file
`payload.message.file_data.download_url`	string	File download link

Telegram call

          \"payload\": {\n            \"call\": {\n              \"id\": 9,\n              \"is_video\": false,\n              \"reason\": \"callDiscardReasonDisconnected\",\n              \"state\": \"callStateDiscarded\"\n            },\n            \"chat_id\": 6888055,\n            \"chat_type\": \"person\",\n            \"direction\": \"incoming\",\n            \"instance\": {\n              \"customer_id\": 1011,\n              \"id\": 377\n            },\n            \"sender_id\": 68880855,\n            \"sender_name\": \"TestName\",\n            \"sender_phone_number\": \"995598464533\"\n          },\n          \"type\": \"tdlib_call\"\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`payload`	`object`	Webhook data container
`payload.type`	`string`	Webhook type. Always `tdlib_call`
`payload.chat_id`	`number`	ID of chat where call occurred
`payload.chat_type`	`string`	Chat type (e.g. `person` - private chat)
`payload.direction`	`string`	Call direction: `incoming` or `outgoing`
`payload.instance`	`object`	Instance information (for developer-originated calls)
`payload.instance.customer_id`	`number`	Internal customer ID linked to instance
`payload.instance.id`	`number`	Unique instance ID
`payload.sender_id`	`number`	ID of user who initiated the call
`payload.sender_name`	`string`	Name of calling user
`payload.sender_phone_number`	`string`	User's phone number (E.164 format)
`payload.call`	`object`	Call details
`payload.call.id`	`number`	Unique call ID
`payload.call.is_video`	`boolean`	Whether call was video (`true`/`false`)
`payload.call.state`	`string`	Current call state. Possible value: `callStateDiscarded` (ended)
`payload.call.reason`	`string`	Call termination reason: • `callDiscardReasonAllowGroupCall` - ended to join group call • `callDiscardReasonDeclined` - declined • `callDiscardReasonDisconnected` - connection lost • `callDiscardReasonEmpty` - ended without reason • `callDiscardReasonHungUp` - ended by user • `callDiscardReasonMissed` - missed call

Notification example - whatsapp_status_msg

The status is only sent for outgoing messages from an authorized client

Example of a message status webhook:

{\n  \"type\": \"message_status\",\n  \"payload\": {\n    \"instance\": {\n      \"id\": 37,\n      \"customer_id\": 111\n    },\n    \"delivery_id\": null,\n    \"message_status\": {\n      \"id\": \"true_995555123456@c.us_8110THISISBOT\",\n      \"status\": \"read\",\n      \"chat_id\": \"995555123456@c.us\"\n      \"chat_id\": \"995555123456@c.us\"\n      \"chat_lid\": \"4846447809351@lid\",\n    }\n  }\n}\n\n

Description of message status webhook parameters:

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

Key	Data Type	Description
`type`	string	Event type
`payload`	object	Main event data
`payload.instance`	object	Account information
`payload.instance.id`	number	Internal instance ID
`payload.instance.customer_id`	number	Internal client ID
`payload.delivery_id`	number	Internal deliveries ID
`payload.message_status`	object	Message status data
`payload.message_status.id`	string	Unique message status ID (format for chatpush service: `\"true_995555123456@c.us_84110THISISBOT\"`, format for other sending methods: `\"true_995555123456@c.us_3A2E74ED29DF9BAB114E\"`)
`payload.message_status.status`	string	Message status
`payload.message_status.chat_id`	string	Chat ID in `\"995555123456@c.us\"` format (phone number
`payload.message_status.chat_lid`	string	Chat lid ID. For outgoing - where we send to, for incoming - where we receive from
`payload.message_status.chat_phone`	integer	Recipient number. For outgoing - where we send to, for incoming - where we receive from

List of transmitted statuses:

\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

Status	Meaning
sent	Message sent to WhatsApp server
received	Delivered to recipient's device
read	Read by recipient
played	Played (audio messages only)
failed	Failed to send message
expired	Message expired (e.g., no network connection for too long)
content_gone	Content no longer available (e.g., deleted or expired)
content_too_big	Content too large to send
content_unuploadable	Content cannot be uploaded (possibly corrupted)
inactive	User inactive (e.g., account deleted or banned)

Incoming Call Webhook

Sent as part of the \"whatsapp_incoming_msg\" event
\n
Only sent for incoming calls to authorized clients
\n
Contains call information
\n
Sent when the call is received on the account
\n

Example of an incoming call webhook:

{\n  \"type\": \"whatsapp_call\",\n  \"payload\": {\n    \"instance\": {\n      \"id\": 39,\n      \"customer_id\": 111\n    },\n    \"incoming_call\": {\n      \"call\": {\n        \"id\": \"280F899CBF131466501CDA1B608\",\n        \"timestamp\": 1751293264,\n        \"type\": \"audio\",\n        \"is_group\": false\n      },\n      \"direction\": \"incoming\",\n      \"sender_id\": \"995555123456@c.us\",\n      \"chat_id\": \"995555123456@c.us\",\n      \"chat_lid\": \"48464478093451@lid\",\n      \"chat_phone\": \"995555123456\",\n      \"sender_phone_number\": \"995555123456\"\n    }\n  }\n}\n\n

Description of incoming call webhook parameters:

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

Key	Data Type	Description
`type`	string	Event type
`payload`	object	Main event data
`payload.instance`	object	Account information
`payload.instance.id`	number	Internal instance ID
`payload.instance.customer_id`	number	Internal client ID
`payload.incoming_call`	object	Incoming call data
`payload.incoming_call.call`	object	Call information
`payload.incoming_call.call.id`	string	Unique call ID (hash, e.g. `\"280F899C331466501CDA1B608\"`)
`payload.incoming_call.call.timestamp`	number	Unix timestamp of call (e.g. `1751293264`)
`payload.incoming_call.call.type`	string	Call type: `\"audio\"` or `\"video\"`
`payload.incoming_call.call.is_group`	boolean	Group call: `true`/`false`
`payload.incoming_call.direction`	string	Call direction: `\"incoming\"`
`payload.incoming_call.sender_id`	string	Sender ID in `\"@c.us\"` format
`payload.incoming_call.chat_id`	string	Chat ID in `\"@c.us\"` format
`payload.incoming_call.sender_phone_number`	string	Sender's
`payload.incoming_call.chat_lid`	string	Chat lid ID. For outgoing - where we send to, for incoming - where we receive from
`payload.incoming_call.chat_phone`	integer	Recipient number. For outgoing - where we send to, for incoming - where we receive from

","_postman_id":"c2d4b8a6-9943-432b-8b29-6ca924ee4872"},{"name":"Authorization of messengers","item":[{"name":"MAX Authorization","item":[{"name":"Phone number verification","item":[{"name":"Phone number verification","id":"92b884dd-1872-4e54-bdfe-04b1005e4772","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/api/v1/max/send_phone?phone=79811597745","urlObject":{"protocol":"https","path":["api","v1","max","send_phone"],"host":["api","chatpush","ru"],"query":[{"description":{"content":"

string | required | Customer's phone number. International format (79991112233). Russian numbers may also use 8-prefix format (89991112233).

\n","type":"text/plain"},"key":"phone","value":"79811597745"}],"variable":[]}},"response":[{"id":"749327a2-2fa3-46b9-aed0-32f78af39476","name":"Successful Result","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/max/send_phone?phone=79811597745","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","max","send_phone"],"query":[{"key":"phone","value":"79811597745"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:29:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeXT6hOmjJCCHgAB-nC"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"9e3d7046-8939-4771-9179-21f2c3d70281","name":"422 error (Phone number has invalid format)","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/max/send_phone?phone=7981159774","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","max","send_phone"],"query":[{"key":"phone","value":"7981159774"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:30:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"142"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeXXgZ86__nzkcACBci"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"phone\": [\n \"Phone number has invalid format\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"e6f22688-2b13-4b2a-818e-a4437bbbf418","name":"422 error (Phone number can't be blank)","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/max/send_phone?phone=","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","max","send_phone"],"query":[{"key":"phone","value":""}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:31:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"138"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeXa2KFyeCa0q4ACFDi"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"phone\": [\n \"Phone number can't be blank\"\n ]\n },\n \"status_id\": null\n }\n}"}],"_postman_id":"92b884dd-1872-4e54-bdfe-04b1005e4772"}],"id":"59426a74-a9cb-441f-84f9-319bb4078b1e","description":"

Phone number verification.
Authentication: Bearer TokenEndFragment

\n","_postman_id":"59426a74-a9cb-441f-84f9-319bb4078b1e"},{"name":"Code confirmation","item":[{"name":"Code confirmation","id":"1e7280ae-eb64-42c7-818d-d32598794d4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/api/v1/max/send_code?code=848158","urlObject":{"protocol":"https","path":["api","v1","max","send_code"],"host":["api","chatpush","ru"],"query":[{"description":{"content":"

string | required | SMS verification code.

\n","type":"text/plain"},"key":"code","value":"848158"}],"variable":[]}},"response":[{"id":"3536ea9d-aa86-42b3-9534-45b8519873cb","name":"422 error (confirmation code invalid)","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/max/send_code?code=346484","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","max","send_code"],"query":[{"key":"code","value":"346484"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:36:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"148"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeXusflGoXjd28ACgAB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"confirmation_code\": [\n \"confirmation code invalid\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"49d5bd39-b5f2-4241-9bff-963b527ef2c4","name":"422 error (code can't be blank)","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/max/send_code?code=","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","max","send_code"],"query":[{"key":"code","value":""}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:37:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"129"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeXyTr-8H4e6KoACikB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"code\": [\n \"code can't be blank\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"17b6d738-6709-4b30-a5fd-9b64723f43ee","name":"Successful Result","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/max/send_code?code=848158","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","max","send_code"],"query":[{"key":"code","value":"848158"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:39:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeX36C6288HaqIACWgD"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"}],"_postman_id":"1e7280ae-eb64-42c7-818d-d32598794d4e"}],"id":"bf68f6ee-97f6-49c2-afef-dd2acc54c3de","description":"

Code confirmation.
Authentication: Bearer TokenEndFragment

\n","_postman_id":"bf68f6ee-97f6-49c2-afef-dd2acc54c3de"},{"name":"Session reset","item":[{"name":"Session reset","id":"f0320749-7eca-4dc2-8a2c-38f5f1eb4295","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/api/v1/max/close_session","urlObject":{"protocol":"https","path":["api","v1","max","close_session"],"host":["api","chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"8d2a099b-8119-4665-8844-83d9e07cc4d2","name":"Successful Result","originalRequest":{"method":"POST","header":[],"url":"https://api.chatpush.ru/api/v1/max/close_session"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:43:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeYEW16kpqerJAACi3C"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"95cf36ab-309a-425b-8365-777ba07ca41a","name":"422 error (max_session_closer session_not_found)","originalRequest":{"method":"POST","header":[],"url":"https://api.chatpush.ru/api/v1/max/close_session"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 Sep 2025 11:46:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"160"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGeYPcir9cTZR9AACkhD"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"max_session_closer\": [\n \"max_session_closer session_not_found\"\n ]\n },\n \"status_id\": null\n }\n}"}],"_postman_id":"f0320749-7eca-4dc2-8a2c-38f5f1eb4295"}],"id":"947c354f-0645-442a-bc7f-902b62cdbe4a","description":"

Session reset.
Authentication: Bearer Token

\n","_postman_id":"947c354f-0645-442a-bc7f-902b62cdbe4a"}],"id":"c7e6ccff-5599-4ee4-a56e-e1e834ec81b7","description":"

Phone number verification, code confirmation, session reset.
Authentication: Bearer Token

\n","_postman_id":"c7e6ccff-5599-4ee4-a56e-e1e834ec81b7"}],"id":"0b6199af-06cc-4014-b424-1b454afd92f0","description":"

WSS Telegram Tdlib authorization

1. Connect to a web socket

Request

wss://api.chategy.io/socket/websocket?token=client_ token&vsn=2.0.0\n\n

Successful response

Connected to wss://api.chategy.io/socket/websocket?token=client_ token&vsn=2.0.0\n\n

2. Connecting to the channel

To connect to the desired channel, you must be authorized, that is, the initial connection with the correct token (step 1).
And the wedge can be obtained from the JWT token. An example of the work on obtaining the data from the JWT token can be viewed here [https://jwt.io /](https://jwt.io /)
Request

[\"1\",\"1\",\" number:v1:telegram:auth\",\"phx_join\",{}]\n\n

\"1\", \"1\" The first two parameters can be any, they are necessary to ensure idempotence, if necessary for the client
\n
connection number:v1:telegram:auth
\n
phx_join group on connection
\n
{} additional parameters, you can leave them empty
After connecting to the waiting channel for n seconds, the current state of automation in the video will be transmitted to the kant:
\n
```
    \\[\"1\",null,\"room:v1:telegram:auth\",\"auth_state\",{\"status\":\"status_authorization\"}\\]\n\n
```
\n

Authorization codes:

wait_phone - waiting for the cancellation of the phone number
\n
wait_code - waits for the confirmation code to be canceled
\n
wait_password - waiting for password cancellation
\n
authorized - authorized
\n
3. Sending a phone number
\n

Request

[\"1\",\"1\",\" number:version 1:telegram:auth\",\"send_phone\",{\"telemon\": \"client's phone number\"}]\n\n

Successful response

\\[\"1\",\"1\",\" number:version 1:telegram:auth\",\"phx_reply\",{\"reply\":{},\"status\":\"ok\"}\\]\n\n

Response with invalid phone number

[\n\"1\",\n\"1\",\n\"room:v1:telegram:auth\",\n\"phx_reply\",\n{\n\"response\": {\n\"meta\": {\n\"code\": 422,\n\"errors\": {\"base\": [\"invalid phone\"] },\n\"connection\": \"Raw object\",\n\"status\": \"failed\",\n\"status_id\": null\n}\n},\n\"status\": \"error\"\n}\n]\n\n

4. Sending a confirmation code

Request

\\[\"1\",\"1\",\" number:v1:telegram:auth\",\"send_code\",{\"code\": \"your_confirmation code\"}\\]\n\n

Successful response

[\"1\",\"1\",\" number:version 1:telegram:auth\",\"phx_reply\",{\"reply\":{},\"status\":\"ok\"}]\n\n

5. Sending a password

Request

\\[\"1\",\"1\",\" number:version 1:telegram:auth\",\"send_password\",{\"password\": \"password\"}\\]\n\n

Successful response

[\"1\",\"1\",\" number:version 1:telegram:auth\",\"phx_reply\",{\"reply\":{},\"status\":\"ok\"}]\n\n

6. Reset authorization

Request

\\[\"1\",\"1\",\" number:v1:telegram:auth\",\"reset\",{}\\]\n\n

Successful response

[\"1\",\"1\",\" number:version 1:telegram:auth\",\"phx_reply\",{\"reply\":{},\"status\":\"ok\"}]\n\n

WSS Whatsapp authorization

Getting a QR code for authorization

It is impossible to access the WSS

To access the content throughout, it is advisable to transfer data or IP, where to start requesting.

wss://msg-farmer.pushsms.ru/socket/websocket?token=your clent token&vsn=2.0.0

If the connection is successful, the service returns a message:

Connected to wss://msg-farmer.pushsms.ru/socket/websocket?token=your token wedge&vsn=2.0.0

Request to connect to the WSS

To connect, you need to:

* be authorized, that is, the initial connection with the correct token

* room_id it is necessary to register with the client ID

And the wedge can be obtained from the JWT token. An example of the work on obtaining the data from the JWT token can be viewed here [https://jwt.io /](https://jwt.io /)

For more information, it is impossible to refuse to listen to the comanche on the VSS proto - cola:

[“1”,”1”,“ info:version 1:whats_app:auth:room_id”,“phx_join\",{}]

– “1\", ”1” The first two parameters can be any, they are necessary to ensure idempotence, if necessary for the client

– the key to connect:v1:whats_app:auth

– room_id, which can be used with the user ID

– phx_join command on connection

– {} additional parameters, you can leave them empty

After connecting to the “room”, the user decided to try to switch to a text connection with a QR code:

Creating a container

[\n1,\n1,\n\"number:v1:whats_app:auth:77\",\n\"phx_reply\",\n{\n\"reply\": {},\n\"status\": \"ok\"\n}\n]\n\n

Example of a creation error:

\\[  \n1,  \nnull,  \n\"number:v1:whats_app:auth:77\",  \n\"auth_state\",  \n{  \n\"auth\": false,  \n\"qr_code\": null  \n}  \n\\]\n\n

Successful result:

[\n1,\nnull,\n\"number:v1:whats_app:auth:77\",\n\"auth_state\",\n{\n\"auth\": false,\n\"qr_code\":\n\"2@NqUcv7om4BWqrgF5D6jn51M1hptMR/lK+QmZAxm9aLCKEq9NMgH08slb1Ydmu1ywEWu8CFc\nUil8uGw==,XRJHShEHeWrVRFIyJys2I8WWjlml7m6hKL53oXH0bDA=,3wkQDqsvB0hT19CWs1O\njuBD5sp/IFhT+qQmpTlHFYhE=,iDrOCe/r5/NzI+N3bZkjBX6GbIKW4EhTuplW9jb+/mY=\"\n}\n]\n\n

Copy

qr_code – a QR code is registered in the form of a card that cannot be converted into a QR code. It might be worth looking at now [https://www.qr-code-generator.com /](https://www.qr-code-generator.com /)

Author – says that he scanned the QR code or not

The user has logged in, an example of a successful result:

\\[  \n1,  \nnull,  \n\"number:v1:whats_app:auth:5390\",  \n\"auth_state\",  \n{  \n\"auth\": true  \n}  \n\\]\n\n

What to do if the BCC was not saved by an important factor preventing heartbeat
[null,“24”,“phnix\",“heartbeat\",{}]
During the lifetime of the 30-40\" QR code, We transmit QR with a frequency of 300 ms, make sure that the WSS connection is not disclosed and the user gets access to the updated code with an optional frequency, which avoids downloading outdated QR and paid authorization.
Sample JavaScript code

the WhatsAppSocket javascript class {\nconfigurator() {}\nchange_auth_status(status, qr_code) {\nif (status==false && qr_code== null) {\nreturn;\n}\nif (status == true) {\nconsole.log(\"WhatsApp is connected\");\n} else {\nconsole.log(\"WhatsApp is not connected\");\n}\n}\nshow_qr_code(status, qr_code) {\nif (status==false && qr_code == null) {\nreturn;\n}\nif (status ==true) {\n// when scanned\nstore.dispatch(\"getWhatsappStatus\");\nreturn;\n}\nif (qr_code) {\n// creating a qr code\nqrValue.value = qr_code;\n}\n}\nshow_in_progress(status) {\nif (status==true) {\nconsole.log('status' + true);\n}\n}\nshow_reboot_page() {\nallow auth_state = $(\"#auth\").data().state;\nif (auth_state == false) {\nconsole.log(auth_state);\n}\nconsole.log(auth_state);\n}\ninit_connect(user ID, api_key) {\nlet socket = new socket(\"wss://msg-farmer.pushsms.ru/socket\", {\nparameters: { token: api_key},\nadministrator: (view, message, data) => {\nconsole.log(`${kind}: ${msg}`, data);\n},\n});\nsocket.connect();\nsocket.onOpen((ev) => console.log(\"OPEN\", ev));\nrazem.onError((ev) => console.log(\"ERROR\", ev));\nconnector.onClose((e) => console.log(\"CLOSE\", e));\nvar chan = socket.channel(`room:v1:whats_app:auth:${customer_id}`, {});\nchan.on(\"auth_state\", (msg) => {\nconsole.log(\"enable connection\");\nconsole.log(connection);\nenter auth = msg.auth;\nenter qr_code = msg.qr_code;\nenter in_progress = msg.in_progress;\nthis.change_auth_status(auth, qr_code);\nthis.show_qr_code(auth, qr_code);\nthis.show_in_progress(in_progress);\n});\nchannel\n.join()\n.receive(\"play\", () => console.log(\"log in\"))\n.receive(\"ok\", () => console.log(\"connect ok\"));\nchan.onError((e) => console.log(\"something went wrong\", e));\nchannel.OnClose((e) => {\nthis.show_reboot_page(e);\nconsole.log(\"channel closed\", e);\n});\n}\n}\n\n

","_postman_id":"0b6199af-06cc-4014-b424-1b454afd92f0"}],"id":"c06740c4-7030-487d-a8d5-1e71c17a3592","description":"

Authorization

The project uses api_key authorization. The required api_key can be obtained from the chat administrator or in the developer's personal account.

All relevant requests in headers must contain the following:

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

Key	Value
Authorization	{api_key}

If these parameters are missing or invalid, the response will have: HTTP code 401 (Not authorized).

\n","_postman_id":"c06740c4-7030-487d-a8d5-1e71c17a3592"}],"event":[{"listen":"prerequest","script":{"id":"39a1ce35-db66-4f22-bd96-30df6a4307e0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"18caa7ea-58c9-4011-aae9-e30e9c8fa07a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"host","value":"chategy.io"}]}

Callback of the sending status

Общие сведения

Описание параметров ответа

Idempotence of requests

Cascading sending (WhatsApp, Telegram)

List of service statuses

List of traffic categories

Authorization

Response Parameters

Response Parameters

Notification example - whatsapp_log_out

Notification example - whatsapp_log_in

Notification example - whatsapp_incoming_msg

_ Notification example - tdlib_incoming_msg_

Notification example - whatsapp_status_msg

Incoming Call Webhook

WSS Telegram Tdlib authorization

1. Connect to a web socket

2. Connecting to the channel

3. Sending a phone number

4. Sending a confirmation code

5. Sending a password

6. Reset authorization

WSS Whatsapp authorization

Getting a QR code for authorization

It is impossible to access the WSS

Request to connect to the WSS

Creating a container

Example of a creation error:

Authorization