Как включить шлюз и создать ключ

Обновлено:

В SyBox это делается в Настройки > Интеграции > Ключи API. 1) Перейдите в Настройки > Интеграции > Ключи API. 2) Включите переключатель «API-шлюз». 3) Нажмите «Новый ключ». 4) Выберите «Тип ключа»: 5) Заполните «Название устройства или программы», например «Офисный ПК» или «Бухгалтерия». Создавайте отдельный ключ для каждого устройства или программы. 6) Для ключа с типом «Отправка через WhatsApp» также укажите: 7) Для ключа «Импорт SMS с телефона» настройте «Только контакты…

  1. Перейдите в Настройки > Интеграции > Ключи API.
  2. Включите переключатель «API-шлюз».
  3. Нажмите «Новый ключ».
    Settings, API keys: keys that let another program send through SyBox, and the "New key" button
  4. Выберите «Тип ключа»:
    • «Отправка через WhatsApp»: программа отправляет сообщения вашим клиентам.
    • «Зарегистрировать обращение»: программа создает обращения в SyBox. Отправлять сообщения она не может.
    • «Импорт SMS с телефона»: телефон пересылает входящие SMS во входящие.
  5. Заполните «Название устройства или программы», например «Офисный ПК» или «Бухгалтерия». Создавайте отдельный ключ для каждого устройства или программы.
  6. Для ключа с типом «Отправка через WhatsApp» также укажите:
    • «Отправляет с»: номер WhatsApp, с которого отправляет этот ключ (обязательно).
    • «Разрешить произвольные сообщения»: включено или выключено.
    • «Разрешить одобренные шаблоны»: включено или выключено. Хотя бы один из этих двух пунктов должен быть включен, иначе появится сообщение: «Разрешите хотя бы произвольный текст или шаблоны, иначе ключ не сможет ничего отправлять».
    • «Разрешить отправку медиа»: включено или выключено.
    • «Шаблоны» (необязательно): названия шаблонов через запятую. Оставьте пустым, чтобы разрешить любые шаблоны.
    • «Разрешённые страны получателей» (необязательно): двухбуквенные коды стран, например MA,FR,EG. Оставьте пустым, чтобы разрешить любые страны.
    • «Отправка разрешена с» ... «Чтобы»: часы, в которые ключу разрешено отправлять сообщения. Оставьте одинаковыми, чтобы снять ограничение по времени. Время указывается по часовому поясу рабочей области.
    • «Дневной лимит сообщений (0 = без лимита)».
  7. Для ключа «Импорт SMS с телефона» настройте «Только контакты и клиенты». Если параметр включен, SMS с любых других номеров остаются на телефоне и не попадают во входящие. Отключайте, только если телефон сугубо рабочий.
  8. Нажмите Сохранить.
  9. В окне появятся «Базовый URL» и «API-ключ». Скопируйте их сразу. «Скопируйте этот ключ сейчас — он показывается только один раз.» Укажите их в настройках вашей программы.

Вопросы

Я потерял API-ключ. Можно ли посмотреть его снова?

Нет. Он показывается только один раз. Создайте новый ключ, укажите его в программе, а старый удалите.

Кажется, ключ скомпрометирован. Что делать?

Немедленно удалите этот ключ или отключите его. Перестанет работать только он. Ваш номер WhatsApp и остальные ключи не пострадают.

Список «Отправляет с» пуст.

В списке отображаются только подключенные и включенные номера WhatsApp. Сначала подключите номер в разделе Настройки > Каналы связи > Каналы.

При отправке из программы приходят отказы.

Проверьте, включен ли переключатель «API-шлюз» и активен ли сам ключ. Проверьте также ограничения ключа: произвольный текст или шаблоны, медиа, разрешенные шаблоны, страны, часы отправки и дневной лимит. Правила самого WhatsApp также действуют: например, произвольный текст можно отправлять только в течение 24 часов с момента последнего сообщения клиента.

Может ли ключ «Зарегистрировать обращение» отправлять сообщения?

Нет, это сделано намеренно. Ключ для обращений не может писать клиентам, а ключ для отправки не может регистрировать обращения. Используйте отдельный ключ для каждой задачи.

У меня остался старый ключ с типом «Приём из программы». Он еще работает?

Да, созданные ранее ключи этого типа продолжают работать. Создать новые такие ключи уже нельзя. Для подобных задач используйте «Зарегистрировать обращение».

Подробнее о Ключи API.