New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_secret required | Api Secret from Api account page. | |
api_token required | Api Token from Api account page. | |
dest required | The phone number or numbers the message should be sent to (must be in E.164 format, like +19195551212 ). | |
media | For MMS messages, a media url to the location of the media to be sent with the message. | |
msg required | The contents of the text message (must be 2048 characters or less). | |
src required | One of your catapult telephone numbers the message should come from (must be in E.164 format, like +19195551212 ). | |
user_id required | User Id from Api account page. |
Note
- 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 }}"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed boolean | always | Whether the api accepted the message. Sample: True |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/catapult_module.html