Получение списка шаблонов

Раздел содержит описание метода API для получения списка шаблонов.

Метод message-matchers/get-by-request

Ответ метода message-matchers/get-by-request содержит список шаблонов для переданного идентификатора подписи. В случае успешного выполнения запроса сервер вернет код 200 и JSON-объект со списком шаблонов. В случае неуспешного выполнения запроса сервер вернет сообщение с кодом ошибки.

Чтобы узнать, как получить идентификаторы подписи для каналов, см. Получение списка каналов.

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

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

В теле запроса передается JSON-объект с параметрами.

{
"subjectId": 23,
"matcherTypes": ["OPERATOR","USER","CUSTOM"]
}

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

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

В ответ на запрос возвращается JSON-объект, содержащий данные о шаблонах.

[
  {
    "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",
                "otpType": "COPY_CODE",
                "url": "string",
                "urlPostfix": "string",
                "phone": "string",
                "payload": "string",
                "urlTextExample": "string",
                "color": "string",
                "requestLocation": true,
                "autofillText": "string",
                "packageName": "string",
                "hash": "string",
                "appId": 0,
                "ownerId": 0
              }
            ]
          }
        ]
      },
      "securityRecommendation": true,
      "codeExpirationMinutes": 90,
      "textExampleParams": [
        "string"
      ],
      "vkAttachments": [
        {
          "id": 0,
          "fileUrl": "string",
          "originalFileName": "string",
          "size": 0
        }
      ],
      "vkTwoWayEnabled": true
    },
    "contentType": "TEXT",
    "category": "ACCOUNT_UPDATE",
    "status": "string",
    "locked": true,
    "type": "OPERATOR",
    "createdAt": "2023-09-27T11:57:14.834Z",
    "updatedAt": "2023-09-27T11:57:14.834Z"
  }
]

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

Коды ответов на запрос

• ok — запрос успешно выполнен
• error-subject-unknown — указанное имя подписи отсутствует
• error-syntax — неверно указан тип канала