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

注意

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

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

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

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

概要 

允许使用 Catapult Bandwidth API 通过短信/彩信发送通知。

参数 

参数	注释
api_secret 字符串 / 必填	来自 API 帐户页面的 API 密钥。
api_token 字符串 / 必填	来自 API 帐户页面的 API 令牌。
dest 列表 / 元素=字符串 / 必填	应将消息发送到的电话号码（必须采用 E.164 格式，例如 `+19195551212`）。
media 字符串	对于彩信，媒体文件的 URL。
msg 字符串 / 必填	短信内容（必须少于 2048 个字符）。
src 字符串 / 必填	您的 Catapult 电话号码之一，消息应从此号码发出（必须采用 E.164 格式，例如 `+19195551212`）。
user_id 字符串 / 必填	来自 API 帐户页面的用户 ID。

属性 

属性	支持	描述
check_mode	支持：不支持	可以在 `check_mode` 下运行并返回更改状态预测，而无需修改目标。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在 `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 布尔值	API 是否接受了消息。返回：始终示例：`true`

作者

Jonathan Mainguy (@Jmainguy)