{"info":{"_postman_id":"b00119ff-43a7-4deb-88eb-4c9620402ac4","name":"Chatpush Developers v1","description":"

ПРОСТАЯ ИНТЕГРАЦИЯ В НЕСКОЛЬКО ШАГОВ

1. Зарегистрируйте Личный кабинет на сайте

2. Сообщите нам, что вы девелопер и будете использовать API разработчика

3. Получите партнерский api_key (мастер-токен) от нас или в личном кабинете

4. Все готово, можно интегрироваться, тестировать методы прямо в Postman

_NB 1. Во всех методах в URL v1 — общий девлоперский скоуп, персональный v1 присваивается каждой CRM и сервису индивидуально, запросите свое значение v1 и используйте в коде его, отправляя запросы на проде._NB 2. Обратите внимание на различие использования api_key девелопера (для управления инстансами) и bearer token клиента (для всего остального - авторизация, отправка сообщений и пр.)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31634267","collectionId":"b00119ff-43a7-4deb-88eb-4c9620402ac4","publishedId":"2s9YkjA3hr","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-12T13:23:24.000Z"},"item":[{"name":"Управление инстансами","item":[{"name":"Создание инстанса","id":"237ce89a-20d7-407a-8662-58f431bc6d87","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":"","options":{"raw":{"language":"json"}}},"url":"https://chatpush.ru/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

Ключ	Обязателен	Тип данных	Описание
`email`	да	string	Почта регистрируемого клиента
`phone`	да	string	Телефон регистрируемого клиента
`password`	нет	string	Пароль регистрируемого клиента. Валидация: 1. больше или равен 7 символов 2. обязательно буквы и цифры
`dispatch_routing`	нет	array	Дефолтный канал отправки регистрируемого клиента
`external_id`	нет	string	Внешний ID
`renew_subscription`	нет	boolean	Статус автопродления подписки. False - автопродление отключено, true - автопродление включено. При отсутствии параметра по дефолту значение = true

Параметры ответа

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

Ключ	Тип данных	Описание
`instance`	object	Объект с данными
`instance.id`	integer	Внутренний идентификатор инстанса в системе
`instance.customer_id`	integer	Внутренний идентификатор клиента (customer) в системе
`instance.token`	string	токен инстанса
`instance.idempotency_key`	string	Ключ идемпотентности для предотвращения дублирования запросов
`instance.renew_subscription`	boolean	Флаг обновления подписки (`true` - подписка будет продлена, `false` - подписка не будет продлена)
`instance.external_id`	string	Внешний идентификатор инстанса)

","urlObject":{"protocol":"https","path":["api","tmp","instances"],"host":["chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"91e449f0-b2e9-463f-b932-aa2293c4eb69","name":"Успешный результат","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"instance\" : {\n \"phone\" : \"79123456789\",\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://chatpush.ru/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\": 378,\n \"customer_id\": 2032,\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6MjAzMjIsImRhdGV0aW1lIjoxNzAxMDgyNjk4fQ.R4rmzpSNC2rSGk5QQfTooK3MYclz-6uVg\",\n \"idempotency_key\": \"78avGOJp\",\n \"renew_subscription\": true,\n \"external_id\": \"77777\"\n },\n \"meta\": {\n \"status\": \"success\",\n \"code\": 200\n }\n}"},{"id":"40d7f763-30da-4fcf-bffc-78ae949b8f32","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"instance\" : {\n \"phone\" : \"79123456789\",\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://chatpush.ru/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 \"уже существует\"\n ],\n \"phone\": [\n \"уже существует\"\n ]\n }\n }\n}"}],"_postman_id":"237ce89a-20d7-407a-8662-58f431bc6d87"},{"name":"Получение информации об инстансе по customer_id","id":"959229fb-fd28-4954-a688-8bed102daec8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/developer/v1/instances/:customer_id","description":"

Параметры запроса

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

Ключ	Обязателен	Тип данных	Описание
`customer_id`	да	integer	уникальный идентификатор инстанса

Параметры ответа

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

Ключ	Тип данных	Описание
`id`	integer	Уникальный идентификатор инстанса
`token`	string	bearer token
`customer_id`	integer	Уникальный идентификатор клиента
`renew_subscription`	boolean	Статус автопродления подписки инстанса. False - автопродление отключено, true - автопродление включено.
`tdlib_session`	integer	Статус авторизации Telegram. Возможные значения: `wait_phone: 0, wait_code: 1, wait_password: 2, authorized: 3, wait_qr_code: 4`
`whatsapp_session`	integer	Статус авторизации WhatsApp. Возможные значения: `не авторизован: 0, авторизован: 1`
`whatsapp_phone`	string	Номер телефона авторизованного пользователя
`whatsapp_queue_size`	integer	Текущее количество сообщений в очереди WhatsApp для данного инстанса. Отображает актуальную нагрузку на систему отправки.
`whatsapp_queue_limit`	integer	Максимальный размер очереди WhatsApp сообщений для данного инстанса. Определяет лимит сообщений, которые могут находиться в очереди на отправку.
`external_id`	integer	Внешний ID
`subscription_cost`	number	Стоимость подписки инстаса
`subscription_paid_until`	datetime	Дата окночания подписки
`subscription_status`	string	Статус инстаса. Аctive - активен Inactiv - неактивен

","urlObject":{"protocol":"https","path":["developer","v1","instances",":customer_id"],"host":["api","chatpush","ru"],"query":[],"variable":[{"description":{"content":"

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

\n","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]}},"response":[{"id":"d744b3e4-be04-47da-98a8-ca0c802783a4","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:curstomer_id","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":curstomer_id"],"variable":[{"key":"curstomer_id","value":"2032","description":"integer | обязательный | уникальный идентификатор клиента"}]}},"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\": 2032,\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":"e3408e97-186f-489d-b32d-f56dc6354ff9","name":"Ошибка, 404","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:curstomer_id","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":curstomer_id"],"variable":[{"key":"curstomer_id","value":"203","description":"integer | обязательный | уникальный идентификатор клиента"}]}},"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":"959229fb-fd28-4954-a688-8bed102daec8"},{"name":"Получение информации об инстансе по external_id","event":[{"listen":"test","script":{"id":"17f122a7-6268-4793-baa5-4c7b8c6d5bb0","exec":[""],"type":"text/javascript"}}],"id":"daa2387e-5f01-4822-b161-00e856773700","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/developer/v1/instances","description":"

При указании пустой строки в качестве параметра _(пример:_`_/developer/v1/instances?external_id=)_будут возвращены инстансы, у которыхexternal_id = \"\"илиexternal_id is null`.

Также метод поддерживает пагинацию через необязательные параметры:

page: по умолчанию 1, может быть только больше или равно 1;
\n
per_page: по умолчанию 100, может быть в отрезке [1, 100].
\n

В meta находятся:

поле total_count, которое содержит общее кол-во отфильтрованных инстансов, без учета пагинации;
\n
поле page — фактические использованное значение параметра page;
\n
поле per_page — фактические использованное значение параметра per_page;
\n

Параметры запроса

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

Ключ	Обязателен	Тип данных	Описание
external_id	да	integer	уникальный идентификатор инстанса
per_page	нет	integer	количество записей
total_count	нет	integer	кол-во отфильтрованных инстансов, без учета пагинации
page	нет	integer	конкретная страница

Параметры ответа

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

Ключ	Тип данных	Описание
id	integer	Уникальный идентификатор инстанса
token	string	bearer token
customer_id	integer	Уникальный идентификатор клиента
renew_subscription	boolean	Статус автопродления подписки инстанса. False - автопродление отключено, true - автопродление включено.
tdlib_session	integer	Статус авторизации Telegram. Возможные значения: `wait_phone: 0, wait_code: 1, wait_password: 2, authorized: 3, wait_qr_code: 4`
whatsapp_session	integer	Статус авторизации WhatsApp. status: (0 или 1 ) где 0 не авторизован, 1 авторизован
whatsapp_phone	string	Номер телефона авторизованного пользователя
whatsapp_queue_size	integer	Текущее количество сообщений в очереди WhatsApp для данного инстанса. Отображает актуальную нагрузку на систему отправки.
whatsapp_queue_limit	integer	Максимальный размер очереди WhatsApp сообщений для данного инстанса. Определяет лимит сообщений, которые могут находиться в очереди на отправку.
external_id	integer	Внешний ID
subscription_cost	number	Стоимость подписки инстаса
subscription_paid_until	datetime	Дата окночания подписки
subscription_status	string	Статус инстаса. Аctive - активен Inactiv - неактивен

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

string | обязательный | Внешний ID клиента на стороне девелопера.

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

integer | необязательный | количество записей, по умолчанию 100, может быть в отрезке [1, 100]

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

integer | необязательный | кол-во отфильтрованных инстансов, без учета пагинации

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

integer | необязательный | конкретная страница, по умолчанию = 1

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"a09831ce-1be3-4c28-809f-3131f57b68f0","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances?external_id=77777","protocol":"https","host":["api","chatpush","ru"],"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.3y2y5MxrX1SwWCXdVA2atmr71d1XGrwY\",\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":"a0fb57f9-5703-4880-867e-8f3610ee15c5","name":"Ошибка, 404","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances?external_id=7777","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances"],"query":[{"key":"external_id","value":"7777"}]}},"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":"daa2387e-5f01-4822-b161-00e856773700"},{"name":"Получение информации обо всех инстансах","event":[{"listen":"test","script":{"id":"17f122a7-6268-4793-baa5-4c7b8c6d5bb0","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"5973fb31-293f-4f37-80f4-7bc8b81ea597","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/developer/v1/instances","description":"

Метод поддерживает пагинацию через необязательные параметры:

page: по умолчанию 1, может быть только больше или равно 1;
\n
per_page: по умолчанию 100, может быть в отрезке [1, 100].
\n

В meta находятся:

поле total_count, которое содержит общее кол-во отфильтрованных инстансов, без учета пагинации;
\n
поле page — фактические использованное значение параметра page;
\n
поле per_page — фактические использованное значение параметра per_page;
\n

Параметры запроса

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

Ключ	Обязателен	Тип данных	Описание
per_page	нет	integer	количество записей
total_count	нет	integer	кол-во отфильтрованных инстансов, без учета пагинации
page	нет	integer	конкретная страница

Параметры ответа

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

Ключ	Тип данных	Описание
id	integer	Уникальный идентификатор инстанса
token	string	bearer token
customer_id	integer	Уникальный идентификатор клиента
renew_subscription	boolean	Статус автопродления подписки инстанса. False - автопродление отключено, true - автопродление включено.
tdlib_session	integer	Статус авторизации Telegram. Возможные значения: `wait_phone: 0, wait_code: 1, wait_password: 2, authorized: 3, wait_qr_code: 4`
whatsapp_session	integer	Статус авторизации WhatsApp. status: (0 или 1 ) где 0 не авторизован, 1 авторизован
whatsapp_phone	string	Номер телефона авторизованного пользователя
whatsapp_queue_size	integer	Текущее количество сообщений в очереди WhatsApp для данного инстанса. Отображает актуальную нагрузку на систему отправки.
whatsapp_queue_limit	integer	Максимальный размер очереди WhatsApp сообщений для данного инстанса. Определяет лимит сообщений, которые могут находиться в очереди на отправку.
external_id	integer	Внешний ID
subscription_cost	number	Стоимость подписки инстаса
subscription_paid_until	datetime	Дата окночания подписки
subscription_status	string	Статус инстаса. Аctive - активен Inactiv - неактивен

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

integer | необязательный | количество записей, по умолчанию 100, может быть в отрезке [1, 100]

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

integer | необязательный | кол-во отфильтрованных инстансов, без учета пагинации

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

integer | необязательный | конкретная страница, по умолчанию = 1

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"23105cb5-38f5-4ba1-8b4a-52e39c75d5bf","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances?per_page=2","protocol":"https","host":["api","chatpush","ru"],"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":"5973fb31-293f-4f37-80f4-7bc8b81ea597"},{"name":"Изменения данных инстанса","id":"73ddfa7e-95b1-4ed6-9a3b-1d4055639a13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"url":"https://api.chatpush.ru/developer/v1/instances/:instance_id","urlObject":{"protocol":"https","path":["developer","v1","instances",":instance_id"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

boolean | необязательный | Список событый. false - не продлевать подписку, true - продлевать подписку

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

string | необязательный | Внешний ID инстанса в системе developers

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

array | необязательный | Дефолтный канал отправки инстанс

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

string | необязательный | email инстанса

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

string | необязательный | Телефон инстанса

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

string | необязательный | Пароль инстанса

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

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

\n","type":"text/plain"},"type":"any","value":"","key":"instance_id"}]}},"response":[{"id":"0fd20d1f-ca97-4cfa-9a7c-cb92a9902005","name":"Успешный результат","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:instance_id?renew_subscription=&external_id=&dispatch_routing[]=&email=&phone=&password=","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":instance_id"],"query":[{"key":"renew_subscription","value":"","description":"boolean | необязательный | Список событый. false - не продлевать подписку, true - продлевать подписку"},{"key":"external_id","value":"","description":"string | необязательный | внутренний ID инстанса в системе developers"},{"key":"dispatch_routing[]","value":"","description":"array | необязательный | дефолтный канал отправки инстанса"},{"key":"email","value":"","description":"string | необязательный | email инстанса"},{"key":"phone","value":"","description":"string | необязательный | телефон инстанса "},{"key":"password","value":"","description":"string | необязательный | пароль инстанса "}],"variable":[{"key":"instance_id","value":"3748","description":"boolean | необязательный | Список событый. false - не продлевать подписку, true - продлевать подписку"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 15 Feb 2024 15:10:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"193"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F7QR4AgiUvt5xpoAB-Tl"}],"cookie":[],"responseTime":null,"body":"{\n \"instance\": {\n \"dispatch_routing\": [\n \"sms\"\n ],\n \"email\": \"test_customer@gmail.com\",\n \"external_id\": \"5432\",\n \"id\": 3748,\n \"phone\": \"79123456789\",\n \"renew_subscription\": true\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"5766e62f-75db-4be6-bb4d-a8f6d9e5240d","name":"Ошибка, 422","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.chatpush.ru/developer/v1/instances/:instance_id?renew_subscription=true&external_id=5432&dispatch_routing[]=&email=test_customer@gmail.com&phone=79&password=testqwerty123","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","instances",":instance_id"],"query":[{"key":"renew_subscription","value":"true","description":"boolean | необязательный | Список событый. false - не продлевать подписку, true - продлевать подписку"},{"key":"external_id","value":"5432","description":"string | необязательный | внутренний ID инстанса в системе developers"},{"key":"dispatch_routing[]","value":"","description":"array | необязательный | дефолтный канал отправки инстанса"},{"key":"email","value":"test_customer@gmail.com","description":"string | необязательный | email инстанса"},{"key":"phone","value":"79","description":"string | необязательный | телефон инстанса "},{"key":"password","value":"testqwerty123","description":"string | необязательный | пароль инстанса "}],"variable":[{"key":"instance_id","value":"3748"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 15 Feb 2024 15:19:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"192"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F7QSXqlomYPqUbEACBpF"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"errors\": {\n \"dispatch_routing\": [\n \"dispatch_routing должно иметь минимум 1 частей\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"}],"_postman_id":"73ddfa7e-95b1-4ed6-9a3b-1d4055639a13"},{"name":"Активация подписки инстанса","id":"e89e27fd-aff9-45ba-b461-4e1daab90d1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/developer/v1/instances/:id/renew_subscription","urlObject":{"protocol":"https","path":["developer","v1","instances",":id","renew_subscription"],"host":["api","chatpush","ru"],"query":[],"variable":[{"description":{"content":"

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

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8c8e8619-ca2b-4b2e-8e4b-0270a0adb388","name":"Успешный результат","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 | обязательный | уникальный идентификатор 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":"e5cd6039-6cf8-46c5-b21d-6fcb7058717a","name":"Ошибка, 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 | обязательный | уникальный идентификатор 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":"e89e27fd-aff9-45ba-b461-4e1daab90d1f"},{"name":"Прерывание авторизации WhatsApp","id":"9ed1e9c6-41d3-4d6a-9980-902737b7e06a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.chatpush.ru/developer/v1/instances/:instance_id/delete_container_session","urlObject":{"protocol":"https","path":["developer","v1","instances",":instance_id","delete_container_session"],"host":["api","chatpush","ru"],"query":[],"variable":[{"description":{"content":"

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

\n","type":"text/plain"},"type":"any","value":"","key":"instance_id"}]}},"response":[{"id":"8b263954-b6de-4bb0-b7e6-e9b4d77860a0","name":"Успешный результат","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":"9ed1e9c6-41d3-4d6a-9980-902737b7e06a"},{"name":"Просмотр информации аккаунта","id":"f5b849a9-ea17-4800-b95a-032fd6b9f093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/api/v1/account","urlObject":{"protocol":"https","path":["api","v1","account"],"host":["api","chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"5ffd444b-d9d0-4547-a4d2-c033d57f63a5","name":"Успешный результат","originalRequest":{"method":"GET","header":[],"url":"https://api.chatpush.ru/api/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 Jul 2024 14:16:43 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":"F-Urz7xbTxsYCiwAB_hk"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"account\": {\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6ODEzLCJkYXRldGltZSI6MTYwMDcyMDU5MH0.iSZxL5MA5LL6ViIKOitaUTNfei8CTvMJ9Lc_KQzuXm0\",\n \"total_amount\": \"780.70\",\n \"customer_id\": 813,\n \"dispatch_routing\": [\n \"sms\"\n ],\n \"subscription_paid_until\": \"2025-07-01\",\n \"sender_names\": [\n \"pospush.ru\",\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":"f5b849a9-ea17-4800-b95a-032fd6b9f093"}],"id":"8824053e-c906-4059-b045-ab144a493333","description":"

Авторизация api_key

В проекте применяется api_key авторизация. Необходимый api_key (мастер-токен) можно получить у менеджера CHATPUSH или в личном кабинете девелопера (мастер-аккаунт). Он используется для управления зависимыми инстансами девелопера.

Во всех соответствующих запросах в headers должно содержаться следующее:

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

Ключ	Значение
Authorization	{api_key}

При отсутствии данных параметров или их невалидности, ответ будет иметь: HTTP-код 401 (Not authorized).

\n","_postman_id":"8824053e-c906-4059-b045-ab144a493333"},{"name":"Авторизация мессенджеров","item":[{"name":"Авторизация WhatsApp","item":[],"id":"ee6956c7-a49e-436c-a018-9e0e5c258fd1","description":"

Есть два способа получить QR-код для авторизации:

при помощи WSS коннекта (описан ниже);
\n
при помощи ссылки на iFrame (см. метод - Авторизация Whatsapp через iFrame).
\n

1. WSS Коннект

Необходимо осуществить коннект к WSS

Для доступа к коннекту по WSS, предварительно передайте имя домена или IP, с которого будут поступать запросы. Имя домена необходимо передать в origin.

wss://msg-farmer.pushsms.ru/socket/websocket?token=ваш токен клиента&vsn=2.0.0

При удачном коннекте сервис возвращает сообщение:

Connected to wss://msg-farmer.pushsms.ru/socket/websocket?token=ваш токен клиента&vsn=2.0.0

Запрос на подключение к WSS

Для подключения необходимо быть авторизованным, то есть должен быть первоначальный коннект с верным токеном.

* room_id должен совпадать с id клиента

ID клиента можно получить из JWT токена. Пример работы получения данных из JWT токена можно посмотреть тут https://jwt.io/

Для получений событий необходимо отправить следующую команду по WSS протоколу:

Запрос

[\"1\",\"1\",\"room:v1:whats_app:auth:room_id\",\"phx_join\",{}]\n\n

– \"1\",\"1\" Первые два параметра могут быть любыми, необходимы для обеспечения идемпотентности, если это необходимо клиенту

– ключ подключения room:v1:whats_app:auth

– room_id должен совпадать с id клиента. ID клиента можно получить из JWT токена. Пример работы получения данных из JWT токена можно посмотреть тут https://jwt.io/

– phx_join команда на подключение

– {} дополнительные параметры, можно оставить пустыми

После подключения к “руму” клиенту будет передаваться текущий состояние QRcode:

Создание контейнера, успешный ответ

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

Пример ошибки создания:

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

Успешный результат получение QR кода:

[\n1,\nnull,\n\"room: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 – содержится QR-code в виде свертки, который необходимо преобразовать в QR-code. Пример можно посмотреть тут https://www.qr-code-generator.com/

auth – статус авторизации (отсканирован qr code - true, не отсканирован - false)

Пользователь авторизовался, пример успешного результата:

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

Чтобы коннект по WSS не сбрасывался важно клиенту передавать heartbeat

[null,\"24\",\"phoenix\",\"heartbeat\",{}]

Время жизни QR-кода 30-40 сек. Мы передаем QR c периодичностью 300 мс, убедитесь, что WSS-коннект не разрывается и пользователь получает обновленный код с необходимой частотой, чтобы избежать сканирование неактуального QR и безуспешной авторизации.

\n","_postman_id":"ee6956c7-a49e-436c-a018-9e0e5c258fd1"},{"name":"Авторизация Telegram номерной (tdlib)","item":[],"id":"b8d5c17a-1ca1-4e7f-ae74-53a320510c4b","description":"

Есть два способа для авторизации Telegram:

при помощи WSS коннекта (описан ниже);
\n
при помощи ссылки на iFrame (см. метод - Авторизация TDlib через iFrame).
\n

1. Осуществить коннект к веб-сокету

Запрос

wss://api.pushsms.ru/socket/websocket?token=токен_клиента&vsn=2.0.0\n\n

Успешный ответ

Connected to wss://api.pushsms.ru/socket/websocket?token=токен_клиента&vsn=2.0.0\n\n

2. Подключение к каналу

Для подключения к нужному каналу необходимо быть авторизованным, то есть первоначальный коннект с верным токеном (шаг 1).

Запрос

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

\"1\",\"1\" Первые два параметра могут быть любыми, необходимы для обеспечения идемпотентности, если это необходимо клиенту
\n
ключ подключения room:v1:telegram:auth
\n
phx_join команда на подключение
\n
{} дополнительные параметры, можно оставить пустыми
\n

После подключения к каналу каждые n секунд клиенту будет передаваться текущее состояние авторизации в виде:

[\"1\",null,\"room:v1:telegram:auth\",\"auth_state\",{\"status\":\"статус_авторизации\"}]\n\n

Cтатусы авторизации:

wait_phone - ожидает отправки номера телефона
\n
wait_code - ожидает отправки кода подтверждения
\n
wait_password - ожидает отправки пароля
\n
authorized - авторизован
\n

3. Отправка номера телефона

Запрос

[\"1\",\"1\",\"room:v1:telegram:auth\",\"send_phone\",{\"phone\": \"номер_телефона_клиента\"}]\n\n

Успешный ответ

[\"1\",\"1\",\"room:v1:telegram:auth\",\"phx_reply\",{\"response\":{},\"status\":\"ok\"}]\n\n

Ответ при невалидном номере телефона

[\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        \"message\": \"Unprocessable Entity\",\n        \"status\": \"fail\",\n        \"status_id\": null\n      }\n    },\n    \"status\": \"error\"\n  }\n]\n\n

4. Отправка кода подтверждения

Запрос

[\"1\",\"1\",\"room:v1:telegram:auth\",\"send_code\",{\"code\": \"ваш_код_подтверждения\"}]\n\n

Успешный ответ

[\"1\",\"1\",\"room:v1:telegram:auth\",\"phx_reply\",{\"response\":{},\"status\":\"ok\"}]\n\n

5. Отправка пароля

Запрос

[\"1\",\"1\",\"room:v1:telegram:auth\",\"send_password\",{\"password\": \"ваш_пароль\"}]\n\n

Успешный ответ

[\"1\",\"1\",\"room:v1:telegram:auth\",\"phx_reply\",{\"response\":{},\"status\":\"ok\"}]\n\n

6. Сброс авторизации

Запрос

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

Успешный ответ

[\"1\",\"1\",\"room:v1:telegram:auth\",\"phx_reply\",{\"response\":{},\"status\":\"ok\"}]\n\n

Авторизация Telegram через QR-код (WebSocket)

Подключение к каналу

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

Запрос QR-кода

[\"1\",\"1\",\"room:v1:telegram:auth\",\"request_qr_code\",{}]\n\n

После этого сервер отправляет статус и QR-код:

[\n  \"1\",\n  null,\n  \"room:v1:telegram:auth\",\n  \"auth_state\",\n  {\n    \"status\": \"wait_qr_code\",\n    \"qr_code\": \"tg://login?token=AQEjSzBpv9bcDRaN...\"\n  }\n]\n\n

QR-код передаётся в формате ссылки вида:

tg://login?token=XXXXXXXXXXXX\n\n

Использование этой ссылки (через Telegram клиента) завершает процесс авторизации.

\n","_postman_id":"b8d5c17a-1ca1-4e7f-ae74-53a320510c4b"},{"name":"Авторизация Telegram Bot","item":[{"name":"Авторизация telegram bot","id":"d0d5a6c4-845b-4475-bad7-f500e53a3820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/developer/v1/telegram_bots?instance_id=&api_token=&menu_title=&menu_link=","urlObject":{"protocol":"https","path":["developer","v1","telegram_bots"],"host":["api","chatpush","ru"],"query":[{"description":{"content":"

integer | обязательный | ID инстанса

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

integer | обязательный | токен телеграм бота

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

string | необязательный | название меню. Является обязательным, если поле menu_link не пустое

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

string | необязательный | ссылка на сайт. Является обязательным, если поле menu_title не пустое

\n","type":"text/plain"},"key":"menu_link","value":""}],"variable":[]}},"response":[{"id":"c7a2a311-1375-4749-b70e-3fc66d953e4b","name":"Успешный результат","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/developer/v1/telegram_bots?instance_id=374&api_token=6209296007:AAHmy6glVmmtztPjnZDnzSFVKldmOA5kAe&menu_title=Запись&menu_link=","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","telegram_bots"],"query":[{"key":"instance_id","value":"374","description":"integer | обязательный | ID инстанса"},{"key":"api_token","value":"6209296007:AAHmy6glVmmtztPjnZDnzSFVKldmOA5kAe","description":"integer | обязательный | токен телеграм бота"},{"key":"menu_title","value":"Запись","description":"string | необязательный | название меню. Является обязательным, если поле menu_link не пустое"},{"key":"menu_link","value":"","description":"string | необязательный | ссылка на сайт. Является обязательным, если поле menu_title не пустое"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 15 Feb 2024 15:51:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"200"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F7QUG0XJ26UD6PoANM6C"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"telegram_bot\": {\n \"bot_link\": \"https://t.me/oeporpj_bot\",\n \"instance_id\": 348,\n \"menu_link\": \"https://www.notion.so/\",\n \"menu_title\": \"Запись\",\n \"status\": \"running\"\n }\n}"},{"id":"eeffbd51-9d4b-4870-a9b3-efcf1cebc138","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/developer/v1/telegram_bots?instance_id=374&api_token=6209296007:AAHmy6lVmmtztPjnZDnzSFVKldmOA5kAeI&menu_title=Запись&menu_link=","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","telegram_bots"],"query":[{"key":"instance_id","value":"374","description":"integer | обязательный | ID инстанса"},{"key":"api_token","value":"6209296007:AAHmy6lVmmtztPjnZDnzSFVKldmOA5kAeI","description":"integer | обязательный | токен телеграм бота"},{"key":"menu_title","value":"Запись","description":"string | необязательный | название меню. Является обязательным, если поле menu_link не пустое"},{"key":"menu_link","value":"","description":"string | необязательный | ссылка на сайт. Является обязательным, если поле menu_title не пустое"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 15 Feb 2024 15:55:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"179"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F7QUUzv6PEGMmKkAPeYB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"errors\": {\n \"menu_link\": [\n \"Ссылка на сайт не может быть пустым\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"}],"_postman_id":"d0d5a6c4-845b-4475-bad7-f500e53a3820"}],"id":"e607d6cc-b42b-4a46-8336-105519946fb6","_postman_id":"e607d6cc-b42b-4a46-8336-105519946fb6","description":""},{"name":"Авторизация MAX","item":[],"id":"b7940f56-f07f-444d-90e9-200cfa22ae9b","description":"

Авторизация MAX

QR-код начнет передаваться в течение 7 минут после первого запроса.

1. Осуществить коннект к веб-сокету

Запрос

wss://api.chatpush.ru/socket/websocket?token=токен_клиента&vsn=2.0.0\n\n

Успешный ответ

Connected to wss://api.chatpush.ru/socket/websocket?token=токен_клиента&vsn=2.0.0\n\n

Неуспешный ответ: не подключен MAX на стороне chatpush

[\"1\",\"1\",\"room:v1:max:auth\",\"phx_reply\",{\"status\":\"error\",\"response\":{\"meta\":{\"code\":403,\"message\":\"Forbidden\",\"status\":\"fail\",\"errors\":{\"base\":[\"max_not_allowed\"]},\"status_id\":null}}}]\n\n

2. Подключение к каналу

Запрос

[\"1\",\"1\",\"room:v1:max:auth\",\"phx_join\",{}]\n\n

\"1\",\"1\" Первые два параметра могут быть любыми, необходимы для обеспечения идемпотентности, если это необходимо клиенту
\n
ключ подключения room:v1:max:auth
\n
phx_join команда на подключение
\n
{} дополнительные параметры, можно оставить пустыми
\n

Успешный ответ

[\"1\",\"1\",\"room:v1:max:auth\",\"phx_reply\",{\"status\":\"ok\",\"response\":{}}]\n\n

После подключения к каналу каждые 5 секунд клиенту будет передаваться текущее состояние авторизации в виде:

[\"1\",null,\"room:v1:max:auth\",\"auth_state\",{\"status\":\"wait_qr_code\",\"qr_code\":\"iVBORw0KGgoAAAANSUhEUgAAAKQAAACkCAYAAAAZtYVBAAAAAklEQVR4AewaftIAAAZHSURBVO3BQY4kRxLAQDLQ//8yd45+SiBR1aOQ1s3sD9a6xGGtixzWushhrYsc1rrIYa2LHshhrYv8g==\"}]\n\n

Cтатусы авторизации:

wait_qr_code - ожидает сканирован, содержит QR-код. Изображение QR-кода в кодировке base64;
\n
authorized - авторизован, не содержит QR-код;
\n
instance_not_ready - ожидание поднятия сессии, не содержит QR-код.
\n

Неуспешный ответ: ожидание ответа без подключения к каналу

[null,\"1\",\"room:v1:max:auth\",\"phx_reply\",{\"status\":\"error\",\"response\":{\"reason\":\"unmatched topic\"}}]\n\n

3. Сброс авторизации

Запрос 1

[\"1\",\"1\",\"room:v1:max:auth\",\"phx_join\",{}]\n\n

Запрос 2

[\"1\",\"1\",\"room:v1:max:auth\",\"reset\",{}]\n\n

Успешный ответ

[\"1\",\"1\",\"room:v1:max:auth\",\"phx_reply\",{\"status\":\"ok\",\"response\":{}}]\n\n

4. Удаление контейнера

Запрос 1

[\"1\",\"1\",\"room:v1:max:auth\",\"phx_join\",{}]\n\n

Запрос 2

[\"1\",\"1\",\"room:v1:max:auth\",\"delete_container\",{}]\n\n

Успешный ответ

[\"1\",\"1\",\"room:v1:max:auth\",\"phx_reply\",{\"status\":\"ok\",\"response\":{}}]\n\n

\n","_postman_id":"b7940f56-f07f-444d-90e9-200cfa22ae9b"},{"name":"Авторизация WhatsApp и TDlib через iFrame","id":"12b3fdec-4945-4bb2-a0d6-38d1536797c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/api/v1/generate_auth_link","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

Краткое описание	Получение ссылки на страницу QR-кода для авторизации/авторизации TDlib
Авторизация	Необходима
HTTP-метод	POST
URL	https://api.chatpush.ru/api/v1/generate_auth_link
Варианты ответа	Успешный с HTTP-кодом 200, неуспешный с кодом 422

Получение ссылки на страницу авторизации мессенджера:

При открытии ссылки из успешного ответа на запрос доступна авторизация мессенджера.
\n
Если у customer неактивная подписка на мессенджеры, то возвращается 422 ошибка.
\n
Если у customer параметр \"messenger\" отличный от whatsapp, возвращается ошибка 422.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","generate_auth_link"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

string | обязательный | Мессенджр для авторизации. Варианты значений: whatsapp - генерация ссылки для авторизации мессенджера Whatsapp, tdlib - генерация ссылки для авторизации мессенджера telegram.

\n","type":"text/plain"},"key":"messenger","value":""}],"variable":[]}},"response":[{"id":"4cd9de64-0629-4a54-afed-c00324a39e9f","name":"Успешный результат","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/generate_auth_link?messenger=whatsapp","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","generate_auth_link"],"query":[{"key":"messenger","value":"whatsapp","description":"string | обязательный | Мессенджр для авторизации "}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"meta\": {\r\n \"code\": 200,\r\n \"status\": \"success\"\r\n },\r\n \"link\": \"https://api.chatpush.ru/messenger_auth?payload=SFMyNTY.g2gDdAAAAAJ3C2N1c3RvbWVyX2lkYgAAAXF3CW1lc3Nlbmdlcm0AAAAId2hhdHNhcHBuBgDMyJrAlwFiEswDAA.rw3Ye5SpgyMvcEZoHK2mKtNoZgQZFrOYU7UE\"\r\n}"},{"id":"555c9930-1abb-4448-9c3b-8302b2ca202a","name":"Ошибка 422 (невалидный messenger)","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/generate_auth_link?messenger=whatsapp","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","generate_auth_link"],"query":[{"key":"messenger","value":"whatsapp","description":"string | обязательный | Мессенджр для авторизации "}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"meta\": {\r\n \"code\": 422,\r\n \"message\": \"Unprocessable Entity\",\r\n \"status\": \"fail\",\r\n \"errors\": {\r\n \"messenger\": [\r\n \"messenger невалидно\"\r\n ]\r\n },\r\n \"status_id\": null \r\n }\r\n}"},{"id":"9fea63ed-e52b-4600-ad11-9b17f2ebc14a","name":"Ошибка 422(whatsapp не активный)","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/generate_auth_link?messenger=whatsapp","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","generate_auth_link"],"query":[{"key":"messenger","value":"whatsapp","description":"string | обязательный | Мессенджр для авторизации "}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"meta\": {\r\n \"code\": 422,\r\n \"message\": \"Unprocessable Entity\",\r\n \"status\": \"fail\",\r\n \"errors\": {\r\n \"base\": [\r\n \"base Подписка на мессенджеры не оплачена\"\r\n ],\r\n \"messenger\": [\r\n \"messenger невалидно\"\r\n ]\r\n },\r\n \"status_id\": null\r\n }\r\n}"}],"_postman_id":"12b3fdec-4945-4bb2-a0d6-38d1536797c3"}],"id":"5d35a8a3-37b2-4cd0-a329-71e56cec7dbe","_postman_id":"5d35a8a3-37b2-4cd0-a329-71e56cec7dbe","description":""},{"name":"Отправка сообщений","item":[{"name":"Отправка сообщений","id":"1bf0ef27-0f1d-4545-a2d2-e8623aaaa31a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/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

Краткое описание	Отправка сообщений с указанными параметрами
Авторизация	Необходима
HTTP – метод	POST
URL	https://api.chatpush.ru/api/v1/delivery
Варианты ответа	Успешный с http кодом 200, неуспешные с кодом 422

","urlObject":{"protocol":"https","path":["api","v1","delivery"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

string | обязательный | Текст сообщения. Стандартная длина для одного сообщения. Мессенджеры 938 символов, СМС - 160 символов для латиницы или 70 для не латиницы.

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

string | обязательный | Телефон получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233. Необязательный параметр, если используется username в канале tdlib

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

string | необязательный | Имя клиента в телеграм. Используется только при отправке по каналу tdlib. Принимается в формате - username, @username

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

string | необязательный | Имя отправителя СМС. Можно указывать доступные для клиента имена отправителей. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU”. Регистрация имени отправителя СМС и передача его является обязательным для некоторых операторов сотовой связи.

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

string | необязательный | Метка для маркировки отправок.

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

string | необязательный | URL-адрес, на который будет автоматически высылаться информация при обновлении статуса отправки.

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

string | необязательный | Идентификатор сообщения. Генерируется на стороне клиента и необходим в уникальном виде для использования идемпотентности.

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

array | необязательный | Каналы и последовательность отправки сообщения.\nwhatsapp - Whatsapp.\ntdlib - номерной Telegram.\ntelegram - Telegram Bot.\nnotify - ВК и ОК.\nmax - MAX.\nsms - СМС.\nmax_bot - MAX Bot.

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

datetime | необязательный | Дата отложенной отправки должна быть не меньше 1 минуты и не больше 1 месяца с текущего момента. Часовой пояс, в котором принимается дата отложенной отправки UTC+0. Указывается в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.

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

string | необязательный | Приоритет отправки сообщения. Доступные значения: \"high\", \"medium\" и \"low\". При отсутствии параметра оптимальное значение определяется автоматически.

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

string | необязательный | Message id сообщения, используется для цитирования

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

string | необязательный | ID tdlib клиента, используется вместо телефона или имени, при отправке в через роутинг tdlib. Параметр можно использовать как для отправли в личные чаты, так и для отправки групповые чаты (если tdlib_user_id > 0 - это личный чат, если <0 это групповой чат (ID группы всегда с минусом)

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

boolean | необязательный | Дефолтное значение парамера true. При значении true — будет происходить симуляция набора сообщения в whatsapp, при false — сообщение будет уходить мгновенно

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

string | необязательный | lid id клиента на стороне whatsapp. Используется только при отправке в whatsapp. Принимается к отправке в виде целого числа или целого числа с добавлением @lid (Пример: 43445322325 или 43445322325@lid)

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

string | необязательный | max id клиента на стороне max. Используется только при отправке в max max_bot. Принимается к отправке в виде целого числа (Пример: 43445325)

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

string | необязательный | avito_chat_id клиента. Используется только при отправке в avito. Принимается к отправке в виде строки (Пример: \"u2u-grF2kmao9i2Jgjty8pSQ\")

\n","type":"text/plain"},"key":"avito_chat_id","value":null}],"variable":[]}},"response":[{"id":"5078af4a-9bca-494f-bd92-24ff057361b8","name":"Успешный результат","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery?text=Тест&phone=71234567890","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","delivery"],"query":[{"key":"text","value":"Тест","description":"string | обязательный | Текст сообщения. Стандартная длина для одного сообщения 160 символов для латиницы или 70 для не латиницы."},{"key":"phone","value":"71234567890","description":"string | обязательный | Телефон получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233"},{"key":"sender_name","value":"PUSHSMS.RU","description":"string | необязательный | Имя отправителя. Можно указывать доступные для клиента имена отправителей. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU”","disabled":true},{"key":"utm_mark","value":"example_mark","description":"string | необязательный | Метка для маркировки отправок.","disabled":true},{"key":"callback_url","value":"http://example-url.ru","description":"string | необязательный | URL-адрес, на который будет автоматически высылаться информация при обновлении статуса отправки. ","disabled":true},{"key":"external_id","value":"1","description":"string | необязательный | Идентификатор сообщения. Генерируется на стороне клиента и необходим в уникальном виде для использования идемпотентности.","disabled":true},{"key":"dispatch_routing[]","value":"sms","description":"array | необязательный | Каналы и последовательность отправки сообщения.","disabled":true},{"key":"scheduled_at","value":"2023-11-21 20:30:00","description":"datetime | необязательный | Дата отложенной отправки должна быть не меньше 1 минуты и не больше 1 месяца с текущего момента. Часовой пояс, в котором принимается дата отложенной отправки UTC+0. Указывается в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.","disabled":true},{"key":"priority","value":"high","description":"string | необязательный | Приоритет отправки сообщения. Доступные значения: \"high\", \"medium\" и \"low\". При отсутствии параметра оптимальное значение определяется автоматически.","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\": \"+71234567890\",\n \"priority\": \"low\",\n \"scheduled_at\": null,\n \"sender_name\": \"PUSHSMS.RU\",\n \"status_description\": \"Принято\",\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":"c1a319d0-1b2f-4ac6-95c5-c0eb0989eb3a","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery?phone=71234567890&sender_name=PUSHSMS.RU&utm_mark=example_mark&callback_url=http://example-url.ru&external_id=1&dispatch_routing[]=whatsapp&scheduled_at=2023-11-21 20:30:00&priority=high","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","delivery"],"query":[{"key":"text","value":"Тест","description":"string | обязательный","disabled":true},{"key":"phone","value":"71234567890","description":"string | обязательный"},{"key":"sender_name","value":"PUSHSMS.RU","description":"string | необязательный"},{"key":"utm_mark","value":"example_mark","description":"string | необязательный"},{"key":"callback_url","value":"http://example-url.ru","description":"string | необязательный"},{"key":"external_id","value":"1","description":"string | необязательный"},{"key":"dispatch_routing[]","value":"whatsapp","description":"string | необязательный"},{"key":"scheduled_at","value":"2023-11-21 20:30:00","description":"string | необязательный"},{"key":"priority","value":"high","description":"string | необязательный"}]}},"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 \"текст не может быть пустым\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"},{"id":"41fa58f5-0551-440c-b079-9860e371c8d4","name":"Ошибка, 401","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery?text=Тест&phone=71234567890","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","delivery"],"query":[{"key":"text","value":"Тест","description":"string | обязательный | Текст сообщения. Стандартная длина для одного сообщения 160 символов для латиницы или 70 для не латиницы."},{"key":"phone","value":"71234567890","description":"string | обязательный | Телефон получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233"},{"key":"sender_name","value":"PUSHSMS.RU","description":"string | необязательный | Имя отправителя. Можно указывать доступные для клиента имена отправителей. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU”","disabled":true},{"key":"utm_mark","value":"example_mark","description":"string | необязательный | Метка для маркировки отправок.","disabled":true},{"key":"callback_url","value":"http://example-url.ru","description":"string | необязательный | URL-адрес, на который будет автоматически высылаться информация при обновлении статуса отправки. ","disabled":true},{"key":"external_id","value":"1","description":"string | необязательный | Идентификатор сообщения. Генерируется на стороне клиента и необходим в уникальном виде для использования идемпотентности.","disabled":true},{"key":"dispatch_routing[]","value":"sms","description":"array | необязательный | Каналы и последовательность отправки сообщения.","disabled":true},{"key":"scheduled_at","value":"2023-11-21 20:30:00","description":"datetime | необязательный | Дата отложенной отправки должна быть не меньше 1 минуты и не больше 1 месяца с текущего момента. Часовой пояс, в котором принимается дата отложенной отправки UTC+0. Указывается в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.","disabled":true},{"key":"priority","value":"high","description":"string | необязательный | Приоритет отправки сообщения. Доступные значения: \"high\", \"medium\" и \"low\". При отсутствии параметра оптимальное значение определяется автоматически.","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":"1bf0ef27-0f1d-4545-a2d2-e8623aaaa31a"},{"name":"Массовая отправка","id":"9959ceb7-4bff-4ac0-aa23-2e7f529c8634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/api/v1/bulk_delivery","urlObject":{"protocol":"https","path":["api","v1","bulk_delivery"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

string | обязательный | Текст сообщения. Стандартная длина для одного сообщения 160 символов для латиницы или 70 для не латиницы.

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

array | обязательный | Телефоны получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233. Пример: +79991234567, 84956785422, +79851323233

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

string | необязательный | Имя отправителя. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU”

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

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

string | необязательный | Метка для маркировки отправок

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

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

array | необязательный | Имя клиента в телеграм. Используется только при отправке по каналу tdlib. Принимается в формате - username, @username

\n","type":"text/plain"},"key":"usernames[]","value":""}],"variable":[]}},"response":[{"id":"490bc95a-fd4c-4dbb-abf0-ccc0b8922ef9","name":"Успешный результат","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chatpush.ru/api/v1/bulk_delivery?text=текст&phones_numbers[]=71234567890&sender_name=PUSHSMS.RU&scheduled_at=2023-12-11 20:30:00&utm_mark=example_mark&dispatch_routing[]=whatsapp","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","bulk_delivery"],"query":[{"key":"text","value":"текст","description":"string | обязательный | Текст сообщения. Стандартная длина для одного сообщения 160 символов для латиницы или 70 для не латиницы."},{"key":"phones_numbers[]","value":"71234567890","description":"array | обязательный | Телефоны получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233. Пример: +79991234567, 84956785422, +79851323233"},{"key":"sender_name","value":"PUSHSMS.RU","description":"string | необязательный | Имя отправителя. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU” "},{"key":"scheduled_at","value":"2023-12-11 20:30:00","description":"datetime | необязательный | Дата отложенной отправки должна быть не меньше 1 минуты и не больше 1 месяца с текущего момента. Часовой пояс, в котором принимается дата отложенной отправки UTC+0. Указывается в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. Пример: 2021-11-11 20:30:00"},{"key":"utm_mark","value":"example_mark","description":"string | необязательный | Метка для маркировки отправок"},{"key":"dispatch_routing[]","value":"whatsapp","description":"array | необязательный | Каналы и последовательность отправки сообщения."}]}},"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 \"71234567890\"\n ],\n \"scheduled_at\": \"2023-12-11T20:30:00Z\",\n \"sender_name\": \"PUSHSMS.RU\",\n \"state\": 2,\n \"text\": \"текст\",\n \"url_shorting\": false,\n \"utm_mark\": \"example_mark\"\n },\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"cdbf5f82-6023-4640-984f-ffe61334fd91","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chatpush.ru/api/v1/bulk_delivery?phones_numbers[]=71234567890&sender_name=PUSHSMS.RU&scheduled_at=2023-12-11 20:30:00&utm_mark=example_mark&dispatch_routing[]=whatsapp","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","bulk_delivery"],"query":[{"key":"text","value":"текст","description":"string | обязательный | Текст сообщения. Стандартная длина для одного сообщения 160 символов для латиницы или 70 для не латиницы.","disabled":true},{"key":"phones_numbers[]","value":"71234567890","description":"array | обязательный | Телефоны получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233. Пример: +79991234567, 84956785422, +79851323233"},{"key":"sender_name","value":"PUSHSMS.RU","description":"string | необязательный | Имя отправителя. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU” "},{"key":"scheduled_at","value":"2023-12-11 20:30:00","description":"datetime | необязательный | Дата отложенной отправки должна быть не меньше 1 минуты и не больше 1 месяца с текущего момента. Часовой пояс, в котором принимается дата отложенной отправки UTC+0. Указывается в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. Пример: 2021-11-11 20:30:00"},{"key":"utm_mark","value":"example_mark","description":"string | необязательный | Метка для маркировки отправок"},{"key":"dispatch_routing[]","value":"whatsapp","description":"array | необязательный | Каналы и последовательность отправки сообщения."}]}},"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 \"текст не может быть пустым\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"}],"_postman_id":"9959ceb7-4bff-4ac0-aa23-2e7f529c8634"},{"name":"Информация об отправке (статус отправки)","id":"29fb2e36-8a50-4472-9aa7-ecc8dbfa8169","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/api/v1/delivery/:id","urlObject":{"protocol":"https","path":["api","v1","delivery",":id"],"host":["api","chatpush","ru"],"query":[],"variable":[{"description":{"content":"

integer | обязателеный | integer

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f6daeef3-8fb9-450c-a6b4-b0b195d2afc6","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery/:id","protocol":"https","host":["api","chatpush","ru"],"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\": \"Мегафон\",\n \"country\": \"Россия\",\n \"id\": 81,\n \"name\": \"мегафон\",\n \"slug\": \"megafon\"\n },\n \"phone\": \"+79260846453\",\n \"scheduled_at\": null,\n \"sender_name\": \"PUSHSMS.RU\",\n \"status\": {\n \"description\": \"Запрещено\",\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":"29fb2e36-8a50-4472-9aa7-ecc8dbfa8169"},{"name":"Информация о номере телефона","id":"b3cb5a2a-540d-42d4-a912-9fc8fcf31f6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/api/v1/operators/search?phone=71234567890","urlObject":{"protocol":"https","path":["api","v1","operators","search"],"host":["api","chatpush","ru"],"query":[{"description":{"content":"

string | обязателен | Номер телефона в международном формате. Допускаются спец символы.

\n","type":"text/plain"},"key":"phone","value":"71234567890"}],"variable":[]}},"response":[{"id":"a5c606e0-2220-4059-90b2-b89bb3d5f802","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":{"raw":"https://api.chatpush.ru/api/v1/operators/search?phone=71234567890","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","operators","search"],"query":[{"key":"phone","value":"71234567890","description":"string | обязателен | Номер телефона в международном формате. Допускаются спец символы."}]}},"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\": \"+71234567890\",\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"operator\": {\n \"brand_name\": \"Мегафон\",\n \"country\": \"Россия\",\n \"id\": 81,\n \"name\": \"мегафон\",\n \"slug\": \"megafon\"\n }\n}"}],"_postman_id":"b3cb5a2a-540d-42d4-a912-9fc8fcf31f6a"},{"name":"Просмотр информации аккаунта (баланса)","id":"0837dce6-1c35-4b70-9dd6-07355302b98c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/api/v1/account","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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Ключ	Тип данных	Описание
`meta.code`	integer	HTTP-код ответа (200)
`meta.status`	string	Статус ответа: `success`
`account.customer_id`	integer	Уникальный идентификатор клиента
`account.total_amount`	string (decimal)	Текущий баланс аккаунта в рублях, формат `\"1500.00\"`
`account.subscription_paid_until`	string (date)	Дата окончания подписки в формате `YYYY-MM-DD`. Может быть `null`, если подписка ни разу не оплачивалась
`account.subscription_status`	string	Статус подписки: `active` — активна, `inactive` — неактивна (истекла или нет подписки)
`account.subscription_cost`	string (decimal)	Стоимость подписки в рублях, формат `\"600.00\"`. `null`, если подписка не оформлена
`account.dispatch_routing`	array of strings	Каналы отправки в порядке приоритета. Возможные значения элементов: `whatsapp`, `telegram`, `max`, `sms`
`account.sender_names`	array of strings	Список доступных имён отправителя для SMS. Может быть пустым массивом `[]`
`account.token`	string	Bearer token для аутентификации в API. `null`, если ключ не сгенерирован
`account.idempotency_key`	string	Ключ идемпотентности для запросов отправки. `null`, если не сгенерирован
`account.whatsapp_session`	integer	Статус авторизации WhatsApp: `0` — не авторизован, `1` — авторизован
`account.tdlib_session`	integer	Статус авторизации Telegram: `0` — wait_phone, `1` — wait_code, `2` — wait_password, `3` — authorized, `4` — wait_qr_code, `5` — banned
`account.max_session`	integer	Статус авторизации MAX: `0` — wait_phone, `1` — wait_code, `2` — authorized, `3` — wait_qr_code, `4` — suspended

","urlObject":{"protocol":"https","path":["api","v1","account"],"host":["api","chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"215bd5b7-af0b-449f-bd12-30930e54470c","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":"https://api.chatpush.ru/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 \"customer_id\": 2032,\n \"total_amount\": \"1500.00\",\n \"subscription_paid_until\": \"2025-10-31\",\n \"subscription_status\": \"active\",\n \"subscription_cost\": \"600.00\",\n \"dispatch_routing\": [\"whatsapp\", \"telegram\", \"sms\"],\n \"sender_names\": [\"PUSHSMS\", \"MyCompany\"],\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21lcl9pZCI6MjAzMn0.abc123\",\n \"idempotency_key\": \"f47ac10b\",\n \"whatsapp_session\": 1,\n \"tdlib_session\": 3,\n \"max_session\": 0\n }\n}"}],"_postman_id":"0837dce6-1c35-4b70-9dd6-07355302b98c"},{"name":"UTM метки","id":"571be303-1b5a-4bea-bbcb-4909c24c15b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/api/v1/utm_mark","urlObject":{"protocol":"https","path":["api","v1","utm_mark"],"host":["api","chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"8e22d308-4bf8-48ae-b3c1-bd5f21991787","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text","disabled":true}],"url":"https://api.chatpush.ru/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":"571be303-1b5a-4bea-bbcb-4909c24c15b4"},{"name":"Отправка файлов","id":"bd3efd27-9192-4791-9ddb-e003716be25a","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 | обязательный | Отправляемый файл. Поддерживаемые форматы описаны здесь.

\n","type":"file","value":null}]},"url":"https://api.chatpush.ru/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

Краткое описание	Отправка файлов с указанными параметрами. Файл отправляется ссылкой для скачивания, ссылка активна в течение 7 дней (text = file_name + link_to_file). Исключением является whatsapp и tdlib, отправляется фото до 10 мб.
Авторизация	Необходима
HTTP-метод	POST
URL	https://api.pushsms.ru/api/v1/send_file
Варианты ответа	Успешный c http-кодом 200, неуспешные с кодом 422

Поддерживаемые форматы

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

Поддерживаемый размер

Максимальный объем принимаемого файла на отправку составляет 100 мб
\n
Если фото менее 10 мб – отправляем как фото (нативно), если более – как файл. Актуально каналов отправки - whatsapp и tdlib, max.
\n

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

string | обязательный | \n Название файла. Должно содержать расширение файла.\nПример: file_name.docx

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

string | обязательный | \n Телефон получателя сообщения. Международный формат 79991112233, для российских номеров доступен 89991112233\nНеобязательный параметр, если испольщзуется username в канале tdlib\",\"enabled\":false}]

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

caption | необязательный | Описание под файлом. Используется для отправки в whatsapp.

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

string | необязательный | Внутренний ID клиента.

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

string | необязательный | Нативная отправка кратинок. При значении document - отправляется файл, при значении image - отправляется картинка. Используется для отправки в whatsapp.

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

string | необязательный | Имя отправителя. Можно указывать доступные для клиента имена отправителей. При отсутствии параметра или невалидности заменяется на “PUSHSMS.RU”

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

string | необязательный | Метка для маркировки отправок.

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

string | необязательный | URL-адрес, на который будет автоматически высылаться информация при обновлении статуса отправки. Структура в соответствующем разделе.

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

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

array | необязательный | Каналы и последовательность отправки сообщения. Управление функционалом каскадной отправки. Каналы отправки - whatsapp и tdlib, max

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

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

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

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

string | необязательный | Message id сообщения, используется для цитирования

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

string | необязательный | ID tdlib клиента, используется вместо телефона или имени, при отправке в через роутинг tdlib

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

boolean | необязательный | Дефолтное значение - true.Со значением true тайпинг срабатывает), false текст-описание под файлом отправляется без тайпинга.

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

\n","type":"text/plain"},"key":"avito_chat_id","value":null}],"variable":[]}},"response":[{"id":"59f33026-7df6-41f4-a2de-6e1bf7d63d1c","name":"Успешный результат","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"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=79123456789&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":"79123456789","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":"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{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"delivery\": {\n \"id\": 19963,\n \"priority\": \"high\",\n \"phone\": \"+79123456789\",\n \"sum\": \"0.0\",\n \"external_id\": 12345,\n \"scheduled_at\": null,\n \"reply_to_message_id\": null,\n \"sender_name\": \"PUSHSMS.RU\",\n \"callback_url\": null,\n \"dispatch_routing\": [\n \"whatsapp\"\n ],\n \"utm_mark\": null,\n \"simulate_typing\": false,\n \"traffic_category\": 0,\n \"total_sms\": 1,\n \"status_id\": 6,\n \"status_description\": \"Принято\"\n }\n}"},{"id":"fcc06079-3a94-44f7-afce-6e033b349c29","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"file | обязательный | Отправляемый файл. Поддерживаемые форматы описаны здесь. ","type":"file","src":"BEE4S3-Ny/0007.amr"}],"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":"bd3efd27-9192-4791-9ddb-e003716be25a"},{"name":"Проверка наличия аккаунта WhatsApp","id":"7720e9fb-a3f2-4699-8ede-f7e073603060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/api/v1/checkwhatsapp","description":"

Метод для проверки наличия аккаунта Whatsapp на номере телефона

\n","urlObject":{"protocol":"https","path":["api","v1","checkwhatsapp"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

integer | обязателеный | проверяемый телефон в whatsapp

\n","type":"text/plain"},"key":"phone","value":""}],"variable":[]}},"response":[{"id":"43a830fe-3099-43a7-a81a-64a250e69962","name":"Успешный","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/checkwhatsapp?phone=7912345678","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","checkwhatsapp"],"query":[{"key":"phone","value":"7912345678"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 09 Sep 2024 12:33:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F_OTeTQelVynB2kAAQNB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"exists\": true\n}"},{"id":"87343a13-1525-41eb-ae11-096276d3a791","name":"Ошибка, 422 (невалидный номер)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/checkwhatsapp?phone=79859386143","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","checkwhatsapp"],"query":[{"key":"phone","value":"79859386143"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 09 Sep 2024 12:33:04 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":"F_OTbkqPbiaWtpAAAQDB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"exists\": false\n}"},{"id":"ed51f919-dece-4ecb-a1da-34335e0aed09","name":"Ошибка, 422 (неавторизованная сессия)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/checkwhatsapp?phone=79123456789","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","checkwhatsapp"],"query":[{"key":"phone","value":"79123456789"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 09 Sep 2024 12:39:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"113"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F_OTyqeHKwZ_kLAAARIB"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"session\": [\n \"session not_found\"\n ]\n }\n }\n}"},{"id":"67ac87cb-1186-41be-aab6-07f69268c3aa","name":"Ошибка, 422 (пустой телефон)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/checkwhatsapp","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","checkwhatsapp"],"query":[{"key":"phone","value":"79234556778","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 09 Sep 2024 13:43:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"114"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F_OXTO0By6ox_7AAAFkD"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"phone\": [\n \"phone can't be blank\"\n ]\n }\n }\n}"},{"id":"32926e7a-1e8f-4251-b8d0-6624ab911bdf","name":"Проверка наличия аккаунта WhatsApp","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/checkwhatsapp?phone=79255180633 ","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","checkwhatsapp"],"query":[{"key":"phone","value":"79255180633 ","description":"integer | обязателеный | проверяемый телефон в whatsapp "}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 29 Aug 2025 16:04:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GGBIYngzkaIOnk0AASGJ"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"exists\": true\n}"}],"_postman_id":"7720e9fb-a3f2-4699-8ede-f7e073603060"},{"name":"Удаление сообщения","id":"f0c79db2-b7cc-4d5a-932a-ed88ac09741e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.chatpush.ru/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

Краткое описание	Удаление отправленных сообщений в мессенджер whatsapp и телеграм через tdlib
Авторизация	Необходима
HTTP-метод	DELETE
URL	https://api.chatpush.ru/api/v1/delivery/:delivery_id
Варианты ответа	Успешный с HTTP-кодом 200, неуспешный с кодом 422

Удаление работает только для сообщений, отправленных через канал tdlib (то есть Telegram через TDLib) и Whatsapp.
\n
Если сообщение не найдено или уже было удалено — возвращается ошибка 422 с соответствующим описанием.
\n
Удаляются только те сообщения, которые были отправлены через сервис Chatpush.
\n
Удаление происходит, если сообщение имеет в системе успешный финальный статус \"Доставлено\".
\n
Удаление осуществляется на всех устройствах.
\n

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

integer | обязательный | ID сообщения, подлежащего удалению. Идентификатор получается из поля delivery.id в JSON-ответе на запрос метода отправки сообщений. (https://dev.docs2.chatpush.ru/#1bf0ef27-0f1d-4545-a2d2-e8623aaaa31a)

\n","type":"text/plain"},"type":"any","value":"","key":"delivery_id"}]}},"response":[{"id":"3f51b910-62fd-4732-b855-9bc4cc8cbcd3","name":"Успешный результат","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","delivery",":delivery_id"],"variable":[{"key":"delivery_id","value":""}]}},"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":"8793dedf-dc16-448f-84a5-fa828e3806e0","name":"Ошибка, 422 (for tdlib)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chatpush","ru"],"path":["api","v1","delivery",":delivery_id"],"variable":[{"key":"delivery_id","value":"233"}]}},"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 \"tdlib_delivery\": [\n \"tdlib_delivery не найден\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"2d2a8a1b-164c-4ce3-920a-42ae9e13cc70","name":"Ошибка, 422 (for whatsapp)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chatpush","ru"],"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 \"отправка не найден\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"6c5c88b2-e417-4a46-b167-1c680210b5d4","name":"Ошибка, 422 (dispatch_type invalid)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chatpush","ru"],"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":"463708df-d9ce-440f-a0f9-a1ad7c5e8669","name":"Ошибка, 422 (not complete)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chatpush.ru/api/v1/delivery/:delivery_id","protocol":"https","host":["api","chatpush","ru"],"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 \"delivery\": [\n \"отправка not_complete\"\n ]\n },\n \"status_id\": null\n }\n}"}],"_postman_id":"f0c79db2-b7cc-4d5a-932a-ed88ac09741e"}],"id":"c4ffb92e-ea40-4948-a285-1d1650722cc0","description":"

Авторизация token

В проекте применяется token-based авторизация. Необходимый access_token можно получить в соответствующем разделе личного кабинета конкретного инстанса или в ответе при создании инстанса.

Во всех соответствующих запросах в headers должно содержаться следующее:

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

Ключ	Значение
Authorization	Bearer {access_token}
Content-Type	application/json

Пример:

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

При отсутствии данных параметров или их не валидности во всех соответствующих ресурсах, ответ будет иметь: HTTP-код 401 (Not authorized) и будет содержать JSON:

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

\n","_postman_id":"c4ffb92e-ea40-4948-a285-1d1650722cc0"},{"name":"iFrame Вебмессенджер","item":[{"name":"Создание ссылки","id":"57af2931-dc1f-4661-a6cc-a87698997611","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/api/developer_chat/generate_link","urlObject":{"protocol":"https","path":["api","developer_chat","generate_link"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

string| необязателен | Пароль от iframe Длина пароля ≥ 7 Должен быть спецсимвол. Является обязательным, если параметр auth_type=0.

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

string| необязателен | Параметр auth_type=0 - включение обязательного ввода пароля при входе в чат. Если не передан auth_type, то принимаем его за 0.\nauth_type=1 - отключение ввода пароля при входе в чат.

\n","type":"text/plain"},"key":"auth_type","value":null}],"variable":[]}},"response":[{"id":"71bb73c9-6f38-4926-89d5-d4ed4e690faa","name":"Успешный результат","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/developer_chat/generate_link?password=Qwerty$","protocol":"https","host":["api","chatpush","ru"],"path":["api","developer_chat","generate_link"],"query":[{"key":"password","value":"Qwerty$","description":"string| обязателен | Пароль от iframe Длина пароля ≥ 7 Должен быть спецсимвол"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 10 Apr 2024 10:42:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"161"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F8TlLuSAeE01_04AJ1jH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"link\": {\n \"link\": \"https://api.chatpush.ru/developer_chat?customer_id=17693&hash=343c7bd8d5efbfa33528b711598989cf66317bd1\"\n }\n}"},{"id":"4754263e-4578-4baa-840b-784da488821d","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/developer_chat/generate_link?password=qwerty","protocol":"https","host":["api","chatpush","ru"],"path":["api","developer_chat","generate_link"],"query":[{"key":"password","value":"qwerty","description":"string| обязателен | Пароль от iframe Длина пароля ≥ 7 Должен быть спецсимвол"}]}},"_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 \"password\": [\n \"password должен содержать хотя бы один спецсимвол\"\n ]\n },\n \"status_id\": null\n }\n}"}],"_postman_id":"57af2931-dc1f-4661-a6cc-a87698997611"},{"name":"Смена пароля","id":"34ea448d-f840-4963-b14f-1397c63b95f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/api/developer_chat/change_password","urlObject":{"protocol":"https","path":["api","developer_chat","change_password"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

string | обязателен | Пароль для авторизации в iframe Длина пароля ≥ 7 знаков\nПароль обязательно должен включать цифру или/и символ

\n","type":"text/plain"},"key":"password","value":""}],"variable":[]}},"response":[{"id":"2e40ee15-ca52-41b6-a862-d62cb9987466","name":"Успешный результат","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/developer_chat/change_password?password=Qwerrty1234","protocol":"https","host":["api","chatpush","ru"],"path":["api","developer_chat","change_password"],"query":[{"key":"password","value":"Qwerrty1234","description":"string | обязателен | ПарольДлина пароля ≥ 7 \nДолжен быть символ","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 10 Apr 2024 10:59:43 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":"F8TmH_bR4dMJfF0AAoXh"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n }\n}"},{"id":"e49ad32e-6c79-4382-9621-83e2c49c0716","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.chatpush.ru/api/developer_chat/change_password?password=Qwerr","protocol":"https","host":["api","chatpush","ru"],"path":["api","developer_chat","change_password"],"query":[{"key":"password","value":"Qwerr","description":"string | обязателен | ПарольДлина пароля ≥ 7 \nДолжен быть символ","type":"text"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 10 Apr 2024 11:00:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"241"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F8TmJmxVzr_H2wAAAPXF"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"password\": [\n \"password at least one digit or punctuation character\",\n \"password должны содержать минимум 7 символа\"\n ]\n },\n \"status_id\": null\n }\n}"}],"_postman_id":"34ea448d-f840-4963-b14f-1397c63b95f2"},{"name":"Изменение имени клиента","id":"6bbcdc00-a4bc-436d-860e-525d44d4850d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"url":"https://api.chatpush.ru/api/developer_chat/conversations/client_name","description":"

Метод позволяет обновлять имя клиента (crm_client_name) в диалоге, используя такие параметры как номер телефона (phone), имя пользователя в Telegram (tdlib_username), или идентификатор пользователя в Telegram (tdlib_user_id). Если диалог найден, его имя будет обновлено.

Как минимум одно из полей phone, tdlib_username, или tdlib_user_id должно быть указано в запросе для поиска диалога.

\n","urlObject":{"protocol":"https","path":["api","developer_chat","conversations","client_name"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

обязательный | string | Новое имя для клиента

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

необязательный | string | Номер телефона клиента для поиска диалога.

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

необязательный | string | Имя пользователя Telegram для поиска диалога

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

необязательный | string | Идентификатор пользователя Telegram для поиска диалога

\n","type":"text/plain"},"key":"tdlib_user_id","value":null}],"variable":[]}},"response":[{"id":"cf356c6d-f385-4475-a142-ed501589d555","name":"Успешный результат","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://staging.api.chatpush.ru/api/developer_chat/conversations/client_name?name=Тест&phone=8912345678&tdlib_username=Testoff&tdlib_user_id=3484762","protocol":"https","host":["staging","api","chatpush","ru"],"path":["api","developer_chat","conversations","client_name"],"query":[{"key":"name","value":"Тест","description":"обязательный | string | Новое имя для клиента","type":"text"},{"key":"phone","value":"8912345678","description":"необязательный | string | Номер телефона клиента для поиска диалога.","type":"text"},{"key":"tdlib_username","value":"Testoff","description":"необязательный | string | Имя пользователя Telegram для поиска диалога","type":"text"},{"key":"tdlib_user_id","value":"3484762","description":"необязательный | string | Идентификатор пользователя Telegram для поиска диалога","type":"text"}]}},"_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 \"conversations\": [\n {\n \"id\": 248,\n \"updated_at\": \"2024-08-30T08:51:51\",\n \"customer_id\": 54,\n \"created_at\": \"2024-06-14T12:18:27\",\n \"tdlib_user_id\": 3484762,\n \"tdlib_username\": \"Testoff\",\n \"messenger_client_name\": \"Testoff\",\n \"crm_client_name\": \"Тест\",\n \"client_phone\": \"8912345678\",\n \"conversation_type\": \"tdlib\"\n }\n ]\n}"},{"id":"b1314293-3b28-4e17-8b0b-a0c8f4861b32","name":"Ошибка, 422","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://staging.api.chatpush.ru/api/developer_chat/conversations/client_name?name&phone=79123456789","protocol":"https","host":["staging","api","chatpush","ru"],"path":["api","developer_chat","conversations","client_name"],"query":[{"key":"name","value":null,"description":"обязательный | string | Новое имя для клиента","type":"text"},{"key":"phone","value":"79123456789","description":"необязательный | string | Номер телефона клиента для поиска диалога.","type":"text"},{"key":"tdlib_username","value":null,"description":"необязательный | string | Имя пользователя Telegram для поиска диалога","type":"text","disabled":true},{"key":"tdlib_user_id","value":null,"description":"необязательный | string | Идентификатор пользователя Telegram для поиска диалога","type":"text","disabled":true}]}},"_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 \"name\": [\n \"имя не может быть пустым\"\n ]\n },\n \"status_id\": null\n }\n}\n"}],"_postman_id":"6bbcdc00-a4bc-436d-860e-525d44d4850d"},{"name":"Открытие чата по номеру телефона","id":"71e851cc-6163-48e5-80af-2603dc6c674d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/developer_chat","description":"

Логика открытия чата по номеру телефона

Если у клиента с запрашиваемым номером телефона есть чат в двух мессенджерах (whatsapp и telegram), то откроется чат с более свежими сообщениями.

Если у клиента с запрашиваемым номером телефона есть чат в одном из мессенджеров (whatsapp или telegram), то откроется диалог в этом мессенджере.

Если у клиента с запрашиваемым номером телефона нет чатов, то открыется чат по умолчанию в мессенджере whatsapp.

Ошибки

при передаче пустого значения у параметра username отображается ошибка:

Не передано имя пользователя. Для корректной работы чата, необходимо имя пользователя. Проверьте детали и попробуйте еще раз.\n\n

При передаче невалидного номера телефона в параметре phone (каналы: “dispatch_routing”= ”tdlib”/ “whatsapp”) отображается ошибка:

акого номера нет. Мы не смогли найти клиента с указанным номером. Проверьте детали и попробуйте еще раз.\n\n

","urlObject":{"protocol":"https","path":["developer_chat"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

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

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

string | обязательный | уникальное значение, располагает в ссылке, которая приходит в ответе на создание iframe

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

string | обязательный | телефон получателя сообщения

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

string | необязательный | канал отправки. Доступные значения - whatsapp, tdlib и max. На основе этого параметра будет открыт чат WhatsApp, Telegram или Max.

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

integer | необязательный | sender_id получателя сообщения. Параметр доступен при отправке по каналу tdlib

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

string | необязательный | username получателя сообщения. Параметр доступен при отправке по каналу tdlib

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

boolean | необязательный | Изолирование диалога. False (дефолтное) - можно вернуться в список чатов. True - изолированный диалог без возможности попасть в список чатов

\n","type":"text/plain"},"key":"chat_only","value":""}],"variable":[]}},"response":[],"_postman_id":"71e851cc-6163-48e5-80af-2603dc6c674d"},{"name":"Добавление кастомных заметок в чат","id":"ea7c5b4d-ace8-43d5-9d9f-c3d6530572a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\n \"phone\": \"79123456789\",\n\n \"notes\": [\n\n {\n\n \"title\": \"Text\",\n\n \"body\": \"[Hello](https://google.com) Test_\\n Test _test_.\"\n\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chatpush.ru/api/developer_chat/conversations/notes","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

Краткое описание	Добавление кастомных заметок в чат
Авторизация	Необходима
HTTP-метод	PUT
URL	https://api.chatpush.ru/api/developer_chat/conversations/notes
Варианты ответа	Успешный c http-кодом 200, неуспешные с кодом 422

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

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

Ключ	Обязательный	Тип данных	Описание
phone	Условно (см. описание)	string	Номер телефона. Обязателен, если не указаны `tdlib_username` или `tdlib_user_id`.
tdlib_username	Условно (см. описание)	string	Имя пользователя в Telegram. Обязателен, если не указан `phone` и указан `tdlib_user_id`.
tdlib_user_id	Условно (см. описание)	integer	ID пользователя в Telegram. Обязателен, если не указан `phone` и указан `tdlib_username`.
notes	Да	array	Массив объектов, представляющих заметки.
notes.title*	Условно (см. описание)	string	Заголовок заметки. Обязателен, если указан body. (см. описание ниже)
notes.body**	Условно (см. описание)	string	Содержание заметки Обязателен, если указан title. (см. описание)

Поле title*

Максимальная длина: 255 символов
\n
Поддерживаемая разметка: Markdown ([Текст ссылки](URL), _курсив_, \\n), произвольный текст (латиница, кириллица)
\n

Поле body**

Максимальная длина: 1000 символов
\n
Поддерживаемая разметка: Markdown ([Текст ссылки](URL), _курсив_, \\n), произвольный текст (латиница, кириллица)
\n

Дополнительно:

чтобы удалить - надо отправить пустой массив.
\n
есть диалоги на один телефон и в tdlib, и в whatsapp, то они будут обновлены вместе
\n

Описание параметров ответа с HTTP-кодом 200

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

Ключ	Тип данных	Описание
meta	object	Объект, содержащий метаданные ответа.
meta.code	integer	Код ответа сервера.
meta.status	string	Статус ответа сервера (\"success\" в случае успеха).
conversations	array	Массив объекто.
conversations.id	integer	Уникальный идентификатор разговора.
conversations.updated_at	string (ISO 8601 timestamp)	Дата и время последнего обновления разговора.
conversations.customer_id	integer	Идентификатор клиента.
conversations.client_phone	string	Номер телефона клиента.
conversations.conversation_type	string	Тип диалога (например, \"whatsapp\").
conversations.created_at	string (ISO 8601 timestamp)	Дата и время создания диалога.
conversations.notes	array	Массив объектов, представляющих заметки к диалога.
conversations.notes.title	string	Заголовок заметки.
conversations.notes.body	string	Содержание заметки (может содержать Markdown).
conversations.tdlib_user_id	integer (или null)	ID пользователя в TDLib. Может быть null.
conversations.tdlib_username	string (или null)	Имя пользователя в Telegram. Может быть null.
conversations.messenger_client_name	string (или null)	Имя клиента в мессенджере. Может быть null.
conversations.crm_client_name	string (или null)	Имя клиента в CRM-системе. Может быть nul.

Описание параметров ответа с HTTP-кодом 422

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

Ключ	Тип данных	Описание
meta	object	Объект, содержащий метаданные ответа об ошибке.
meta.code	integer	Код ошибки (например, 422 - Unprocessable Entity).
meta.message	string	Сообщение об ошибке.
meta.status	string	Статус ответа (\"fail\" в случае ошибки).
meta.errors	object	Объект, содержащий детали об ошибках валидации. Ключи объекта соответствуют именам полей, содержащих ошибки.
meta.errors.notes	array	Массив строк, содержащих сообщения об ошибках для поля `notes`. Пример: `[\"notes должно иметь максимум 2 части\"]`
meta.errors.phone	array	Массив строк, содержащих сообщения об ошибках для поля `phone`. Пример: `[\"Phone number One of these fields must be present: [:phone, :tdlib_username, :tdlib_user_id]\"]`
meta.status_id	null	Всегда `null`.

Пояснения:

Поля meta.errors.notes и meta.errors.phone представлены как примеры. В реальном ответе meta.errors может содержать и другие поля с массивами ошибок в зависимости от того, какие поля не прошли валидацию. Ключи этих полей соответствуют именам полей запроса, в которых произошли ошибки.
\n
Тип данных значений в массивах meta.errors.X - это string. Они содержат текстовое описание ошибки.
\n

\n","urlObject":{"protocol":"https","path":["api","developer_chat","conversations","notes"],"host":["api","chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"831d59cd-47ac-4f55-97ce-2090f914171b","name":"Успешный результат","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\n \"phone\": \"79123456789\",\n\n \"notes\": [\n\n {\n\n \"title\": \"Text\",\n\n \"body\": \"[Hello](https://google.com) Test_\\n Test _test_.\"\n\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chatpush.ru/api/developer_chat/conversations/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"conversations\": [\n {\n \"id\": 4071161,\n \"updated_at\": \"2025-05-23T13:54:33\",\n \"customer_id\": 2003,\n \"client_phone\": \"79123456789\",\n \"conversation_type\": \"whatsapp\",\n \"created_at\": \"2025-05-23T13:38:18\",\n \"notes\": [\n {\n \"title\": \"Тест\",\n \"body\": \"[Hello](https://google.com) Test_\\n Test _test_.\"\n }\n ],\n \"tdlib_user_id\": null,\n \"tdlib_username\": null,\n \"messenger_client_name\": null,\n \"crm_client_name\": null\n }\n ]\n}"},{"id":"70c2b835-fda3-4aaf-9cac-7377c18a0239","name":"Ошибка, 422","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\n \"phone\": \"79123456789\",\n\n \"notes\": [\n\n {\n\n \"title\": \"Text\"\n\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chatpush.ru/api/developer_chat/conversations/notes"},"code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"errors\": {\n \"notes\": [\n \"notes должно иметь максимум 2 части\"\n ]\n },\n \"status_id\": null\n }\n}"},{"id":"79832b36-0771-40c3-966b-a1c9e1355f49","name":"Ошибка, 422","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\n \"notes\": [\n\n {\n\n \"title\": \"Text\",\n\n \"body\": \"[Hello](https://google.com) Test_\\n Test _test_.\"\n\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chatpush.ru/api/developer_chat/conversations/notes"},"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 \"phone\": [\n \"Phone number One of these fields must be present: [:phone, :tdlib_username, :tdlib_user_id]\"\n ]\n },\n \"status_id\": null\n }\n}"}],"_postman_id":"ea7c5b4d-ace8-43d5-9d9f-c3d6530572a0"},{"name":"Удаление чатов из iframe","id":"696d5ef4-d1e7-4c9b-9ff7-f866dbaffaa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.chatpush.ru/api/developer_chat/","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

Краткое описание	Удаление чатов в iframe
Авторизация	Bearer Token customer (клиент)
HTTP-метод	DELETE
URL	https://api.chatpush.ru/api/developer_chat/
Варианты ответа	Успешный c http-кодом 200, неуспешные с кодом 401

Дополнительно:

В случае, если у клиента нет записей в нашей системе - код ответа 200, поля deleted_messages_count и deleted_conversations_count будут отдавать значения = 0.

Описание параметров ответа с HTTP-кодом 200

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

Ключ	Тип данных	Описание
meta	object	Объект, содержащий метаданные ответа.
meta.code	integer	Код ответа сервера.
meta.status	string	Статус ответа сервера (\"success\" в случае успеха).
customer_id	integer	ID клиента
deleted_messages_count	integer	Количество удаленных сообщений
deleted_conversations_count	integer	Количество удаленных диалогов

Описание параметров ответа с HTTP-кодом 401

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

Ключ	Тип данных	Описание
meta	object	Объект, содержащий метаданные ответа об ошибке.
meta.code	integer	Код ошибки (например, 422 - Unprocessable Entity).
meta.message	string	Сообщение об ошибке.
meta.status	string	Статус ответа (\"fail\" в случае ошибки).

","urlObject":{"protocol":"https","path":["api","developer_chat",""],"host":["api","chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"26fd2564-6809-44b3-b578-39c08ee320d7","name":"Удаление чатов из iframe","originalRequest":{"method":"DELETE","header":[],"url":"https://api.chatpush.ru/api/developer_chat/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"status\": \"success\"\n },\n \"customer_id\": 657,\n \"deleted_messages_count\": 1,\n \"deleted_conversations_count\": 1\n}"},{"id":"eb0fe77e-beb8-4ef8-a17f-822648fad252","name":"Ошибка 401","originalRequest":{"method":"DELETE","header":[],"url":"https://api.chatpush.ru/api/developer_chat/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 401,\n \"message\": \"Not authorized!\",\n \"status\": \"fail\"\n }\n}"}],"_postman_id":"696d5ef4-d1e7-4c9b-9ff7-f866dbaffaa2"}],"id":"761f3d72-6b9e-47c3-8207-eb0ebdd8168d","description":"

Создание ссылки на чат

Авторизация token

Во всех соответствующих запросах в headers должно содержаться следующее:

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

Ключ	Значение
Authorization	Bearer {access_token}
Content-Type	application/json

Пример:

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

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

Desktop версия чата

Для открытия desktop чата нужно добавить параметр в ссылку - &desktop=1 (или true/yes). При значениях параметра 0/false/no открыт обычный чат iframe.

Примечание

Ссылка на developer чат iframe доступна и формируется только для instance.
\n
На данный момент для канала max не работает отправка файлов через iframe, файлы будут отображены, если были отправлены не через нашу систему.
\n
Для каналов max_bot и telegram (telegram bot) в iFrame отображаются только входящие сообщения от клиента боту. Сообщения, отправленные и сформированные ботом клиенту (например: ответы бот-помощника, уведомления из ЛК chatpush, через API chatpush, в iframe не отображаются, за исключением сообщений отправленных непосредственно через интрфейс iFrame. Также для канала этих каналов не работает отправка и получение файлов через iframe.
\n

\n","_postman_id":"761f3d72-6b9e-47c3-8207-eb0ebdd8168d"},{"name":"Webhooks","item":[{"name":"Доступные события","item":[{"name":"whatsapp_log_out","item":[],"id":"e999259c-73d5-4207-a77d-8ca1b8f0f5df","description":"

Информация о деавторизации клиента в whatsapp

| |

Пример уведомления - whatsapp_log_out

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

Параметры

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

Ключ	Тип данных	Описание
instance	object	Объект инстанса
id	integer	ID инстанса
customer_id	integer	Внутренний ID клиента
email	string	Email клиента
phone	string	Телефон клиента
status	object	Объект статуса
status_id	integer	ID статуса
description	string	Краткое описание статуса

","_postman_id":"e999259c-73d5-4207-a77d-8ca1b8f0f5df"},{"name":"whatsapp_log_in","item":[],"id":"e0c808ab-d09e-4b2e-a35c-7589a931a87d","description":"

Информация об авторизации клиента в whatsapp

| |

Пример уведомления - 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

Параметры

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

Ключ	Тип данных	Описание
instance	object	Объект инстанса
id	integer	ID инстанса
status	object	Объект статуса
description	string	Краткое описание статуса
status_id	integer	ID статуса
email	string	Email клиента
phone	string	Телефон клиента
customer_id	integer	Внутренний ID клиента

","_postman_id":"e0c808ab-d09e-4b2e-a35c-7589a931a87d"},{"name":"whatsapp_incoming_msg","item":[],"id":"9f2afd05-8915-4d81-b0ac-633d0464cb30","description":"

Информация о поступающих и исходящих сообщений на авторизованный аккаунт whatsapp

Пример уведомления - whatsapp_incoming_msg

\n
Уведомления имеют разную структуру, в зависимости от содержания сообщения. Ниже представлены примеры текстовых уведомлений и уведомлений с файлами. Система забирает картинку/файл и преобразует в ссылку для скачивания.
\n

Исходящее:

{\n  \"payload\": {\n    \"delivery_id\": 170405,\n    \"instance\": {\n      \"customer_id\": 77,\n      \"id\": 2892\n    },\n    \"new_message\": {\n      \"direction\": \"outgoing\",\n      \"message\": {\n        \"id\": \"true_79123456789@c.us_71385THISISBOT\",\n        \"reply_to_message_id\": \"false_79123456789@c.us_3EB02933F606E086905D11\",\n        \"text\": \"тест\",\n        \"timestamp\": 1691591769,\n        \"type\": \"text\"\n      },\n      \"pushname\": \"UserNameOwn\",\n      \"sender_id\": \"79111111111@c.us\",\n      \"chat_id\": \"79123456789@c.us\", \n      \"sender_name\": \"BotPushSms\",\n      \"chat_lid\": \"251844332921033@lid\",\n      \"chat_phone\": \"79123456789\",\n      \"sender_phone_number\": \"79111111111\",\n      \"recipient_id\": \"79123456789@c.us\",\n      \"recipient_phone_number\": \"79123456789\"\n    }\n  },\n  \"type\": \"whatsapp_incoming_msg\"\n}\n\n

Исходящее с файлом:

{\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_79123456789@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\": \"Отправка файла\",\n          \"download_url\": \"https://production-docs.storage.yandexcloud.net/delivery_files_new/83a38f/e901c444/288d0008/fd5702ea/test.doc?X-Amz-Algorithm=AWS4-HMAC-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\": \"79932846453@c.us\",\n      \"chat_id\": \"79123456789@c.us\",\n      \"sender_name\": \"Тестовый\",\n      \"chat_lid\": \"4846447809451@lid\",\n      \"pushname\": \"Chatpush\",\n      \"chat_phone\": \"79123456789\",\n      \"sender_phone_number\": \"79932846453\",\n      \"recipient_id\": \"79123456789@c.us\",\n      \"recipient_phone_number\": \"79123456789\"\n    },\n    \"delivery_id\": 29290746\n  }\n}\n\n

Входящее:

{\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_79123456789@c.us_3B55D8ECE08DAC8198EB\",\n        \"timestamp\": 1764069562,\n        \"type\": \"text\",\n        \"text\": \"Входящее\",\n        \"reply_to_message_id\": null\n      },\n      \"direction\": \"incoming\",\n      \"sender_id\": \"79123456789@c.us\",\n      \"chat_id\": \"79123456789@c.us\",\n      \"sender_name\": \"\\u202a+79123456789\\u202c\",\n      \"chat_lid\": \"4846447393451@lid\",\n      \"pushname\": \"Test\",\n      \"chat_phone\": \"79123456789\",\n      \"sender_phone_number\": \"79123456789\"\n    },\n    \"delivery_id\": null\n  }\n}\n\n

Входящее с файлом:

{\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_79123456789@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\": \"Входящее файл\",\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-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Signature=c02ce108e06634c7f24958be34606aa2b9892a1f787458a8b0c8afeb1e0bb5c8\"\n        }\n      },\n      \"direction\": \"incoming\",\n      \"sender_id\": \"79123456789@c.us\",\n      \"chat_id\": \"79123456789@c.us\",\n      \"sender_name\": \"\\u202a+791234567893\\u202c\",\n      \"chat_lid\": \"48464478022451@lid\",\n      \"pushname\": \"Тест\",\n      \"chat_phone\": \"79123456789\",\n      \"sender_phone_number\": \"79123456789\"\n    },\n    \"delivery_id\": null\n  }\n}\n\n

Параметры текстовых событий

Ключ	Тип данных	Описание
`type`	string	Тип вебхука
`payload.instance.id`	integer	Внутренний ID инстанса
`payload.instance.customer_id`	integer	Внутренний ID клиента
`payload.new_message.message.id`	string	Внутренний ID сообщения WhatsApp
`payload.new_message.message.timestamp`	integer	Временная отметка, когда было отправлено сообщение
`payload.new_message.message.type`	string	Тип передаваемого объекта
`payload.new_message.message.text`	string	Текст сообщения
`payload.new_message.message.reply_to_message_id`	string	ID сообщения, на которое отвечают
`payload.new_message.direction`	string	Тип сообщения. incoming - входящее, outgoing - исходящее
`payload.new_message.sender_id`	string	ID отправителя сообщения
`payload.new_message.chat_id`	string	ID чата, в котором происходит переписка
`payload.new_message.sender_name`	string	Имя отравителя
`payload.new_message.chat_lid`	string	lid ID чата. Для исходящих куда отправляем, для входящих откуда отправляем
`payload.new_message.pushname`	string	Имя пользователя, как собеседник сам себя записал в Whatsapp
`payload.new_message.chat_phone`	integer	Номер получателя. Для исходящих куда отправляем, для входящих откуда отправляем
`payload.new_message.sender_phone_number`	string	Номер отправителя
`payload.new_message.recipient_id`	string	ID чата, в котором происходит переписка
`payload.new_message.recipient_phone_number`	integer	Номер получателя
`payload.delivery_id`	integer	Внутренний ID отправки. При отправке не из системы, параметр будет пустым.

Параметры файловых событий

Ключ	Тип данных	Описание
`type`	string	Тип вебхука
`payload.instance.id`	integer	Внутренний ID инстанса
`payload.instance.customer_id`	integer	Внутренний ID клиента
`payload.new_message.message.id`	string	Внутренний ID сообщения WhatsApp
`payload.new_message.message.timestamp`	integer	Временная отметка, когда было отправлено сообщение
`payload.new_message.message.type`	string	Тип передаваемого объекта
`payload.new_message.message.reply_to_message_id`	string	ID сообщения, на которое отвечают
`payload.new_message.message.file_data`	object	Объект отправки
`payload.new_message.message.file_data.mime_type`	string	Формат файла
`payload.new_message.message.file_data.caption`	string	Описание под файлом
`payload.new_message.message.file_data.download_url`	string	Ссылка для скачивания файла
`payload.new_message.direction`	string	Тип сообщения. incoming - входящее, outgoing - исходящее
`payload.new_message.sender_id`	string	ID отправителя сообщения
`payload.new_message.chat_id`	string	ID чата, в котором происходит переписка
`payload.new_message.sender_name`	string	Имя пользователя в WhatsApp
`payload.new_message.chat_lid`	string	lid ID чата. Для исходящих куда отправляем, для входящих откуда отправляем
`payload.new_message.pushname`	string	Имя пользователя, как собеседник сам себя записал в Whatsapp
`payload.new_message.chat_phone`	integer	Номер получателя. Для исходящих куда отправляем, для входящих откуда отправляем
`payload.new_message.sender_phone_number`	string	Номер отправителя
`payload.delivery_id`	integer	Внутренний ID отправки. При отправке не из системы, параметр будет пустым

Webhook о статусе сообщения

Webhook о статусе сообщения отправляется в рамках события \"whatsapp_incoming_msg\";
\n
Статус отправляется только по исходящему сообщению от авторизованного клиента.
\n

Пример передаваемого 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_lid\": \"48464478091151@lid\",\n      \"chat_phone\": \"995555123456\"\n    }\n  }\n}\n\n

Описание параметров webhook о статусе сообщения:

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

Ключ	Тип данных	Описание
`type`	string	Тип события.
`payload`	object	Основные данные события
`payload.instance`	object	Информация об аккаунте
`payload.instance.id`	integer	Внутренний ID инстанса
`payload.instance.customer_id`	integer	Внутренний ID клиента
`payload.delivery_id`	integer	Внутренний ID отправки. Может быть NULL
`payload.message_status`	object	Данные о статусе сообщения
`payload.message_status.id`	string	Уникальный статуса сообщения (формат для отправок через сервис chatpush: `\"true_995555123456@c.us_84110THISISBOT\",` формат для отправок другими способами: `\"true_995555123456@c.us_3A2E74ED29DF9BAB114E\"`)
`payload.message_status.status`	string	Статус сообщения
`payload.message_status.chat_id`	string	ID чата в формате `\"995555123456@c.us\"` (номер телефона + `@c.us`)
`payload.message_status.chat_lid`	string	lid ID чата
`payload.message_status.chat_phone`	integer	Номер получателя

Перечень передаваемых статусов:

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

Статус	Значение
sent	Сообщение отправлено на сервер WhatsApp
received	Доставлено на устройство получателя
read	Прочитано получателем
played	Проиграно (только для аудиосообщений)
failed	Не удалось отправить сообщение
expired	Истёк срок действия сообщения (например, долго не было сети)
content_gone	Контент больше недоступен (например, удалён или просрочен)
content_too_big	Контент слишком большой для отправки
content_unuploadable	Контент невозможно загрузить (возможно, повреждён)
inactive	Пользователь неактивен (например, удалён аккаунт или заблокирован)

Webhook о входящем вызове

Отправляется в рамках события \"whatsapp_incoming_msg\";
\n
Отправляется только по входящему вызову авторизованному клиенту;
\n
Содержит в себе информацию о факте звонка;
\n
Отправляется в момент поступления вызова на аккаунт.
\n

Пример передаваемого 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\": \"48464478093991@lid\",\n      \"chat_phone\": \"995555123456\",\n      \"sender_phone_number\": \"995555123456\"\n    }\n  }\n}\n\n

Описание параметров webhook о входящем вызове:

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

Ключ	Тип данных	Описание
`type`	string	Тип события
`payload`	object	Основные данные события
`payload.instance`	object	Информация об аккаунте
`payload.instance.id`	integer	Внутреннрий ID instance
`payload.instance.customer_id`	integer	Внутреннрий ID клиента
`payload.incoming_call`	object	Данные о входящем звонке
`payload.incoming_call.call`	object	Информация о звонке
`payload.incoming_call.call.id`	string	Уникальный ID звонка (хеш, например `\"280F899C331466501CDA1B608\"`)
`payload.incoming_call.call.timestamp`	integer	Unix-время звонка (например, `1751293264`)
`payload.incoming_call.call.type`	string	Тип звонка: `\"audio\"` или `\"video\"`
`payload.incoming_call.call.is_group`	boolean	Групповой ли звонок: `true`/`false`
`payload.incoming_call.direction`	string	Направление звонка: `\"incoming\"` (входящий)
`payload.incoming_call.sender_id`	string	ID отправителя в формате `\"<номер>@c.us\"`
`payload.incoming_call.chat_id`	string	ID чата в формате `\"<номер>@c.us\"`
`payload.incoming_call.sender_phone_number`	string	Номер телефона отправителя
`payload.incoming_call.chat_lid`	string	lid ID чата. Для исходящих куда отправляем, для входящих откуда отправляем
`payload.incoming_call.chat_phone`	integer	Номер получателя. Для исходящих куда отправляем, для входящих откуда отправляем

","_postman_id":"9f2afd05-8915-4d81-b0ac-633d0464cb30"},{"name":"tdlib_incoming_msg","item":[],"id":"fc0d322b-b1c9-4384-8090-8b8b9b6bbe7a","description":"

Информация о поступающих и исходящих сообщениях на авторизованный аккаунт Telegram номерной.

Пример уведомления - tdlib_incoming_msg

Исходящее:

{\n  \"type\": \"tdlib_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": 3575644160,\n      \"timestamp\": 1764170882,\n      \"type\": \"formattedText\",\n      \"text\": \"тест\",\n      \"reply_to_message_id\": null\n    },\n    \"instance\": {\n      \"id\": 6329,\n      \"customer_id\": 2707\n    },\n    \"direction\": \"outgoing\",\n    \"sender_id\": 841595272,\n    \"chat_id\": 3791677,\n    \"sender_name\": null,\n    \"chat_type\": \"person\",\n    \"delivery_id\": null,\n    \"sender_phone_number\": \"971568961130\",\n    \"recipient_id\": 3791677,\n    \"recipient_phone_number\": \"79123456789\",\n    \"recipient_username\": \"test2\"\n  }\n}\n\n

Исходящее с файлом:

{\n  \"type\": \"tdlib_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": 3576692736,\n      \"timestamp\": 1764171731,\n      \"type\": \"messagePhoto\",\n      \"reply_to_message_id\": null,\n      \"file_data\": {\n        \"mime_type\": \"image/jpeg\",\n        \"caption\": \"тест\",\n        \"download_url\": \"https://production-docs.storage.yandexcloud.net/delivery_files_new/319f65e2/269de26e/97180136344364_121.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=bipj3XwGMXa8-wO4T3mc/20251126/ru-central1/s3/aws4_request&X-Amz-Date=20251126T154214Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2ce5cd8ed195cadea2c1e1aff4eef312fb094366a287e6718e1ad8b415152a95\"\n      }\n    },\n    \"instance\": {\n      \"id\": 6329,\n      \"customer_id\": 2707\n    },\n    \"direction\": \"outgoing\",\n    \"sender_id\": 841519522,\n    \"chat_id\": 3791707,\n    \"sender_name\": null,\n    \"chat_type\": \"person\",\n    \"delivery_id\": null,\n    \"sender_phone_number\": \"971568961134\",\n    \"recipient_id\": 3791707,\n    \"recipient_phone_number\": \"79123456789\",\n    \"recipient_username\": \"test2\"\n  }\n}\n\n

Входящее:

{\n  \"type\": \"tdlib_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": 357774131,\n      \"timestamp\": 1764171842,\n      \"type\": \"formattedText\",\n      \"text\": \"тест\",\n      \"reply_to_message_id\": null\n    },\n    \"instance\": {\n      \"id\": 6329,\n      \"customer_id\": 2787\n    },\n    \"direction\": \"incoming\",\n    \"sender_id\": 3791707,\n    \"chat_id\": 3791707,\n    \"sender_name\": \"test2\",\n    \"chat_type\": \"person\",\n    \"delivery_id\": null,\n    \"sender_phone_number\": \"79123456789\"\n  }\n}\n\n

Входящее с файлом:

{\n  \"type\": \"tdlib_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": 3578789888,\n      \"timestamp\": 1764171930,\n      \"type\": \"messagePhoto\",\n      \"reply_to_message_id\": null,\n      \"file_data\": {\n        \"mime_type\": \"image/jpeg\",\n        \"caption\": \"тест\",\n        \"download_url\": \"https://production-docs.storage.yandexcloud.net/delivery_files_new/dc9c0514/84ba70a2/84ca616f/21.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=bipj3XwGMXa8-wO4T3mc/20251126/ru-central1/s3/aws4_request&X-Amz-Date=20251126T154533Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=88cb9fa1de6aa511ca31b1e2642fcddbd2983c3b4e94adab7f18ca7438506bf0\"\n      }\n    },\n    \"instance\": {\n      \"id\": 6329,\n      \"customer_id\": 2707\n    },\n    \"direction\": \"incoming\",\n    \"sender_id\": 379707,\n    \"chat_id\": 379707,\n    \"sender_name\": \"test2\",\n    \"chat_type\": \"person\",\n    \"delivery_id\": null,\n    \"sender_phone_number\": \"79123456789\"\n  }\n}\n\n

Параметры

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

Ключ	Тип данных	Описание
`type`	string	Тип вебхука
`payload.instance.id`	integer	Внутренний ID инстанса
`payload.instance.customer_id`	integer	Внутренний ID клиента
`payload.chat_id`	integer	ID чата, в котором происходит переписка
`payload.chat_type`	string	Тип чата
`payload.delivery_id`	integer	Внутренний ID отправки. При отправке не из системы (через чат), параметр будет пустым
`payload.direction`	string	Тип сообщения. Incoming - входящее, outgoing - исходящее
`payload.message.id`	integer	Внутренний ID сообщения
`payload.message.timestamp`	integer	Временная отметка, когда было отправлено сообщение
`payload.message.type`	string	Тип передаваемого объекта
`payload.message.reply_to_message_id`	string	ID сообщения, на которое отвечают
`payload.sender_id`	integer	ID отправителя сообщения
`payload.sender_name`	string	Имя отправителя
`payload.sender_phone_number`	string	Номер отправителя
`payload.recipient_id`	integer	ID получателя
`payload.recipient_phone_number`	string	Номер получателя
`payload.recipient_username`	string	Имя получателя

Дополнительные поля для сообщений с файлами

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

Ключ	Тип данных	Описание
`payload.message.file_data`	object	Объект отправки
`payload.message.file_data.mime_type`	string	Формат файла
`payload.message.file_data.caption`	string	Описание под файлом
`payload.message.file_data.download_url`	string	Ссылка для скачивания файла

Звонок telegram:

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

Ключ	Тип данных	Описание
payload	object	Объект с данными вебхука
payload.type	string	Тип вебхука. Всегда `tdlib_call`
payload.chat_id	integer	ID чата, в котором происходил звонок
payload.chat_type	string	Тип чата (например, `person`)
payload.direction	string	Тип звонка: `incoming` (входящий) или `outgoing` (исходящий)
payload.instance	object	Объект, содержащий информацию об инстансе (если вызов пришёл от разработчика)
payload.instance.customer_id	integer	Внутренний ID клиента, привязанный к инстансу
payload.instance.id	integer	Уникальный ID инстанса
payload.sender_id	integer	ID пользователя, инициировавшего звонок
payload.sender_name	string	Имя пользователя, сделавшего звонок
payload.sender_phone_number	string	Номер телефона пользователя
payload.call	object	Информация о звонке
payload.call.id	integer	Уникальный ID звонка
payload.call.is_video	boolean	Флаг, обозначающий, был ли звонок видеозвонком
payload.call.state	string	Текущее состояние звонка. Возможное значение: `callStateDiscarded` (завершён)
payload.call.reason	string	Причина завершения звонка. Возможные значения:• `callDiscardReasonAllowGroupCall` — завершён для участия в групповом звонке• `callDiscardReasonDeclined` — отклонён• `callDiscardReasonDisconnected` — потеря соединения• `callDiscardReasonEmpty` — завершён без явной причины• `callDiscardReasonHungUp` — завершён пользователем• `callDiscardReasonMissed` — пропущен

","_postman_id":"fc0d322b-b1c9-4384-8090-8b8b9b6bbe7a"},{"name":"whatsapp_status_msg","item":[],"id":"d0109ba0-3213-4fdf-8253-a2e4aa2adec1","description":"

Пример события - whatsapp_status_msg

Статус отправляется только по исходящему сообщению от авторизованного клиента.

Пример передаваемого 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_lid\": \"48464478091151@lid\",\n      \"chat_phone\": \"995555123456\"\n    }\n  }\n}\n\n

Описание параметров webhook о статусе сообщения:

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

	Тип данных	Описание
`type`	string	Тип события.
`payload`	object	Основные данные события
`payload.instance`	object	Информация об аккаунте
`payload.instance.id`	integer	Внутренний ID инстанса
`payload.instance.customer_id`	integer	Внутренний ID клиента
`payload.delivery_id`	integer	Внутренний ID отправки. Может быть NULL
`payload.message_status`	object	Данные о статусе сообщения
`payload.message_status.id`	string	Уникальный статуса сообщения (формат для отправок через сервис chatpush: `\"true_995555123456@c.us_84110THISISBOT\",` формат для отправок другими способами: `\"true_995555123456@c.us_3A2E74ED29DF9BAB114E\"`)
`payload.message_status.status`	string	Статус сообщения
`payload.message_status.chat_id`	string	ID чата в формате `\"995555123456@c.us\"` (номер телефона + `@c.us`)
`payload.message_status.chat_lid`	string	lid ID чата
`payload.message_status.chat_phone`	integer	Номер получателя

Перечень передаваемых статусов:

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

Статус	Значение
sent	Сообщение отправлено на сервер WhatsApp
received	Доставлено на устройство получателя
read	Прочитано получателем
played	Проиграно (только для аудиосообщений)
failed	Не удалось отправить сообщение
expired	Истёк срок действия сообщения (например, долго не было сети)
content_gone	Контент больше недоступен (например, удалён или просрочен)
content_too_big	Контент слишком большой для отправки
content_unuploadable	Контент невозможно загрузить (возможно, повреждён)
inactive	Пользователь неактивен (например, удалён аккаунт или заблокирован)

","_postman_id":"d0109ba0-3213-4fdf-8253-a2e4aa2adec1"},{"name":"max_incoming_msg","item":[],"id":"64285c49-7b42-42e9-a667-1abd459d5781","description":"

Информация о поступающих и исходящих сообщениях на авторизованный аккаунт max. Сообщения забираются с момента авторизации.

Пример события - max_incoming_msg

Исходящее:

{\n  \"type\": \"max_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": \"176606326965\",\n      \"type\": \"text\",\n      \"text\": \"Исходящее\"\n    },\n    \"timestamp\": 1766063246,\n    \"instance\": {\n      \"id\": 353,\n      \"customer_id\": 747\n    },\n    \"direction\": \"outgoing\",\n    \"sender_id\": null,\n    \"chat_id\": \"6102985\",\n    \"chat_type\": \"person\",\n    \"delivery_id\": 218230,\n    \"chat_name\": \"Анна\",\n    \"recipient_id\": \"4951317\",\n    \"recipient_name\": \"Анна\",\n    \"recipient_phone_number\": \"79123456789\",\n    \"sender_phone_number\": \"+79098765432\"\n  }\n}\n\n

Входящее:

{\n  \"type\": \"max_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": \"1157409765433653\",\n      \"type\": \"text\",\n      \"text\": \"Входящее\"\n    },\n    \"timestamp\": 1766067113,\n    \"instance\": {\n      \"id\": 353,\n      \"customer_id\": 747\n    },\n    \"direction\": \"incoming\",\n    \"sender_id\": \"6102985\",\n    \"chat_id\": \"6102985\",\n    \"sender_name\": \"Анна\",\n    \"chat_type\": \"person\",\n    \"delivery_id\": null,\n    \"chat_name\": \"Анна\",\n    \"recipient_id\": null,\n    \"recipient_phone_number\": \"+79098765432\",\n    \"sender_phone_number\": \"79123456789\"\n  }\n}\n\n

Групповое:

{\n  \"type\": \"max_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": \"1157410996198593\",\n      \"type\": \"text\",\n      \"text\": \"Привет\"\n    },\n    \"timestamp\": 1766069024,\n    \"instance\": {\n      \"id\": 353,\n      \"customer_id\": 747\n    },\n    \"direction\": \"incoming\",\n    \"sender_id\": \"6102985\",\n    \"chat_id\": \"-69744189561\",\n    \"sender_name\": \"Анна\",\n    \"chat_type\": \"group\",\n    \"delivery_id\": null,\n    \"chat_name\": \"Группа\",\n    \"recipient_id\": null,\n    \"recipient_phone_number\": \"+79098765432\",\n    \"sender_phone_number\": \"79123456789\"\n  }\n}\n\n

Параметры

Ключ	Тип данных	Описание
`type`	string	Тип вебхука
`message`	object	Объект отправки
`message.id`	integer	Внутренний ID сообщения Max
`message.type`	string	Тип текста
`message.text`	string	Текст сообщения
`message.timestamp`	integer	Временная отметка, когда было отправлено сообщение
`instance`	object	Данные клиента
`instance.id`	string	Внутренний ID инстанса
`instance.customer_id`	string	Внутренний ID клиента
`direction`	string	Тип сообщения. Incoming - входящее, outgoing - исходящее.
`sender_id`		ID отправителя сообщения
`chat_id`	integer	ID чата, в котором происходит переписка
`chat_type`	string	Тип сообщения. Личный чат - person, групповой чат - group
`delivery_id`	string	Внутренний ID отправки. При отправке не из системы (через чат), параметр будет пустым.
`chat_name`	string	Имя пользователя / группы в Max
`recipient_id`	integer	ID чата, в котором происходит переписка
`recipient_name`	string	Имя получателя
`recipient_phone_number`	string	Номер получателя
`sender_phone_number`	string	Номер отправителя

Дополнительные поля для сообщений с файлами

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

Ключ	Тип данных	Описание
`payload.message.file_data`	object	Объект отправки
`payload.message.file_data.mime_type`	string	Формат файла
`payload.message.file_data.caption`	string	Описание под файлом
`payload.message.file_data.download_url`	string	Ссылка для скачивания файла

","_postman_id":"64285c49-7b42-42e9-a667-1abd459d5781"},{"name":"max_bot_incoming_msg","item":[],"id":"97f8dd00-d8c8-49a4-87cc-e95dedc09b0b","description":"

Информация о поступающих и исходящих сообщениях на авторизованный аккаунт max_bot. Сообщения забираются с момента авторизации.

Пример события - max_bot_incoming_msg

Исходящее:

{\n  \"type\": \"max_bot_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": \"mid.000000000d0a84e3019e2b3b7bcd4c72\",\n      \"timestamp\": 1778841779,\n      \"text\": \"девелопер вебхук инстанс \"\n    },\n    \"instance\": {\n      \"id\": 275,\n      \"customer_id\": 463\n    },\n    \"direction\": \"outgoing\",\n    \"sender_id\": null,\n    \"chat_id\": \"61028985\",\n    \"sender_name\": null,\n    \"delivery_id\": 190978,\n    \"recipient_name\": \"Аня\",\n    \"recipient_phone_number\": \"79811597745\",\n    \"sender_phone_number\": null\n  }\n}\n\n

Входящее:

{\n  \"type\": \"max_bot_incoming_msg\",\n  \"payload\": {\n    \"message\": {\n      \"id\": \"mid.000000000d0a84e3019e2b3bd81d10cf\",\n      \"timestamp\": 1778841802781,\n      \"text\": \"входящее инстанс\"\n    },\n    \"instance\": {\n      \"id\": 275,\n      \"customer_id\": 463\n    },\n    \"direction\": \"incoming\",\n    \"sender_id\": \"61028985\",\n    \"chat_id\": \"61028985\",\n    \"sender_name\": \"Аня\",\n    \"delivery_id\": null,\n    \"recipient_name\": null,\n    \"recipient_phone_number\": null,\n    \"sender_phone_number\": \"79811597745\"\n  }\n}\n\n

Параметры

Ключ	Тип данных	Описание
`type`	string	Тип вебхука
`message`	object	Объект отправки
`message.id`	integer	Внутренний ID сообщения Max_bot
`message.type`	string	Тип текста
`message.text`	string	Текст сообщения
`message.timestamp`	integer	Временная отметка, когда было отправлено сообщение
`instance`	object	Данные клиента
`instance.id`	string	Внутренний ID инстанса
`instance.customer_id`	string	Внутренний ID клиента
`direction`	string	Тип сообщения. Incoming - входящее, outgoing - исходящее.
`sender_id`	integer	ID отправителя сообщения
`sender_name`	string	Имя отравителя
`chat_id`	integer	ID чата, в котором происходит переписка
`delivery_id`	string	Внутренний ID отправки. При отправке не из системы (через чат), параметр будет пустым.
`recipient_id`	integer	ID чата, в котором происходит переписка
`recipient_name`	string	Имя получателя
`recipient_phone_number`	string	Номер получателя
`sender_phone_number`	string	Номер отправителя

","_postman_id":"97f8dd00-d8c8-49a4-87cc-e95dedc09b0b"}],"id":"07221467-fbf0-4597-8b3b-1fb66d4caa74","description":"

Список событий webhook

\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Описание
whatsapp_log_out	Информация о деавторизации клиента в whatsapp
whatsapp_log_in	Информация о авторизации клиента в whatsapp
whatsapp_incoming_msg	Информация о поступающих и исходящих сообщений на авторизованный аккаунт whatsapp. Сообщения забираются с момента авторизации.
tdlib_incoming_msg	Информация о поступающих и исходящих сообщениях на авторизованный аккаунт Telegram.
max_incoming_msg	Информация о поступающих и исходящих сообщениях на авторизованный аккаунт max. Сообщения забираются с момента авторизации.
max_bot_incoming_msg	Информация о поступающих и исходящих сообщениях на авторизованный аккаунт max_bot. Сообщения забираются с момента авторизации.
whatsapp_status_msg	Информация о статусах исходящих сообщений с авторизованного whatsapp аккаунта.

","_postman_id":"07221467-fbf0-4597-8b3b-1fb66d4caa74"},{"name":"Создание webhook","id":"6381bd45-39b3-4936-bfe3-2c7a3cf9dc37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.chatpush.ru/developer/v1/webhooks","urlObject":{"protocol":"https","path":["developer","v1","webhooks"],"host":["api","chatpush","ru"],"query":[{"disabled":true,"description":{"content":"

string | обязательный | Адрес, на который отправляется уведомление.\nМожно создать несколько вебхуков с разными url

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

array | обязательный | Список событий

\n","type":"text/plain"},"key":"types[]","value":"whatsapp_log_out"}],"variable":[]}},"response":[{"id":"c7f55cdf-9c07-4185-a2fd-f8d1eae91815","name":"Успешный результат","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/webhooks?url=https://example.ru&types[]=whatsapp_log_out","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","webhooks"],"query":[{"key":"url","value":"https://example.ru","description":"string | обязательный | Адрес, на который отправляется уведомление"},{"key":"types[]","value":"whatsapp_log_out","description":"array | обязательный | Список событий"}]}},"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.ru\"\n }\n}"},{"id":"0af23042-6041-4e4c-9451-721e6edcd9aa","name":"Ошибка, 422","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/webhooks?url=https://example.ru&types[]=whatsapp_log_ou","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","webhooks"],"query":[{"key":"url","value":"https://example.ru","description":"string | обязательный | Адрес, на который отправляется уведомление"},{"key":"types[]","value":"whatsapp_log_ou","description":"array | обязательный | Список событий"}]}},"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 невалидно\"\n ]\n },\n \"message\": \"Unprocessable Entity\",\n \"status\": \"fail\",\n \"status_id\": null\n }\n}"}],"_postman_id":"6381bd45-39b3-4936-bfe3-2c7a3cf9dc37"},{"name":"Получение записи","id":"c271f202-93cc-45aa-8fd8-06c2386a62b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/developer/v1/webhooks/:id","urlObject":{"protocol":"https","path":["developer","v1","webhooks",":id"],"host":["api","chatpush","ru"],"query":[],"variable":[{"id":"e9a407b0-7b14-4e99-8437-05be90a215c6","description":{"content":"

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

\n","type":"text/plain"},"type":"any","value":"57","key":"id"}]}},"response":[{"id":"79c2a9a2-02eb-4898-af10-c89a2f33d640","name":"Успешный результат","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 | обязательный | уникальный идентификатор конкретной записи "}]}},"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.ru\"\n }\n}"}],"_postman_id":"c271f202-93cc-45aa-8fd8-06c2386a62b0"},{"name":"Получение всех записей","id":"60203b3d-100a-428b-801e-9b72aca98101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.chatpush.ru/developer/v1/webhooks","urlObject":{"protocol":"https","path":["developer","v1","webhooks"],"host":["api","chatpush","ru"],"query":[],"variable":[]}},"response":[{"id":"f07f540f-bf2f-4325-9fed-c8a280426e9b","name":"Успешный результат","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":"https://api.chatpush.ru/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.ru\"\n }\n ]\n}"}],"_postman_id":"60203b3d-100a-428b-801e-9b72aca98101"},{"name":"Удаление записи","id":"597a1034-780a-471a-abda-255e39ed6739","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.chatpush.ru/developer/v1/webhooks/:id","urlObject":{"protocol":"https","path":["developer","v1","webhooks",":id"],"host":["api","chatpush","ru"],"query":[],"variable":[{"id":"34790bdd-e58b-4afa-91fb-476ba0045404","description":{"content":"

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

\n","type":"text/plain"},"type":"any","value":"22","key":"id"}]}},"response":[{"id":"8d0be036-eaad-4df9-9acc-22c0f6f45373","name":"Успешный результат","originalRequest":{"method":"DELETE","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":"55","description":"integer | обязательный | уникальный идентификатор конкретной записи "}]}},"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":"597a1034-780a-471a-abda-255e39ed6739"},{"name":"Изменение записи","id":"a00d1f9e-85d2-4793-a06f-1ba2dc0bb5ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"url":"https://api.chatpush.ru/developer/v1/webhooks/:id?types[]=whatsapp_log_out&url=https://example2.ru","urlObject":{"protocol":"https","path":["developer","v1","webhooks",":id"],"host":["api","chatpush","ru"],"query":[{"description":{"content":"

array | обязательный | Список событый

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

string | обязательный | Адрес, на который отправляется уведомление

\n","type":"text/plain"},"key":"url","value":"https://example2.ru"}],"variable":[{"id":"5e3ab851-d314-4e26-9b4c-c1e731618169","description":{"content":"

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

\n","type":"text/plain"},"type":"any","value":"57","key":"id"}]}},"response":[{"id":"e78088cd-1bfe-4446-b4e2-1fa3d6d6cb3d","name":"Успешный результат","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{api key}","type":"text"}],"url":{"raw":"https://api.chatpush.ru/developer/v1/webhooks/:id?types[]=whatsapp_log_out&url=https://example2.ru","protocol":"https","host":["api","chatpush","ru"],"path":["developer","v1","webhooks",":id"],"query":[{"key":"types[]","value":"whatsapp_log_out","description":"array | обязательный | Список событый"},{"key":"url","value":"https://example2.ru","description":"string | обязательный | Адрес, на который отправляется уведомление"}],"variable":[{"key":"id","value":"57","description":"integer | обязательный | уникальный идентификатор конкретной записи "}]}},"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.ru\"\n }\n}"}],"_postman_id":"a00d1f9e-85d2-4793-a06f-1ba2dc0bb5ce"}],"id":"8126ef0c-ba63-491c-9f60-029e9c0fe5d5","_postman_id":"8126ef0c-ba63-491c-9f60-029e9c0fe5d5","description":""},{"name":"Дополнительные сведения","item":[{"name":"Callback статуса отправки","item":[],"id":"19620e2d-ba5c-484e-81c2-5fca5705544b","description":"

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

\n
Механика, при которой сервер делает POST-запрос автоматически по указанному callback_url в запросе на доставку. Обращение сервера делается после обновлении статуса отправки до финального (доставлено, отказано в доставке итп). Обращение повторяется каждые 2 минуты 10 раз до момента, пока не получит в ответ HTTP-код 200.
\n

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

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

Ключ	Тип данных	Описание
delivery	object	Объект отправки
delivery.sender_name	string	Имя отправителя отправки
delivery.id	integer	Внутренний ID отправки
status	object	Объект статуса
status.status_id	integer	ID статуса из “Списка статусов”
status.description	string	Краткое описание статуса
status.dispatch_routing	string	Канал, по которому был получен финальный статус. Допустимые значения: “sms”, “whatsapp”, “tdlib”, “telegram”, “notify”

JSON:

{\n  \"delivery\": {\n    \"sender_name\": \"PUSHSMS.RU\",\n    \"id\": 26,\n    \"status\": {\n      \"status_id\": 26, \n      \"description\": \"bla bla\", \n      \"dispatch_routing\": \"whatsapp\"\n    }\n  }\n}\n\n

\n","_postman_id":"19620e2d-ba5c-484e-81c2-5fca5705544b"},{"name":"Идемпотентность запросов","item":[],"id":"60c02403-898f-49e8-9156-ed3d26422aa7","description":"

Для некоторых интеграций требуется надежная защита от дублирования запросов, во избежание лишних отправок и списаний денежных средств.

CHATPUSH предоставляет такую защиту через механизм идемпотентных запросов.

Для реализации механизма в доступных методах API, используется IDEMPOTENCY KEY, который можно получить в личном кабинете.

Во всех соответствующих запросах в headers должно содержаться следующее:

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

Ключ	Значение
checksum	{checksum_value}

Генерация checksum_value:

Формирование checksum_value проводится путем преобразования параметров с помощью HMAC SHA-256. Параметры должны быть представлены в виде строки, которая состоит из значений параметров, предварительно отсортированных в алфавитном порядке по ключу. В качестве секретного ключа при применении HMAC SHA-256 преобразования, служит IDEMPOTENCY KEY.

Пример генерации checksum_value на языке Ruby:

params = {\n   text: \"text\",\n   phone: \"71233456789\",\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

Пример запроса с помощью curl:

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

При неверно сгенерированном значении checksum, ответ будет иметь: HTTP-код 400 (Bad Request) и будет содержать JSON:

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

При несовпадении ключа, ответ будет иметь: HTTP-код 409 (Conflict) и будет содержать JSON:

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

\n","_postman_id":"60c02403-898f-49e8-9156-ed3d26422aa7"},{"name":"Каскадная отправка","item":[],"id":"7ecc748a-9cd4-4499-80ff-530f8a081c44","description":"

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

Перед началом отправки с использованием WhatsApp, Telegram, VK и OK, вам нужно привязать их к аккаунту.

Далее вы можете указывать перечень каналов, по которым будет осуществляться попытка доставить сообщение. Переход к следующему каналу (попытке отправить через этот канал) происходит при получении статуса о невозможности доставить по актуальному каналу. В рамках сервиса и API параметр, который управляет данным свойством имеет название - dispatch routing или роутинг отправки.

Использование

Наш сервис на данный момент предоставляет 5 каналов отправки - sms, whatsapp, tdlib(номерной telegram), telegram(telegram бот) и notify (вк и ok).
\n
Канал notify представляет собой отправку в соцсети ВКонтакте и Одноклассники. При этом канал сам выбирает ту соцсеть, которой пользователь пользуется чаще.
\n
Применять каскадную отправку можно при отправке через сервисы партнеров или через API. Управление роутингом отправок из под сервисов партнеров происходит через настройку дефолтного значения в личном кабинете, это же значение применяется и в случае, если в API параметр dispatch_routing не указан, невалидный или пустой.
\n
Значение, которое приходит в API параметре dispatch_routing должно состоять из массива строк, фильтруется на уникальность и оставляет только доступные варианты из первого пункта.
\n
Позиция канала в списке соответствует очередности попыток отправить в данный канал. Пример: получен запрос на отправку со значением dispatch_routing: [\"whatsapp\", \"sms\"]; сначала будет произведен запрос на отправку через WhatsАpp, при удачном ответе, цикл доставки прекратится, если же сообщение через WhatsАpp не доставлено, то сервис перейдет к доставке через СМС.
\n

\n","_postman_id":"7ecc748a-9cd4-4499-80ff-530f8a081c44"},{"name":"Список статусов сервиса","item":[],"id":"0cc6af0a-0404-4a0a-8f3f-684fb9ad9265","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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Краткое описание	ID	Пояснение	Тип	Описание
telecommunication_company_error	0	Ошибка оператора	финальный	Сообщение не доставлено. Оператор отчитался об ошибке при отправке.
enroute	1	Передано оператору	промежуточный	Оператор принял запрос на отправку сообщения, статус доставки появится позже.
delivered	2	Доставлено	финальный	Сообщение доставлено получателю.
expired	3	Просрочено	финальный	Сообщение не доставлено. Возможные причины: абонент долго был вне зоны доступа или в его телефоне закончилась память для новых сообщений.
deleted	4	Удалено	финальный	Сообщение удалено.
undeliverable	5	Невозможно доставить	финальный	Не удалось доставить сообщение. Получатель не в сети или запретил получение сообщений.
accepted	6	Принято	промежуточный	Cообщение принято нами на отправку и в процессе передачи оператору.
unknown	7	Не удалось доставить	финальный	Сообщение не доставлено. Оператор отчитался о неизвестной ошибке.
rejected	8	Отклонено	финальный	Оператор отклонил доставку. Возможная причина - отказ клиента от получения СМС.
internal_server_error	9	Oшибка сервера	финальный	Сервер не смог обработать запрос и завершил работу. Мы уже разбираемся с этой проблемой.
unhandled_error	10	Необрабатываемая ошибка	финальный	Неизвестная ошибка оператора. Наши специалисты уже разбираются с этой проблемой.
incorrect_number	11	Неверный номер	финальный	В запросе на доставку указан неверный телефон.
forbidden	12	Запрещено	финальный	Сработало одно из ограничений: на отправку дублей, на слишком частую отправку сообщений одному получателю, на номера из черного списка, на запрещенные спам-фильтром тексты или имена отправителей.
not_enough_money	13	Недостаточно средств	финальный	Пополните счет для отправки СМС или рассылки в мессенджерах.
waiting_for_sending	14	Ожидает отправки	промежуточный	Сообщение в очереди на отправку, скоро будет передано оператору.
in_progress	15	В обработке	промежуточный	Сообщение обрабатывается системой. В ближайшее время его статус будет обновлён.
read	16	Прочитано	финальный	Сообщение прочитано получателем.
too_many_requests	17	Превышен лимит запросов	финальный	Telegram сообщил нам, что вы отправили слишком много запросов, проверьте статус вашего телефона по ссылке: https://t.me/SpamBot.
cancelled	18	Отменено	финальный	Доставка сообщения была отменена.
smpp_queue_expired	20	Невозможно доставить	финальный	Оператор отчитался о критической ошибке при попытке отправки.
moderating	21	На модерации	промежуточный	Сообщение на модерации. По результатам обработки будет прислано письмо на почту с объяснением решения.
moderation_declined	22	Модерация отклонена	финальный	Сообщение не прошло модерацию. Причина: смотрите в почте.
external_restriction	25	Ограничения отправки	финальный	Сработало одно из ограничений: на отправку дублей, на флуд (слишком частая отправка сообщений одному получателю), на номера из черного списка, на запрещенные спам-фильтром тексты или имена отправителей.
length_restriction	26	Ограничения длины сообщений	финальный	Сообщение не отправлено, так как в настройках указано ограничение на длину отправляемых сообщений.
kazakhstan_restriction	27	Ограничения отправки в Казахстан	финальный	После 22:00 отправка рекламных сообщений в Казахстане запрещена.
operator_restriction	28	Ограничение по оператору	финальный	Сообщение заблокировано из-за ограничения по оператору для вас.
payment_transaction_error	31	Ошибка при оплате	финальный	Сервер не смог провести оплату. Мы уже разбираемся с этой проблемой.
subscription_expired	32	Подписка на мессенджеры не оплачена	финальный	Сообщение не доставлено, так как у вас не оплачен доступ к сервису отправки сообщений. Пополните счёт в личном кабинете, чтобы продолжить рассылку сообщений.
incorrect_delivery_params	33	Неверные параметры отправки	финальный	Параметры в запросе delivery переданы неверно. Подробнее — в документации к API.
foreign_delivery_restricted	34	Ограничения отправки	финальный	Сработало одно из ограничений: на отправку дублей, на флуд (слишком частая отправка сообщений одному получателю), на номера из черного списка, на запрещенные спам-фильтром тексты или имена отправителей.
rate_limit_error	35	Превышен лимит запросов на доставку	финальный	Когда в мессенджер отправляется больше 1 сообщения в минуту, они встают в очередь, ошибка выводится, если превышено количество сообщений в очереди.
blocked_by_subscription_expired	36	Подписка приостановлена	финальный	Подписка приостановлена.
daily_limit_error	37	Превышен суточный лимит запросов на доставку	финальный	Превышен суточный лимит отправки сообщений.
whatsapp_unregistered_number	44	WhatsApp незарегистрированный номер	финальный	Этот номер не зарегистрирован в мессенджере.
whatsapp_session_doesnt_exist	45	Сессия WhatsApp не запущена	финальный	Сообщение не доставлено, так как ваш WhatsApp не авторизован в сервисе отправки сообщений. Для авторизации отсканируйте QR-код.
smsc_dos_error	46	Ожидает отправки	промежуточный	Сообщение в очереди на отправку, скоро будет передано оператору.
smsc_not_enough_money	47	Необрабатываемая ошибка	финальный	Неизвестная ошибка оператора. Наши специалисты уже разбираются с этой проблемой.
smsc_unavailable_number	48	Недоступный номер	финальный	Оператор не смог доставить сообщение на данный номер телефона.
aggregate_forbidden	49	Запрещено	финальный	Запрет оператора на отправку от общих имен.
tdlib_not_authorized	50	Telegram не авторизован	финальный	Отправка в Telegram остановилась, необходимо авторизоваться.
customer_settings_delivery_time_restriction_cancel	51	Ограничение по настройкам времени отправки	финальный	Сообщение заблокировано из-за ограничения по настройкам времени отправки.
smpp_connection_error	69	Невозможно доставить	финальный	Оператор отчитался о критической ошибке при попытке отправки.
smpp_sending_limit_error	88	Невозможно доставить	финальный	Оператор отчитался о критической ошибке при попытке отправки.
smpp_transmitter_not_allowed_region	257	Невозможно доставить	финальный	Не удалось доставить сообщение, если это СМС: оператор не может доставить сообщение. Это может быть связано с тем, что абонент не в сети или запретил получение сообщений. Если это доставка в мессенджеры: сообщение не удалось доставить из-за того, что телефон отправителя не в сети.
blacklisted_number_error	555	В черном списке	финальный	Абонент находится в черном списке у клиента или у сервиса отправки сообщений.
source_addr_forbidden	1281	Имя заблокировано оператором	финальный	Имя заблокировано оператором.
smpp_num_blacklisted	1282	Невозможно доставить	финальный	Существует проблема с номером получателя. Возможно, была попытка отправки на запрещённое для клиента направление (например, могут быть запрещены отправки на номера не РФ) или получатель сам запретил получение определённого класса сообщений.
template_violation	1283	Невалидный текст или шаблон	финальный	Оператор отклонил доставку из-за нарушений параметров текста.
smpp_msg_blacklisted	1284	Отклонено	финальный	Текст сообщения содержит запрещенные слова.
smpp_not_enough_money	1285	Невозможно доставить	финальный	Оператор отчитался о критической ошибке при попытке отправки.
smpp_foreign_delivery_restricted	1286	Ограничения отправки	финальный	Сработало одно из ограничений: на отправку дублей, на флуд (слишком частая отправка сообщений одному получателю), на номера из черного списка, на запрещенные спам-фильтром тексты или имена отправителей.
smpp_down_msisdn	1287	Ошибка оператора	финальный	Ошибка оператора. Наши специалисты уже разбираются с этой проблемой.
smpp_megafon_wrong_provider	1288	Невозможно доставить	финальный	Оператор отчитался о критической ошибке при попытке отправки.
smpp_beeline_wrong_provider	1293	Невозможно доставить	финальный	Оператор отчитался о критической ошибке при попытке отправки.
smpp_beeline_partner_blocked	1299	Невозможно доставить	финальный	Не удалось доставить сообщение, если это СМС: оператор не может доставить сообщение. Это может быть связано с тем, что абонент не в сети или запретил получение сообщений. Если это доставка в мессенджеры: сообщение не удалось доставить из-за того, что телефон отправителя не в сети.
smpp_anti_spam_block	2291	Абонент включил спам-фильтр	финальный	Абонент запретил получение СМС.
waba_not_authorized	52	Сессия WABA не запущена	финальный	Отправка в WABA остановилась, необходимо авторизоваться.
mobile_operator_not_identified	53	Оператор сотовой связи не определен	финальный	Оператор сотовой связи не определен.
sender_name_error	38	Ошибка при получении имени отправителя	финальный	Ошибка при получении имени отправителя.
max_not_authorized	54	Сессия MAX не запущена	финальный	Отправка в MAX остановилась, необходимо авторизоваться.
client_not_registered_in_max	55	Клиент не зарегистрирован в MAX	финальный	Не удалось доставить сообщение, клиент не зарегистрирован в MAX или временно недоступен.
safe_sending_limit_exceeded	56	Достигнут лимит безопасных отправок	финальный	Мы временно остановили отправку, чтобы номер не попал под блокировку. Это сообщение не будет отправлено позже. Как только лимит обновится, система снова начнёт отправлять новые сообщения. Со временем лимиты будут расти, и отправка станет свободнее.
too_many_messages_to_new_contacts	57	Слишком много отправок новым контактам	финальный	Сейчас Telegram временно ограничивает количество исходящих сообщений из-за большого спроса. Это сообщение не будет отправлено повторно. Когда у вас станет больше переписок в Telegram, лимиты увеличатся, и новые сообщения будут уходить быстрее.
user_not_found_in_telegram	58	Пользователь не найден в Telegram	финальный	Telegram не сообщает причину: аккаунт может быть скрыт, отсутствовать в системе или временно ограничен.
max_delivery_suspended	60	Аккаунт MAX временно ограничен	финальный	На данный момент ваш аккаунт ограничен, из-за чего нет возможности доставить сообщение. Пожалуйста, дождитесь снятия ограничений.

","_postman_id":"0cc6af0a-0404-4a0a-8f3f-684fb9ad9265"},{"name":"Список категорий трафика","item":[],"id":"14b01132-90cf-4f17-b622-1a2b7fc8443f","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

Краткое описание	ID	Пояснение
advert	0	Рекламная
transaction	1	Транзакционная
service	2	Сервисная

","_postman_id":"14b01132-90cf-4f17-b622-1a2b7fc8443f"}],"id":"7ad24973-884c-4a70-9a31-136288908f36","_postman_id":"7ad24973-884c-4a70-9a31-136288908f36","description":""}]}