domain说明

序号 系统 环境 地址 备注
1 卓易政企通 测试 https://test-gateway.eazytec-cloud.com 适用【园企通】【行业政企通】【乡镇政企通】【协会政企通】
2 卓易政企通 线上 https://gateway.eazytec-cloud.com 适用【园企通】【行业政企通】【乡镇政企通】【协会政企通】
3 宜兴政企通 测试 https://test-gateway.eazytec-cloud.com/YX 适用【宜兴政企通】
4 宜兴政企通 线上 https://gateway.eazytec-cloud.com/YX 适用【宜兴政企通】
5 宜兴政企通 线上-政务外网 http://10.36.12.1:8000/YX(vpn) http://2.18.243.11:8000/YX(政务外网) 适用【宜兴政企通-政务外网】
6 江苏政企通 测试 https://test-gateway.eazytec-cloud.com/JS 适用【江苏政企通】
7 江苏政企通 线上 https://gateway.eazytec-cloud.com/JS 适用【江苏政企通】

发件箱

1. 查询发件箱
2. 获取发件消息详情
3. 撤回发件箱消息
4. 删除单条发件箱消息
5. 批量删除发件箱

1. 查询发件箱

  • 请求URL

    /AGCS_zqc/v3_1/msgcenter/query/outbox

  • 请求方式

    GET

  • 请求Header参数

key value 举例 是否必须
Content-Type application/json application/json
Authorization Bearer [token] Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3
  • 请求Query参数
参数 描述 格式 举例 是否必须
pageNo 分页时的当前页数 int >=1 1 否,默认为1
pageSize 分页时的每页记录数 int >=1 10 否,默认为10
appid 应用ID(多个逗号分隔) String
appname 应用名称(模糊搜索) String
msgtype 消息分类(0-应用消息,1-内部消息,10-我的订阅) int
outboxid 发件箱消息ID String
title 标题(模糊搜索) string
fromUserid 发送人用户ID String
fromUsertype 发送人用户分类(1-政府/2-企业) int
fromOrgid 发送人组织ID (政企labelid/企业baseid) String
fromDeptid 发送人部门ID String
state 状态(0-删除,1-已发送 ,2-草稿) int
  • 返回
    返回成功
    {
      "data": {
          "itemList": [
                 {
                     "appid": "222",
                     "appname": "应用名称222",
                     "body": "<p>测试消息正文</p><H>测试一下</H>",
                     "ctime": 1540291760012,
                     "deptid": "d-114",
                     "ext": "{\"test\":\"test-value\"}",
                     "id": "8cea3044-1907-4ebb-96e3-5836d38da7e7",
                     "msgtype": 0,
                     "needpush": 0,
                     "orgid": "o-114",
                     "params": "{\"needreply\":\"1\",\"attfiles\":\"[file:{name:'附件1',path:'www.path.com'}]\",\"hasatt\":\"1\",\"sender\":\"发件人描述\",\"recipient\":\"{'company':['c-1','c-2'],'contact':['t-1','t-2']}\",\"msgcategory\":\"消息类别\",\"msglevel\":\"消息级别\",\"needsms\":\"1\"}",
                     "state": 0,
                     "title": "消息标题33333",
                     "userid": "u-114",
                     "usertype": 1,
                     "utime": 1540449723609
                  }
          ],
          "pageNo": 1,
          "pageSize": 10,
          "totalNum": 8,
          "totalPage": 1
      },
      "msg": "success",
      "oK": true,
      "status": 200
    }
    
字段 描述
ctime 创建时间(毫秒时间戳)
utime 修改时间(毫秒时间戳)
ext 扩展参数(jsonString)
state 状态(0-删除,1-已发送 ,2-草稿)
params 消息参数(jsonString)

返回失败: 400(参数缺失)

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401(解决:重新获取token,然后重新请求)

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

2. 获取发件消息详情

  • 请求URL

    /AGCS_zqc/v3_1/msgcenter/detail/outbox/{outboxid}

参数 描述 格式 举例 是否必须
outboxid 发件消息ID String
  • 请求方式

    GET

  • 请求Header参数

key value 举例 是否必须
Content-Type application/json application/json
Authorization Bearer [token] Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3
  • 返回
    返回成功
    {
      "data": {
          "appid": "222",
          "appname": "应用名称222",
          "body": "<p>测试消息正文</p><H>测试一下</H>",
          "ctime": 1540291760012,
          "deptid": "d-114",
          "ext": "{\"test\":\"test-value\"}",
          "id": "8cea3044-1907-4ebb-96e3-5836d38da7e7",
          "msgtype": 0,
          "needpush": 0,
          "orgid": "o-114",
          "params": "{\"needreply\":\"1\",\"attfiles\":\"[file:{name:'附件1',path:'www.path.com'}]\",\"hasatt\":\"1\",\"sender\":\"发件人描述\",\"recipient\":\"{'company':['c-1','c-2'],'contact':['t-1','t-2']}\",\"msgcategory\":\"消息类别\",\"msglevel\":\"消息级别\",\"needsms\":\"1\"}",
          "state": 0,
          "title": "消息标题33333",
          "userid": "u-114",
          "usertype": 1,
          "utime": 1540449723609
      },
      "msg": "success",
      "oK": true,
      "status": 200
    }
    
字段 描述
ctime 创建时间(毫秒时间戳)
utime 修改时间(毫秒时间戳)
ext 扩展参数(jsonString)
state 状态(0-删除,1-已发送 ,2-草稿)
params 消息参数(jsonString)

返回失败: 400(参数缺失)

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401(解决:重新获取token,然后重新请求)

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

3. 撤回发件箱消息

  • 请求URL

    /AGCS_zqc/v3_1/msgcenter/revert/outbox/{outboxid}

参数 描述 格式 举例 是否必须
outboxid 发件消息ID String
  • 请求方式

    POST

  • 请求Header参数

key value 举例 是否必须
Content-Type application/json application/json
Authorization Bearer [token] Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3
  • 返回
    返回成功
      {
          "data": "true/false" ,
          "msg": "success",
          "oK": true,
          "status": 200
      }
    
    返回失败: 400(参数缺失)
       {
         "data": "缺少必要参数" ,
         "msg": "fail",
         "status": 400
       }
    
    返回失败: 401(解决:重新获取token,然后重新请求)
       {
           "error": "invalid_token",
           "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
       }
    

4. 删除单条发件箱消息

  • 请求URL

    /AGCS_zqc/v3_1/msgcenter/delete/outbox/{outboxid}

参数 描述 格式 举例 是否必须
outboxid 发件消息ID String
  • 请求方式

    DELETE

  • 请求Header参数

key value 举例 是否必须
Content-Type application/json application/json
Authorization Bearer [token] Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3
  • 返回
    返回成功
      {
          "data": "true/false" ,
          "msg": "success",
          "oK": true,
          "status": 200
      }
    
    返回失败: 400(参数缺失)
       {
         "data": "缺少必要参数" ,
         "msg": "fail",
         "status": 400
       }
    
    返回失败: 401(解决:重新获取token,然后重新请求)
       {
           "error": "invalid_token",
           "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
       }
    

5. 批量删除发件箱

  • 请求URL

    /AGCS_zqc/v3_1/msgcenter/delete/batch/outbox

  • 请求方式

    DELETE

  • 请求Header参数

key value 举例 是否必须
Content-Type application/json application/json
Authorization Bearer [token] Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3
  • 请求Body
    Type: raw

      ["outboxid1","outboxid2","outboxid3"]
    
  • 返回
    返回成功

      {
          "data": "true/false" ,
          "msg": "success",
          "oK": true,
          "status": 200
      }
    

    返回失败: 400(参数缺失)

       {
         "data": "缺少必要参数" ,
         "msg": "fail",
         "status": 400
       }
    

    返回失败: 401(解决:重新获取token,然后重新请求)

       {
           "error": "invalid_token",
           "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
       }
    
江苏卓易信息科技股份有限公司-TNG基础平台组 all right reserved,powered by Gitbook该文件最后修改时间: 2021-01-27 06:23:28

results matching ""

    No results matching ""