catapult - Отправка sms/mms с помощью API catapult bandwidth
Новая версия 2.4.
Обзор
- Позволяет отправлять уведомления с помощью 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
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
catapult:
src: "+15035555555"
dest: "+12018994225"
msg: "Consider yourself notified"
user_id: "{{ user_id }}"
api_token: "{{ api_token }}"
api_secret: "{{ api_secret }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| changed boolean | всегда | Принято ли сообщение API. Пример: True |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратный.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание модулей и поддержка.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Jonathan Mainguy (@Jmainguy)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/catapult_module.html
