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 - / обязательно | 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. [community]
Авторы
- 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.9/modules/catapult_module.html
