mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 16:01:55 +00:00
b769b0bc01
Sort imports with ruff check --fix (#11400)
Sort imports with ruff check --fix.
(cherry picked from commit 236b9c0e04)
Co-authored-by: Felix Fontein <felix@fontein.de>
135 lines
3.5 KiB
Python
135 lines
3.5 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2014, Matt Martz <matt@sivel.net>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
DOCUMENTATION = r"""
|
|
module: nexmo
|
|
short_description: Send a SMS using nexmo
|
|
description:
|
|
- Send a SMS message using nexmo.
|
|
author: "Matt Martz (@sivel)"
|
|
attributes:
|
|
check_mode:
|
|
support: none
|
|
diff_mode:
|
|
support: none
|
|
options:
|
|
api_key:
|
|
type: str
|
|
description:
|
|
- Nexmo API Key.
|
|
required: true
|
|
api_secret:
|
|
type: str
|
|
description:
|
|
- Nexmo API Secret.
|
|
required: true
|
|
src:
|
|
type: int
|
|
description:
|
|
- Nexmo Number to send from.
|
|
required: true
|
|
dest:
|
|
type: list
|
|
elements: int
|
|
description:
|
|
- Phone number(s) to send SMS message to.
|
|
required: true
|
|
msg:
|
|
type: str
|
|
description:
|
|
- Message text to send. Messages longer than 160 characters are split into multiple messages.
|
|
required: true
|
|
validate_certs:
|
|
description:
|
|
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
|
|
certificates.
|
|
type: bool
|
|
default: true
|
|
extends_documentation_fragment:
|
|
- ansible.builtin.url
|
|
- community.general.attributes
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Send notification message via Nexmo
|
|
community.general.nexmo:
|
|
api_key: 640c8a53
|
|
api_secret: 0ce239a6
|
|
src: 12345678901
|
|
dest:
|
|
- 10987654321
|
|
- 16789012345
|
|
msg: '{{ inventory_hostname }} completed'
|
|
delegate_to: localhost
|
|
"""
|
|
import json
|
|
from urllib.parse import urlencode
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.urls import fetch_url, url_argument_spec
|
|
|
|
NEXMO_API = "https://rest.nexmo.com/sms/json"
|
|
|
|
|
|
def send_msg(module):
|
|
failed = list()
|
|
responses = dict()
|
|
msg = {
|
|
"api_key": module.params.get("api_key"),
|
|
"api_secret": module.params.get("api_secret"),
|
|
"from": module.params.get("src"),
|
|
"text": module.params.get("msg"),
|
|
}
|
|
for number in module.params.get("dest"):
|
|
msg["to"] = number
|
|
url = f"{NEXMO_API}?{urlencode(msg)}"
|
|
|
|
headers = dict(Accept="application/json")
|
|
response, info = fetch_url(module, url, headers=headers)
|
|
if info["status"] != 200:
|
|
failed.append(number)
|
|
responses[number] = dict(failed=True)
|
|
|
|
try:
|
|
responses[number] = json.load(response)
|
|
except Exception:
|
|
failed.append(number)
|
|
responses[number] = dict(failed=True)
|
|
else:
|
|
for message in responses[number]["messages"]:
|
|
if int(message["status"]) != 0:
|
|
failed.append(number)
|
|
responses[number] = dict(failed=True, **responses[number])
|
|
|
|
if failed:
|
|
msg = "One or messages failed to send"
|
|
else:
|
|
msg = ""
|
|
|
|
module.exit_json(failed=bool(failed), msg=msg, changed=False, responses=responses)
|
|
|
|
|
|
def main():
|
|
argument_spec = url_argument_spec()
|
|
argument_spec.update(
|
|
dict(
|
|
api_key=dict(required=True, no_log=True),
|
|
api_secret=dict(required=True, no_log=True),
|
|
src=dict(required=True, type="int"),
|
|
dest=dict(required=True, type="list", elements="int"),
|
|
msg=dict(required=True),
|
|
),
|
|
)
|
|
|
|
module = AnsibleModule(argument_spec=argument_spec)
|
|
|
|
send_msg(module)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|