HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防系统管理模块 / 获取单位推送服务列表
获取单位推送服务列表
接口地址：https://api.iot.ink/api/app.php?s=Manage.Admin_PushServer_GetlistDeptPushServer.Api
接口描述： 获取单位推送服务列表
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| deptId | 字符串 | 必须 | - | 单位id 示例 | |
| isDept | 字符串 | 必须 | - | 0：单位 1：区域 示例 | |
| name | 字符串 | 必须 | - | 单位名称 示例 | |
| pageNum | 字符串 | 必须 | - | 页号 示例 | |
| pageSize | 字符串 | 必须 | - | 每页大小 示例 | |
| apiRequestRaw | 字符串 | 可选 | - | ||
| headerInfo | 字符串 | 可选 | - | [] |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.code | 字符串 | |
| data.msg | 字符串 | |
| data.data | 数组 | |
| data.data>>deptName | 字符串 | 单位名称 |
| data.data>>devicePushServerList | 数组 | |
| data.data>>devicePushServerList>>id | 字符串 | |
| data.data>>devicePushServerList>>name | 字符串 | 推送服务名称 |
| data.data>>devicePushServerList>>pushType | 字符串 | 推送服务类型 1：app推送 2：短信推送 3：语音推送 4：语音播报 |
| data.data>>devicePushServerList>>pushProvider | 字符串 | 推送提供厂商 app：极光 短信：本地，阿里云，飞鸽 语音：阿里云 语音播报: 本地 |
| data.data>>devicePushServerList>>pushParameter | 字符串 | |
| data.data>>devicePushServerList>>createTime | 字符串 | |
| data.data>>devicePushServerList>>createBy | 字符串 | |
| data.data>>devicePushServerList>>companyId | 字符串 | |
| data.data>>devicePushServerList>>messageType | 字符串 | |
| data.data>>devicePushServerList>>tenantId | 字符串 | |
| data.data>>devicePushServerList>>delFlag | 字符串 | |
| data.data>>devicePushServerList>>deptName | 字符串 | |
| data.data>>devicePushServerList>>deptId | 字符串 | |
| data.data>>devicePushServerList>>type | 字符串 | |
| data.data>>devicePushServerList>>content | 字符串 | |
| data.data>>videoPushServerList | 数组 | |
| data.data>>videoPushServerList>>id | 字符串 | |
| data.data>>videoPushServerList>>name | 字符串 | |
| data.data>>videoPushServerList>>pushType | 字符串 | |
| data.data>>videoPushServerList>>pushProvider | 字符串 | |
| data.data>>videoPushServerList>>pushParameter | 字符串 | |
| data.data>>videoPushServerList>>createTime | 字符串 | |
| data.data>>videoPushServerList>>createBy | 字符串 | |
| data.data>>videoPushServerList>>companyId | 字符串 | |
| data.data>>videoPushServerList>>messageType | 字符串 | |
| data.data>>videoPushServerList>>tenantId | 字符串 | |
| data.data>>videoPushServerList>>delFlag | 字符串 | |
| data.data>>videoPushServerList>>deptName | 字符串 | |
| data.data>>videoPushServerList>>deptId | 字符串 | |
| data.data>>videoPushServerList>>type | 字符串 | |
| data.data>>videoPushServerList>>content | 字符串 | |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| deptId | 必须 | |
| isDept | 必须 | |
| name | 必须 | |
| pageNum | 必须 | |
| pageSize | 必须 | |
| apiRequestRaw | 可选 | |
| headerInfo | 可选 |
客户端请求示例
成功响应返回示例：
失败响应返回示例：
错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 409 | ret=409，接口流量不足 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-04-20 20:07:12