Модуль community.general.catapult — Отправка SMS/MMS с помощью API catapult bandwidth

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в playbook, укажите: community.general.catapult.

Описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Описание

Позволяет отправлять уведомления с помощью SMS/MMS через API catapult bandwidth.

Параметры

Параметр	Комментарии
api_secret строка / обязательно	Секрет API со страницы профиля API.
api_token строка / обязательно	Токен API со страницы профиля API.
dest список / элементы=строка / обязательно	Номер(а) телефона, на который(е) должно быть отправлено сообщение (должен быть в формате E.164, например `+19195551212`).
media строка	Для MMS-сообщений, URL-адрес медиафайла, который нужно отправить с сообщением.
msg строка / обязательно	Содержание текстового сообщения (должно быть 2048 символов или меньше).
src строка / обязательно	Один из ваших номеров телефона catapult, с которого должно приходить сообщение (должен быть в формате E.164, например `+19195551212`).
user_id строка / обязательно	Идентификатор пользователя со страницы профиля API.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме diff вернёт информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`).

Примечания

Примечание

Вернет изменение даже если URL медиафайла неверный.
Вернёт изменение, если номер назначения недействительный.

Примеры

- name: Send a mms to multiple users
  community.general.catapult:
    src: "+15035555555"
    dest:
      - "+12525089000"
      - "+12018994225"
    media: "http://example.com/foobar.jpg"
    msg: "Task is complete"
    user_id: "{{ user_id }}"
    api_token: "{{ api_token }}"
    api_secret: "{{ api_secret }}"

- name: Send a sms to a single user
  community.general.catapult:
    src: "+15035555555"
    dest: "+12018994225"
    msg: "Consider yourself notified"
    user_id: "{{ user_id }}"
    api_token: "{{ api_token }}"
    api_secret: "{{ api_secret }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
changed логическое	Принял ли API сообщение. Возвращаемое значение: всегда Пример: `true`

Авторы

Jonathan Mainguy (@Jmainguy)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/catapult_module.html