Skip to main content

Получение статуса шаблона

Обновлено: 30 мая 2022

В этой статье описывается callback-функция для передачи информации об изменении статуса шаблона. Callback – это запрос, который передает на ваш сервер информацию об изменении статуса шаблона. Параметры запроса передаются в теле запроса.

URL-адрес подключения​

Для получения callback-статусов шаблона в личном кабинете в секции Интеграция > Настройка в поле Callback URL для API управления укажите API-endpoint вашей системы, который будет обрабатывать входящие POST запросы от API-edna.

warning

Поддерживается только протокол HTTPS

Пример тела входящего POST-запроса​

[
  {
    "id": 0,
    "name": "string",
    "channelType": "SMS",
    "language": "string",
    "content": {
      "attachment": {
        "id": 0,
        "fileUrl": "string",
        "originalFileName": "string",
        "size": 0
      },
      "action": "string",
      "caption": "string",
      "header": {
        "headerType": "TEXT",
        "text": "string",
        "attachment": {
          "id": 0,
          "fileUrl": "string",
          "originalFileName": "string",
          "size": 0
        },
        "headerExampleTextParam": "string",
        "headerExampleMediaUrl": "string"
      },
      "text": "string",
      "footer": {
        "text": "string"
      },
      "keyboard": {
        "rows": [
          {
            "buttons": [
              {
                "text": "string",
                "buttonType": "PHONE",
                "url": "string",
                "urlPostfix": "string",
                "phone": "string",
                "payload": "string",
                "urlTextExample": "string"
              }
            ]
          }
        ]
      },
      "textExampleParams": [
        "string"
      ]
    },
    "contentType": "TEXT",
    "category": "ACCOUNT_UPDATE",
    "status": "string",
    "locked": true,
    "type": "OPERATOR",
    "createdAt": "2023-07-21T13:51:47.862Z",
    "updatedAt": "2023-07-21T13:51:47.862Z"
  }
]
info

Если в шаблоне нет кнопок, вернется пустой объект keyboard":{"row":[{"buttons":[]}]}}

Формат запроса​

В теле запроса возвращаются параметры метода message-matchers

File IconСоздание операторских шаблонов

Статусы шаблонов​

APPROVED – активный. Это единственный статус, при котором шаблон можно использовать для отправки сообщений REJECTED – отклонен оператором PENDING – на регистрации NOT_SENT – черновик ARCHIVED – в архиве PAUSED – приостановлен DISABLED – отключен

Формат ответа​

В ответ на запрос от вашего сервера должен возвращаться статус его выполнения с кодом 200.

Если в ответ на callback-запрос не приходит код 200, edna Pulse выполняет еще 10 попыток запроса с интервалом 2*Х секунд между попытками (где Х — номер попытки), пока в ответ не придет код 200.

info

То есть каждые 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048 секунд