catapult - Отправка sms / mms с помощью API catapult bandwidth
Новая версия 2.4.
Обзор
- Разрешает отправку уведомлений по sms / mms через API catapult bandwidth.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_secret обязательно | Значение по умолчанию: None | Секретный ключ API с страницы учетной записи API. |
| api_token обязательно | Значение по умолчанию: None | Токен API с страницы учетной записи API. |
| dest обязательно | Значение по умолчанию: None | Номер телефона или номера телефонов, на которые должно быть отправлено сообщение (должен быть в формате E.164, например +19195551212). |
| media | Для сообщений MMS, URL медиафайла с местоположением медиафайла, который необходимо отправить вместе с сообщением. | |
| msg обязательно | Значение по умолчанию: None | Содержание текстового сообщения (не должно превышать 2048 символов). |
| src обязательно | Значение по умолчанию: None | Один из ваших номеров телефона catapult, с которого должно приходить сообщение (должен быть в формате E.164, например +19195551212). |
| user_id обязательно | Значение по умолчанию: None | Идентификатор пользователя с страницы учетной записи 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 |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/catapult_module.html
