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 | да | Текст SMS-сообщения (должен быть 2048 символов или меньше). | ||
| src | да | Один из ваших телефонных номеров catapult, с которого должно быть отправлено сообщение (должен быть в формате E.164, например +19195551212). | ||
| user_id | да | Идентификатор пользователя со страницы учетной записи API. |
Примеры
- 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 | Принято ли сообщение API. | всегда | boolean | True |
Примечания
Примечание
- Будет возвращено changed, даже если URL медиафайла неверный.
- Будет возвращено changed, если номер назначения недействителен.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратный.
Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/catapult_module.html