Команды в SmartApp API

Обновлено 14 декабря 2023

SmartApp API

Передача команды

Команды передаются в массиве items сообщения ANSWER_TO_USER. Пример команд в массиве payload.items:

object

{

• "payload": {

  • "items": [

    • {

      • "command": {

        • "type": "action",
        • "action": {

          • "type": "text",
          • "text": "Текст",
          • "should_send_to_backend": true

          }

        }

      }

    ]

  }

}

Типы команд

Действия

action — команда, внутри которой можно указать любое из действий.

• Пример
• Описание

type	string Тип команды. Команда, содержащая одно из действий (передать текст, открыть диплинк, действие на бэкенде смартапа) Value: "action"
	text (object) or deep_link (object) or server_action (object)

{

• "type": "action",
• "action": {

  • "type": "text",
  • "text": "Текст",
  • "should_send_to_backend": true

  }

}

type	string Тип команды. Команда, содержащая одно из действий (передать текст, открыть диплинк, действие на бэкенде смартапа) Value: "action"
	text (object) or deep_link (object) or server_action (object)

{

• "type": "action",
• "action": {

  • "type": "text",
  • "text": "Текст",
  • "should_send_to_backend": true

  }

}

Персональные данные

request_permissions — запрос разрешений на получение и обработку данных пользователя.

• Пример
• Описание

type	string Тип команды. Запрос разрешений на получение и обработку данных пользователя Value: "request_permissions"
permissions	Array of strings Items Enum: "geo" "read_contacts" "record_audio" "push" Cписок разрешений, которые требуется запросить у пользователя. Доступные значения: geo — запрос на получение геолокации; read_contacts — запрос на получение доступа к списку контактов; record_audio — запрос на запись аудио; push — запрос на отправку push-уведомлений.

{

• "type": "request_permissions",
• "permissions": [

  • "geo"

  ]

}

type	string Тип команды. Запрос разрешений на получение и обработку данных пользователя Value: "request_permissions"
permissions	Array of strings Items Enum: "geo" "read_contacts" "record_audio" "push" Cписок разрешений, которые требуется запросить у пользователя. Доступные значения: geo — запрос на получение геолокации; read_contacts — запрос на получение доступа к списку контактов; record_audio — запрос на запись аудио; push — запрос на отправку push-уведомлений.

{

• "type": "request_permissions",
• "permissions": [

  • "geo"

  ]

}

Данные для смартапа

smart_app_data — команда для передачи данных в смартап.

• Пример
• Описание

type	string Тип команды. Команда для передачи данных в Canvas App Value: "smart_app_data"
smart_app_data	object Объект с произвольными данными для смартапа

{

• "type": "smart_app_data",
• "smart_app_data": { }

}

type	string Тип команды. Команда для передачи данных в Canvas App Value: "smart_app_data"
smart_app_data	object Объект с произвольными данными для смартапа

{

• "type": "smart_app_data",
• "smart_app_data": { }

}

Закрытие смартапа

close_app — закрытие смартапа.

• Пример
• Описание

type	string Тип команды. Команда закрытия смартапа Value: "close_app"

{

• "type": "close_app"

}

type	string Тип команды. Команда закрытия смартапа Value: "close_app"

{

• "type": "close_app"

}

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

payment_invoice — команда для получения инвойса платежа.

• Пример
• Описание

type	string Тип команды Value: "payment_invoice"
	object

{

• "type": "payment_invoice",
• "payment_invoice": {

  • "invoice_id": "118462a"

  }

}

type	string Тип команды Value: "payment_invoice"
	object

{

• "type": "payment_invoice",
• "payment_invoice": {

  • "invoice_id": "118462a"

  }

}

Отсутствие ответа

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

• Пример
• Описание

type	string Тип команды Value: "do_nothing"

{

• "type": "do_nothing"

}

type	string Тип команды Value: "do_nothing"

{

• "type": "do_nothing"

}