community.general.catapult – Отправка SMS/MMS с помощью API catapult bandwidth

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

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

Чтобы использовать его в книге задач, укажите: 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.

Примечания

Примечание

Вернет изменённое значение даже если 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/catapult_module.html