中科图灵开放平台 / 智慧消防系统管理模块 / 条件查询推送服务信息

条件查询推送服务信息

接口描述: 条件查询推送服务信息

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
name字符串必须-单位名称 示例
pageNum整型必须-查询的页号 示例
pageSize整型必须-每页大小 示例
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串返回标识符 0:成功 1:失败
data.msg字符串
data.dataArray
data.data>>pageNum字符串页号
data.data>>pageSize字符串分页大小
data.data>>size字符串
data.data>>startRow字符串
data.data>>endRow字符串
data.data>>total字符串总条数
data.data>>pages字符串当前页
data.data>>list数组
data.data>>list>>id字符串推送服务id
data.data>>list>>name字符串推送服务名称
data.data>>list>>pushType字符串推送服务类型
data.data>>list>>pushProvider字符串推送服务提供商
data.data>>list>>pushParameter字符串推送服务参数
data.data>>list>>createTime字符串创建时间
data.data>>list>>createBy字符串创建人id
data.data>>list>>companyId字符串该推送服务所属公司
data.data>>list>>messageType字符串短信类型
data.data>>list>>tenantId字符串站点id
data.data>>list>>delFlag字符串删除标识符
data.data>>prePage字符串
data.data>>nextPage字符串
data.data>>isFirstPage字符串
data.data>>isLastPage字符串
data.data>>hasPreviousPage字符串
data.data>>hasNextPage字符串
data.data>>navigatePages字符串
data.data>>navigatepageNums数组
data.data>>navigateFirstPage字符串
data.data>>navigateLastPage字符串
data.data>>lastPage字符串
data.data>>firstPage字符串
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
name 必须
pageNum 必须
pageSize 必须
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": {
        "pageNum": 1,
        "pageSize": 10,
        "size": 2,
        "startRow": 1,
        "endRow": 2,
        "total": 2,
        "pages": 1,
        "list": [
            {
                "id": 2,
                "name": "我们公司第一条短信规则",
                "pushType": 2,
                "pushProvider": 2,
                "pushParameter": "{accessKey:123,accessSecret:123,sign:345,templateId:34}",
                "createTime": "2020-06-03 14:59:44",
                "createBy": null,
                "companyId": 2,
                "messageType": null,
                "tenantId": null,
                "delFlag": null
            },
            {
                "id": 3,
                "name": "我们公司第2条短信规则",
                "pushType": 2,
                "pushProvider": 2,
                "pushParameter": "{accessKey:123,accessSecret:123,sign:345,templateId:34}",
                "createTime": "2020-06-03 14:59:44",
                "createBy": 1,
                "companyId": 2,
                "messageType": 2,
                "tenantId": null,
                "delFlag": null
            }
        ],
        "prePage": 0,
        "nextPage": 0,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 1,
        "lastPage": 1,
        "firstPage": 1
    }
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-05-22 09:18:14