更新时间:2024-07-05 GMT+08:00

SMN消息通知

如果消息通知使用SMN服务,SMN将对发送的消息通知单独计费,具体的计费标准请参考SMN价格详情

功能介绍

  • 主题是消息发布或客户端订阅通知的特定事件类型。它作为发送消息和订阅通知的信道,为发布者和订阅者提供一个可以相互交流的通道。在配置点播消息订阅前必须定制主题。
  • 点播消息通知包括“转码完成”“截图完成”“审核完成”、“创建完成”、“音频提取完成”、“封面生成完成”几类。消息订阅是客户将订阅者注册到主题的操作,客户可以拥有多个主题,每个主题有多个订阅者。

配置流程

消息订阅的配置流程,如图1所示。

图1 消息订阅配置流程图
  1. 创建消息主题:在消息通知服务控制台新建消息主题,用于消息发送和订阅通知。
  2. 设置主题策略:授权点播服务可对该主题发布消息。
  3. 配置点播消息订阅:在点播控制台配置消息订阅,即可在转码、截图、审核等操作时接收到消息通知。

创建消息主题

  1. 登录消息通知服务控制台。
  2. 在左侧导航栏中,选择“主题管理 > 主题”。
  3. 单击右上角“创建主题”。

    弹出“创建主题”对话框。参数配置说明,如表1所示。
    表1 创建主题

    主题信息

    说明

    主题名称

    创建的主题名称,用户可自定义名称,规范如下:

    • 只能包含字母,数字,短横线(-)和下划线(_),且必须由大写字母、小写字母或数字开头。
    • 名称长度限制在1-255字符之间。
    • 主题名称为主题的唯一标识,一旦创建后不能再修改主题名称。

    显示名

    可不填写。推送邮件消息时:

    • 若未设置主题的显示名,发件人呈现为"username@example.com"
    • 若已设置主题的显示名,发件人则呈现为"显示名<username@example.com>"

    企业项目

    企业项目是一种云资源管理方式,企业项目管理服务提供统一的云资源按项目管理,以及项目内的资源管理、成员管理。

    标签

    标签由键值对组成,用于标识云资源,可对云资源进行分类和搜索。

  4. 单击“确定”,主题创建成功。
  5. 单击新建主题行,对应操作列的“添加订阅”,弹出“添加订阅”浮框页面。

    配置消息通知的协议和订阅终端,如图2所示。
    图2 添加订阅

    参数说明如表2所示。

    表2 添加订阅参数说明

    参数

    说明

    主题名称

    待添加订阅的主题名称,不需要修改。

    协议

    消息通知的方式。在下拉框中选择需要订阅终端支持的协议。

    常用的消息通知方式为“短信”“邮件”“HTTP”和“HTTPS”。

    订阅终端

    订阅的终端地址。短信、邮件、HTTP以及HTTPS终端支持批量输入。批量添加时,每个终端地址占一行,最多可输入10个终端。

    • 选择“短信”,请输入有效手机号码。

      输入规则为[+] [国家码][手机号码]。例如:+8600000000000。

      被添加的手机号码会收到由系统发送的“订阅请求”短信,48小时内有效。确认订阅请求后,该手机号码可收到通过该主题发布的所有消息。

    • 选择“邮件”,请输入有效电子邮件地址。例如:username@example.com。

      被添加的邮箱地址会收到由系统发送的“订阅请求”邮件,48小时内有效。确认订阅请求后,该邮箱地址可收到通过该主题发布的所有消息。

    • 选择“HTTP”或“HTTPS”,请输入公网网址,需要确认订阅。例如:https://example.com/notification/action。

      HTTP协议存在安全风险,建议使用HTTPS协议。

  6. 单击“确定”,新增一条订阅信息,可在“主题管理 > 订阅”页面中查看。

    订阅添加完成后,配置的订阅终端将收到确认订阅消息。确认订阅链接在48小时内有效,需要在有效期内完成确认操作。这样设置的订阅终端才能收到该主题发布的消息。

设置主题策略

  1. 在消息通知服务控制台的左侧导航树中选择主题管理 > 主题,进入主题页面。
  2. 在创建的主题行单击操作列的“更多 > 设置主题策略”,弹出主题策略设置页面。
  3. 配置主题策略的参数,如图3所示。

    图3 设置主题策略

    访问策略分为基本模式和高级模式,其中基本模式只可对用户和服务设置发布消息的操作权限,如图3所示。

    表3 基本模式说明

    策略对象

    参数设置

    说明

    可发布消息的用户

    仅自己(主题创建者)

    仅主题创建者有权限向该主题发布消息。

    所有人

    所有用户均有权限向该主题发布消息。

    仅如下用户

    设置可向该主题发布消息的用户。

    格式为urn:csp:iam::domainId:root

    其中,domainId即为用户的账号ID。多个用户时,以英文逗号隔开,可输入的用户数量没有限制,但生成的策略总长度不超过30KB。
    说明:
    • 您只需填写用户的“账号ID”,输入完成后,单击“确定”。其余内容由系统自动补全。
    • “账号ID”的获取方式:登录消息通知服务控制台,单击右上角用户名下的“我的凭证”,可查看“账号ID”。

    可发布消息的服务

    设置项如图3中所示。

    勾选“VOD”,表示授权该云服务可对该主题进行操作。

配置点播消息订阅

  1. 登录视频点播控制台
  2. 在左侧导航树中选择“全局设置 > 消息订阅”,进入消息订阅页签。

    图4 配置消息订阅

  3. 根据需要勾选订阅事件。

    如果用户同时勾选“截图完成事件”和“封面生成完成事件”,不会触发封面通知,都只会触发截图通知。

  4. 根据需要勾选订阅消息类型。

    若消息类型“模板消息”和“json消息”都勾选,则对于“短信”以及“邮件”订阅协议,只能接收到模板消息,对于“HTTP”以及“HTTPS”订阅协议,只能接收到json消息。

    • 勾选“接收模板消息”,模板消息内容请参考表4 模板消息说明通知文本消息内容中的各变量参数与实际操作相关,请以实际收到的消息内容为准。
      表4 模板消息说明

      事件

      事件处理结果状态

      通知文本消息内容

      转码完成

      成功

      尊敬的用户,您的视频转码任务已成功完成。视频ID:{asset_id},名称:{title},请登录点播Console或调用点播API获取详细转码信息。

      失败

      尊敬的用户,您的视频转码任务处理时出现错误。视频ID:{asset_id},名称:{title},错误码:{err_code},错误信息:{err_msg}。

      截图完成

      成功

      尊敬的用户,您的视频截图任务已成功完成。视频ID:{asset_id},名称:{title},请登录点播Console或调用点播API获取详细截图信息。

      失败

      尊敬的用户,您的视频截图任务处理时出现错误。视频ID:{asset_id},名称:{title},错误码:{err_code},错误信息:{err_msg}。

      审核完成

      成功

      尊敬的用户,您的视频审核任务已成功完成。视频ID:{asset_id},名称:{title},审核建议:{suggestion},请登录点播Console或调用点播API获取详细审核信息。

      失败

      尊敬的用户,您的视频审核任务处理时出现错误。视频ID:{asset_id},名称:{title},错误码:{err_code},错误信息:{err_msg}。

      媒资创建完成

      成功

      尊敬的用户,您的视频创建完成。视频ID:{asset_id},视频名称:{title},请登录点播Console或调用点播API获取详细视频信息。

      失败

      尊敬的用户,您的视频创建时出现错误。视频ID:{asset_id},视频名称:{title},错误码:{err_code},错误信息:{err_msg}。

      音频提取完成

      成功

      尊敬的用户,您的音频提取完成。音频ID:{asset_id},音频名称:{title},请登录点播Console或调用点播API获取详细音频信息。

      失败

      尊敬的用户,您的音频提取时出现错误。音频ID:{asset_id},音频名称:{title},错误码:{err_code},错误信息:{err_msg}。

      封面生成完成

      成功

      尊敬的用户,您的视频封面已生成。视频ID:{asset_id},视频名称:{title},请登录点播Console或调用点播API获取详细视频信息。

      失败

      尊敬的用户,您的视频封面生成失败。视频ID:{asset_id},视频名称:{title},错误码:{err_code},错误信息:{err_msg}。

      媒资解析完成

      成功

      尊敬的用户,您的视频解析完成。视频ID:{asset_id},视频名称:{title},请登录点播Console或调用点播API获取详细视频信息。

      失败

      尊敬的用户,您的视频解析时出现错误。视频ID:{asset_id},视频名称:{title},错误码:{err_code},错误信息:{err_msg}。

    • 勾选“接收json消息”,消息模板请参考表5 json消息模板说明
      表5 json消息模板说明

      参数

      说明

      类型

      event_type

      事件类型,当前支持的取值如下:

      • transcodeComplete:转码(加密)完成
      • thumbnailComplete:截图完成
      • reviewComplete:审核完成
      • createComplete:媒资创建完成
      • audioExtractComplete:音频提取完成
      • coverComplete:封面生成完成
      • parseComplete:媒资解析完成

      String

      transcode_info

      转码(含加密)信息,仅当是转码(加密)事件才有该字段,具体消息说明请参考转码消息体

      TranscodeInfo

      thumbnail_info

      截图信息,仅当是截图事件才有该字段,具体消息说明请参考截图消息体

      ThumbnailInfo

      review_info

      审核信息,仅当是审核事件才有该字段,具体消息说明请参考审核消息体

      ReviewInfo

      create_info

      新创建的媒资信息,仅当是媒资创建事件才有该字段,具体消息说明请参考创建媒资&音频提取消息体

      AssetInfo

      audio_extract_info

      新提取的音频信息,仅当是音频提取事件才有该字段,具体消息说明请参考创建媒资&音频提取消息体

      AssetInfo

      cover_info

      封面生成消息,仅当是封面生成事件才有该字段,具体消息说明请参考封面生成消息体

      CoverInfo

      parse_info

      媒资解析完成消息,仅当是媒资解析完成事件才有该字段,具体消息说明请参考解析媒资消息体

      ParseInfo

  5. 勾选在消息通知服务创建的SMN主题。
  6. 单击“确定”,完成消息订阅配置。