中科图灵开放平台 / 智慧消防系统管理模块 / 添加推送服务

添加推送服务

接口描述: 添加推送服务

HTTP/HTTPS
请求协议
POST
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
name字符串必须-推送服务名称 示例
pushType整型必须-推送类型 1:app推送 2:短信推送 3:语音推送 示例
pushProvider整型必须-推送服务提供商 app-1:极光推送 短信-1:本地 2:阿里云 3:飞鸽 语音-1:阿里云 示例
pushParameter字符串必须-推送的参数信息 示例
messageType整型必须-短信类型 1:验证码 2:报警 示例
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.data字符串
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
name 必须
pushType 必须
pushProvider 必须
pushParameter 必须
messageType 必须
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": null
}
失败响应返回示例:

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
500表示服务端内部错误

本文档生成时间:2024-04-23 18:29:08