电话告警API

接口地址:http://www.linkedsee.com/alarm/cloudchannel

服务协议:HTTP POST

请求(JSON格式)示范:

①发送给接收人的:receiver填写的应该是接收人ID

curl -H 'Servicetoken:0728930bd406187b166741b5f207' -X POST -d '{"receiver":"188XXXXXXXX", "type":"phone","title":"alarm_phone","content":"test告警语音"}' 'http://www.linkedsee.com/alarm/cloudchannel'

②发送给接收群组的:receiver填写的应该是接收群组ID

curl -H 'Servicetoken:0728930bd406187b166741b5f2077afc' -X POST -d ' {"receiver":"q201703032219XXXXX", "type":"phone","title":"alarm_phone","content":"test告警语音"}' 'http://www.linkedsee.com/alarm/cloudchannel'
如何获取Service token?
Service token作为应用的唯一标识,用于保证用户数据的安全性与隐私性。

新建任何一个应用后,系统都将自动生成一个token,点击该应用名称或查看应用详情icon进入应用详情页,获取Service token,供您在调用通道时使用。如下图所示。

1、请求参数说明:

参数名 参数类型 是否必须 示范值 描述
Servicetoken String E234430d3c9101b442c1eb097336092d 授权token
receiver String 188XXXXXXXX 接收人ID或者接收群组ID
type String phone 电话告警,固定为phone
title String alarm_phone 发送的告警短信,固定为alarm_phone
content String 告警测试 报警内容,长度小于120字

2、返回参数说明:

参数名 参数类型 是否必须 示范值 描述
status boolean false或true false:发送失败,true:发送成功
message string ok 发送结果提示
data object {...} 发送成功结果
errorCode number 100001 失败返回码
返回成功示范:

①返回值1:合并告警成功,不发送

{"status":true,"message":"ok","data":"\u5408\u5e76\u62a5\u8b66\u6210\u529f"}

②返回值2,接收人返回值:发送成功,receiver为手机号

{"status":true,"message":"ok","data":{"receiver":"188XXXXXXXX"}}

③返回值3,接收群组返回值:发送成功,receiver为手机号

{"status":true,"message":"ok","data":[{"receiver":"188XXXXXXXX"},{"receiver":"188XXXXXXXX"}]}
返回失败示范:

message为失败信息,errorCode为:失败返回码

{ "status":false, "message":"错误:剩余余额不足以支付本次调用,请充值", "errorCode":100013 }
错误返回值说明
返回值 说明
100001 服务超过推送限制
40404 servicetoken为空
404000 servicetoken不存在
100002 可用title列表为alarm_sms、alarm_phone、notice_sms、notice_phone,现类型不正确
100003 当前要使用的服务没有开启。
404002 要发送的群组不存在。
100004 要发送的群组下没有接收人。
404001 要发送的接收人不存在。
100013 剩余余额不足以支付本次调用,请充值。
100012 通道余额不足。
100014 可用type列表为: ["sms","phone"],现类型不正确。
100015 type和title不匹配。
34004 电话格式有误。

版权所有 北京云集智造科技有限公司|京ICP备16006412号