API документация

Доступные события

JSON API Доступные события Актуальные события, по которым могу отправляться уведомления. whatsapp_log_out — Прервалась авторизация WhatsApp Пример уведомления whatsapp_log_out { "type": "whatsapp_log_out" "payload": { "instance": { "id": "1", "customer_id": 26, "email": "example@gmail.ru", "phone": "+79123456789" "status": { "status_id": 1, "description": "disconnected" } } } } Параметры Ключ Тип данных Описание instance object Объект инстанса id integer …

Доступные события Читать полностью »

Удаление

JSON API Удаление Общие сведения Параметр Значение Авторизация Необходима HTTP – метод DELETE URL https://api.pushsms.ru/developer/v1/webhooks/:id Варианты ответа Успешный с http кодом 200, неуспешные с кодом 404 Параметры Ключ Обязателен Тип данных Описание id да integer Уникальный идентификатор конкретной записи Пример передачи параметров: curl —location —request DELETE ‘https://api.pushsms.ru/developer/v1/webhooks/3’ —header ‘Authorization: {api_key}’ Пример успешного результата HTTP-код — 200. …

Удаление Читать полностью »

Изменение

JSON API Изменение Общие сведения Параметр Значение Авторизация Необходима HTTP – метод PUT URL https://api.pushsms.ru/developer/v1/webhooks/:id Варианты ответа Успешный с http кодом 200, неуспешные с кодом 404 * v1 — скоуп присваивается каждой CRM и сервису индивидуально, запросите свое персональное значение v1 и используйте в коде его, отправляя запросы (https://api.pushsms.ru/api/имявашейcrm/account) Параметры Ключ Обязателен Тип данных Описание …

Изменение Читать полностью »

Получение всех записей

JSON API Получение всех записей Общие сведения Параметр Значение Авторизация Необходима HTTP – метод GET URL https://api.pushsms.ru/developer/v1/webhooks Варианты ответа Успешный с http кодом 200 Пример передачи параметров: curl —location —request GET ‘https://api.pushsms.ru/developer/v1/webhooks’ —header ‘Authorization: {api_key}’ Пример успешного результата HTTP-код — 200. { "meta": { "code": 200, "status": "success" }, "webhooks": [ { "id": 11, "types": [ …

Получение всех записей Читать полностью »

Получение записи

JSON API Получение конкретной записи Общие сведения Параметр Значение Авторизация Необходима HTTP – метод GET URL https://api.pushsms.ru/developer/v1/webhooks/:id Варианты ответа Успешный с http кодом 200, неуспешные с кодом 404 Параметры Ключ Обязателен Тип данных Описание id да integer Уникальный идентификатор конкретной записи Пример передачи параметров: curl —location —request GET ‘https://api.pushsms.ru/developer/v1/webhooks/3’ —header ‘Authorization: {api_key}’ Пример успешного результата HTTP-код …

Получение записи Читать полностью »

Создание

JSON API Создание webhook Общие сведения Параметр Значение Авторизация Необходима HTTP – метод POST URL https://api.pushsms.ru/developer/v1/webhooks Варианты ответа Успешный с http кодом 200, неуспешные с кодом 422 Параметры Ключ Обязателен Тип данных Описание url да string Адрес, на который отправляются уведомления types да array Список событий, по которым будут отправляться уведомления Пример передачи параметров: curl …

Создание Читать полностью »

Авторизация

JSON API Авторизация В проекте применяется api_key авторизация. Необходимый api_key можно получить у администратора jetapi. Во всех соответствующих запросах в headers должно содержаться следующее: Ключ Значение Authorization {api_key} При отсутствии данных параметров или их невалидности, ответ будет иметь: HTTP-код 401 (Not authorized).

ru_RURussian