community.general.catapult module – Send a sms / mms using the catapult bandwidth api
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.catapult
.
Synopsis
Allows notifications to be sent using sms / mms via the catapult bandwidth api.
Aliases: notification.catapult
Parameters
Parameter |
Comments |
---|---|
Api Secret from Api account page. |
|
Api Token from Api account page. |
|
The phone number or numbers the message should be sent to (must be in E.164 format, like |
|
For MMS messages, a media url to the location of the media to be sent with the message. |
|
The contents of the text message (must be 2048 characters or less). |
|
One of your catapult telephone numbers the message should come from (must be in E.164 format, like |
|
User Id from Api account page. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
Will return changed even if the media url is wrong.
Will return changed if the destination number is invalid.
Examples
- 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 }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Whether the api accepted the message. Returned: always Sample: |