乐维监控——短信对接说明

客户需要有一个短信接口
1. 客户需要有一个短信接口
目前我们仅支持对接,需要由客户提供短信的接口。短信接口一般都是计费的,我们本身并未提供短信服务。

2. 短信接口是云接口还是本地应用?
(1). 云接口,如阿里云,腾讯云等,以腾讯云为例,文档地址:指定模板单发短信
客户可能需要我们提供:  
  • 短信模板
    如: 【XXX集团】时间:{1},告警:{2},请尽快处理。
    这就是一条模板,即把固定定的文字定下,使用替换宏{1},{2}等等去代理可变字符串。
    模板内容需跟客户确认,若无特殊需求,使用上面的模板即可。

我们可能需要客户提供:
  • 模板ID
    短信模板提供给对方后,会由对方短信管理人员前往申请腾讯云平台申请,即可获得一个模板ID。
  • 应用ID
    由腾讯云平台提供,其它云大同小异。
  • 应用秘钥
    由腾讯云平台提供,其它云大同小异。

备注:
  不同平台的接口都不一样,但是大同小异,若确认使用云接口,务必事先告知开发,由开发确认即可。

(2). 本地应用
若客户自身有短信中心,或其他可对接的短信系统,这种情况下一般是由对方提供短信接口文档。
客户可能需要我们提供:
一般情况下,我们没有可提供的信息,大多情况下,自建的短信接口限制较为宽松,不需要使用短信模板。
我们可能需要客户提供的信息:
  • 短信接口地址
    以某客户为例,提供了http://ip[:port]/sms/sendHTTP形式的接口
  • 接口鉴权参数
    客户A为例,其使用账户密码鉴权,提供了2个参数account,password。有客户只需一个参数,提供了token一个固定串验证。
  • 其它必要参数
    sendto,phone等等。

备注:
客户自身的接口,可使用附录的短信接口模板。

3. 其它事项
  • 目前支持哪些接口
    HTTP/HTTPS
  • 网络策略问题
    若内网限制较严格,需根据接口情况,放通到目标短信服务器的80/443端口。

附:短信接口文档模板
以下仅为文档范例,请根据实际情况调整编写
==========================
功能描述
给用户发短信验证码短信。
URL 示例
POST [url=http://ip[:port]/sms/send]http://ip[:port]/sms/send[/url]
请求参数:
  1. {
  2.     "token": "ecab4881ee80ad3d76bb1da68387428ca752eb885e52621a3129dcf4d9bc4fd4",
  3.     "phone": "13788888888",
  4.     "message":"告警通知:主机A于2018年12月12日12点12分宕机,请及时处理。"
  5. }
复制代码

171909k3uru50m5rneisuq.png


响应参数
  1. {
  2.     "result": 0,
  3.     "errmsg": "OK"
  4. }
复制代码
172300hc7hziph7zp7z4ip.png
其它说明
此处可以有附加说明,如错误码表,相关备注等。

  • 发表于 2022-07-07 17:54
  • 阅读 ( 2770 )

你可能感兴趣的文章

相关问题

0 条评论

请先 登录 后评论
乐维君
乐维君

226 篇文章

作家榜 »

  1. 乐维君 226 文章
  2. 御前侍卫张五哥 2 文章
  3. 细雨闲花 2 文章
  4. 机灵小和尚 2 文章
  5. 我是一只小菜鸡 2 文章
  6. YOHOHO 2 文章
  7. 0.0 1 文章
  8. 白色枫叶 1 文章