# Установка Callback URL
Описание
Метод позволяет установить Callback URL, на который вы хотите получать уведомления о наступлении интересующих вас событий.
Метод доступен в "API Callback" (на всех тарифах)
# Запрос
# URL запроса
https://api.tgstat.ru/callback/set-callback-url
# Параметры
Параметр | Описание | Значение по умолчанию | Обязательно |
---|---|---|---|
token | Ваш токен | Не задан | Да |
callback_url | URL, на который отправлять уведомления | Не задан | Да |
Смена URL
При желании URL можно изменить, вызвав метод повторно с новым URL. Предыдущий URL при этом будет удален, и на него больше не будут приходить уведомления.
# Подтверждение URL
Чтобы установить callback_url
мы должны убедиться в том, что веб-сервер, на который ведет заданный вами callback_url
принадлежит вам. Для этого мы отправим проверочный POST-запрос на заданный вами callback_url
. В ответ мы ожидаем получить код подтверждения verify_code
, который вы узнаете при первом вызове метода callback/set-callback-url.
{
"status": "error",
"error": "wrong verify code",
"verify_code": "TGSTAT_VERIFY_CODE_123456"
}
# Пример ответа с кодом подтверждения на языке PHP:
<?php
echo "TGSTAT_VERIFY_CODE_123456";
die;
# Ответ
# Успешный ответ
{
"status": "ok"
}
Проверить установленный Callback URL можно с помощью метода callback/get-callback-info.
# Возможные ошибки
# Передан невалидный URL
{
"status": "error",
"error": "callback_url is not valid"
}
# TGStat не получил в ответ правильный код подтверждения
{
"status": "error",
"error": "wrong verify code",
"verify_code": "TGSTAT_VERIFY_CODE_123456"
}