更新时间:2024-01-12 GMT+08:00
分享

自动化规则

自动化规则是用来监控SIM卡和流量池的相关信息,并在满足条件时按照设置的周期发送短信或者邮件通知到您。当前提供实体卡到期前天数、SIM卡已用流量和剩余流量、流量池已用流量和剩余流量这几种监控方式。

创建规则

登录全球SIM联接控制台,在左侧选择“自动化规则”进入自动化规则列表页面,单击“创建规则”进入创建自动化规则页面。

表1 创建规则参数说明

参数名称

说明

规则名称

自定义规则的名称,便于管理。

规则类型

规则的类型包括订单管理、用量监控、卡状态变更监控、流量池监控。

触发器

触发器的类型分为五种情况:

  • SIM卡套餐到期:订单管理规则的触发器。
  • 周期累计数据用量:用量监控规则的触发器。
  • 卡状态变更:卡状态变更监控规则的触发器。
  • 前向流量池周期累计数据用量:流量池监控规则的触发器。
  • 后向流量池周期累计数据用量:流量池监控规则的触发器。

触发条件

触发条件的类型分为三种情况:

  • 到期天数(天):订单管理规则的触发条件。
  • 剩余流量(MB):用量监控规则或流量池监控规则的触发条件。
  • 卡状态(未激活、可激活、在用、已停用、拆机)变更:卡状态变更监控规则的触发条件。

执行

选择规则触发后的通知方式,包括短信&邮件或API推送。

  • 短信&邮件:
    • 提醒周期:根据需要设置短信提醒的周期。
    • 发送短信:此处展示短信通知的模板示例。
  • API推送:
    • API推送地址:选择指定的API推送地址。若先前未创建推送地址,可单击右侧“推送地址管理界面创建”按钮跳转到推送地址管理页面新增推送地址。
    • 合并发送:若不勾选“合并发送”,API推送的报文请参考API推送报文;若勾选“合并发送”,API推送的报文请参考API合并推送报文
    • 提醒周期:根据需要设置API推送的提醒周期。
    • 推送失败提醒:若开启了推送失败提醒,当推送失败时,用户会在消息中心收到API推送失败提醒,在消息接收管理中对应消息类型下配置消息接收人即可收到短信或邮件提醒。

筛选器

筛选器类型分为四种情况(默认情况下是监控您平台的所有SIM卡):

  • 主套餐:通过购卡下单时选择的套餐筛选,过滤出您想要监控的SIM卡。
  • 标签:通过标签筛选,过滤出您想要监控的SIM卡。
  • 前向流量池:通过前向流量池的名称筛选过滤您想要监控的SIM卡。
  • 后向流量池:通过后向流量池的名称筛选过滤您想要监控的SIM卡。

规则执行记录

登录全球SIM联接控制台,在左侧选择“自动化规则”,选择“规则执行记录”页签进入规则执行记录页面。

规则执行记录页面显示所有规则执行记录,你可以查看有哪些卡触发了规则以及触发条件和接受到通知的邮箱地址或短信。

推送地址管理

登录全球SIM联接控制台,在左侧导航栏选择自动化规则,选择推送地址管理页签,单击“新增推送地址”,按照下表参数说明填写相关信息后,单击“测试”

推送地址管理页面显示全部的推送地址信息,你可以查看并管理已有的推送地址。

参数名称

参数说明

推送地址

推送地址的url。

上传证书

上传 url 对应的服务端证书(.pem格式)。

API推送报文

推送body参数

参数

参数类型

描述

cid

string

容器ID。

ruleType

int

规则类型:

  • 1:订单管理。
  • 2:用量监控。
  • 3:流量池监控。
  • 4:卡状态变更监控。

templateName

string

模板名称:

  • api_rule_price_plan_expired:SIM卡套餐到期模板。
  • api_rule_flow_usage_remain:周期累计数据用量模板。
  • api_rule_sim_status_modify:卡状态变更模板。
  • api_sim_pool_rule_flow_usage_remain:流量池周期累计数据用量模板。
  • sim_pool_rule_flow_usage:前向流量池邮件发送模板。
  • sim_pool_rule_flow_usage_remain:前向流量池邮件发送模板。
  • back_pool_rule_flow_usage:后向流量池邮件发送模板。
  • api_back_pool_rule_flow_usage:后向流量池周期累计数据用量API推送模板。

templateParams

list

模板参数集合,建议按照key值进行解析,后续可能会添加其他key值。

SIM卡套餐到期(api_rule_price_plan_expired)

【全球SIM联接】尊敬的{accountName}客户,您好!{cid}购买的套餐{pricePlanName}将在{daysToExpire}天后过期,请及时续费。

{
  "cid": "4441380627973120",
  "ruleType": 1,
  "templateName": "api_rule_price_plan_expired",
  "templateParams": [
    {
      "key": "cid",
      "value": "4441380627973120"
    },
    {
      "key": "pricePlanName",
      "value": "中国移动每月30M联接服务"
    },
    {
      "key": "poolId",
      "value": "0"
    },
    {
      "key": "daysToExpire",
      "value": "9"
    }
  ]
}

周期累计数据用量(api_rule_flow_usage_remain)

【全球SIM联接】尊敬的{accountName}客户,您好!您的SIM卡(容器ID:{cid})购买的套餐({pricePlanName})剩余流量已不足{remainFlow}MB,请合理使用,需要避免流量达量断网。

{
  "cid": "4441380627973120",
  "ruleType": 1,
  "templateName": "api_rule_flow_usage_remain",
  "templateParams": [
    {
      "key": "cid",
      "value": "4441380627973120"
    },
    {
      "key": "pricePlanName",
      "value": "中国移动每月30M联接服务"
    },
    {
      "key": "remainFlow",
      "value": "100"
    }
  ]
}

卡状态变更(api_rule_sim_status_modify)

【全球SIM联接】尊敬的{accountName}客户,您好!您的SIM卡(容器ID:{cid})状态于{modifyTime}由{oldStatus}变为{newStatus}。

{
  "cid":"2021080621060000T",
  "ruleType":4,
  "templateName":"api_rule_sim_status_modify",
  "templateParams":[
    {
	"key":"cid","value":"2021080621060000T"
    },
    {
	"key":"modifyTime","value":"2022-05-16 03:24:08"
    },
    {
	"key":"oldStatus","value":"未激活"
    },
    {
	"key":"newStatus","value":"可激活"
    }
  ]
}

流量池周期累计数据用量(api_sim_pool_rule_flow_usage_remain)

【全球SIM联接】尊敬的{accountName}客户,您好!{poolId}流量池名:{poolName},套餐名称:{pricePlanName},已用流量{remainFlow}MB,请合理使用,需要避免达量断网。

{
  "cid": "4441380627973120",
  "ruleType": 1,
  "templateName": "api_sim_pool_rule_flow_usage_remain",
  "templateParams": [
    {
      "key": "poolId",
      "value": "4441380627973120"
    },
    {
      "key": "poolName",
      "value": "xx流量池"
    },
    {
      "key": "pricePlanName",
      "value": "中国移动每月30M联接服务"
    },
    {
      "key": "remainFlow",
      "value": "100"
    }
  ]
}

前向流量池邮件发送模板(sim_pool_rule_flow_usage)

【华为云】尊敬的{Account}客户,您好!您的前向流量池(流量池号:{poolId}, 流量池名称:{poolName},套餐名称: {pricePlanName})已用流量{usageFlow}MB,请合理使用,需要避免流量达量断网。

{
  "cid": "null",
  "ruleType": 3,
  "templateName": "api_back_pool_rule_flow_usage_remain",
  "templateParams": [
    {
      "key": "poolId",
      "value": "4441380627973120"
    },
    {
      "key": "poolName",
      "value": "xx流量池"
    },
    {
      "key": "pricePlanName",
      "value": "中国电信消费级阶梯流量池联接服务"
    },
    {
      "key": "usageFlow",
      "value": "100"
    }
  ]
}

前向流量池邮件发送模板(sim_pool_rule_flow_usage_remain)

【华为云】尊敬的{Account}客户,您好!您的前向流量池(流量池号:{poolId}, 流量池名称:{poolName},套餐名称: {pricePlanName})剩余流量{remainFlow}MB,请合理使用,需要避免流量达量断网。

{
  "cid": "4441380627973120",
  "ruleType": 1,
  "templateName": "api_sim_pool_rule_flow_usage_remain",
  "templateParams": [
    {
      "key": "poolId",
      "value": "4441380627973120"
    },
    {
      "key": "poolName",
      "value": "xx流量池"
    },
    {
      "key": "pricePlanName",
      "value": "中国移动每月30M联接服务"
    },
    {
      "key": "remainFlow",
      "value": "100"
    }
  ]
}

后向流量池邮件发送模板(back_pool_rule_flow_usage)

【华为云】尊敬的{Account}客户,您好!您的后向流量池(流量池号:{poolId}, 流量池名称:{poolName},套餐名称: {pricePlanName})已用流量{usageFlow}MB,请合理使用,避免产生过量的费用。

{
  "cid": "null",
  "ruleType": 3,
  "templateName": "api_back_pool_rule_flow_usage_remain",
  "templateParams": [
    {
      "key": "poolId",
      "value": "4441380627973120"
    },
    {
      "key": "poolName",
      "value": "xx流量池"
    },
    {
      "key": "pricePlanName",
      "value": "中国电信消费级阶梯流量池联接服务"
    },
    {
      "key": "usageFlow",
      "value": "100"
    }
  ]
}

后向流量池周期累计数据用量API推送模板(api_back_pool_rule_flow_usage)

【华为云】尊敬的{Account}客户,您好!您的后向流量池(流量池号:{poolId}, 流量池名称:{poolName},套餐名称: {pricePlanName})已用流量{usageFlow}MB,请合理使用,避免产生过量的费用。

{
  "cid": "null",
  "ruleType": 3,
  "templateName": "api_back_pool_rule_flow_usage_remain",
  "templateParams": [
    {
      "key": "poolId",
      "value": "4441380627973120"
    },
    {
      "key": "poolName",
      "value": "xx流量池"
    },
    {
      "key": "pricePlanName",
      "value": "中国电信消费级阶梯流量池联接服务"
    },
    {
      "key": "usageFlow",
      "value": "100"
    }
  ]
}

API合并推送报文

推送body参数

参数

参数类型

描述

ruleType

int

规则类型:

  • 1:订单管理 。
  • 2:用量监控 。
  • 4:卡状态变更监控。

templateName

string

模板名称:

api_rule_price_plan_expired:SIM卡套餐到期模板。

api_rule_flow_usage_remain:周期累计数据用量模板。

api_rule_sim_status_modify:卡状态变更模板。

templateParamsList

array

包含多个卡信息的模板参数集合,最多包含500张卡的信息。

templateParamsList.templateParams

array

单个卡信息的模板参数集合,建议按照key值进行解析,后续可能会添加其他key值。

SIM卡套餐到期(api_rule_price_plan_expired)报文示例:
{
  "ruleType": 1,
  "templateName": "api_rule_price_plan_expired",
  "templateParamsList": [
    {
      "templateParams": [
        {
          "key": "cid",
          "value": "4441380627973120"
        },
        {
          "key": "pricePlanName",
          "value": "中国移动每月30M联接服务"
        },
        {
          "key": "daysToExpire",
          "value": "9"
        }
      ]
    },
    {
      "templateParams": [...]
    }
    ...
  ]
}

周期 累计数据用量(api_rule_flow_usage_remain)报文示例

{
  "ruleType": 2,
  "templateName": "api_rule_flow_usage",
  "templateParamsList": [
    {
      "templateParams": [
        {
          "key": "cid",
          "value": "4441380627973120"
        },
        {
          "key": "pricePlanName",
          "value": "中国移动每月30M联接服务"
        },
        {
          "key": "usageFlow",
          "value": "100"
        }
      ]
    },
    {
      "templateParams": [...]
    }
    ...
  ]
}

卡状态变更(api_rule_sim_status_modify)报文示例

{
  "ruleType": 4,
  "templateName": "api_rule_sim_status_modify",
  "templateParamsList": [
    {
      "templateParams": [
        {
          "key": "cid",
          "value": "2021080621060000T"
        },
        {
          "key": "modifyTime",
          "value": "2022-05-16 03:24:08"
        },
        {
          "key": "oldStatus",
          "value": "未激活"
        },
        {
          "key": "newStatus",
          "value": "可激活"
        }
      ]
    },
    {
      "templateParams": [...]
    }
    ...
  ]
}

API推送失败提醒

用户只有在自动化规则选了API推送,且开启了推送失败提醒,当推送失败,消息中心会收到提醒信息。

自动化规则API推送失败提醒示例

尊敬的{accountName}客户,
您好!您配置的自动化规则{ruleName},在{pushTime}执行API推送时失败,推送地址: {pushUrl},推送内容请查看附件。
本邮件由华为全球SIM联接系统自动发送,请勿直接回复!
感谢您的配合与支持!
  • 用户如果选择了API推送,并且勾选了“合并发送”,推送的报文与没有勾选“合并发送”的报文不同。
  • 当前流量池周期累计数据用量不支持合并推送。
  • 附件内容为推送失败的报文内容。
分享:

    相关文档

    相关产品