community.general.catapult 模块 – 使用 Catapult 带宽 API 发送短信/彩信

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.catapult。

概要 

允许使用 sms / mms 通过 Catapult 带宽 API 发送通知。

参数 

参数	注释
api_secret string / 必填	来自 API 帐户页面的 Api 密钥。
api_token string / 必填	来自 API 帐户页面的 Api 令牌。
dest list / elements=string / 必填	应将消息发送到的电话号码（必须采用 E.164 格式，如 `+19195551212`）。
media string	对于彩信消息，指向要随消息发送的媒体所在位置的媒体 URL。
msg string / 必填	文本消息的内容（必须少于 2048 个字符）。
src string / 必填	您要发送消息的 Catapult 电话号码之一（必须采用 E.164 格式，如 `+19195551212`）。
user_id string / 必填	来自 API 帐户页面的用户 ID。

属性 

属性	支持	描述
check_mode	支持: 无	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。
diff_mode	支持: 无	在 diff 模式下，将返回有关已更改（或可能需要在 `check_mode` 中更改）的详细信息。

注释 

注意

即使媒体 URL 错误，也会返回已更改。
如果目标号码无效，则会返回已更改。

示例 

- 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 }}"

返回值 

常用返回值记录在这里，以下是此模块独有的字段

键	描述
changed boolean	API 是否接受了消息。返回: 总是示例: `true`

作者

Jonathan Mainguy (@Jmainguy)