条件查询推送服务信息 - Manage.Admin_PushServer_GetqueryPushServerList.Api - 中科图灵开放平台

接口地址：https://api.iot.ink/api/app.php?s=Manage.Admin_PushServer_GetqueryPushServerList.Api

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

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.data	Array
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
    }
}
失败响应返回示例：

错误列表

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

本文档生成时间：2024-04-24 03:33:05