[关闭]
@myyzs 2021-06-16T09:23:00.000000Z 字数 2422 阅读 226

公告发送接口

公告


环境说明

环境 域名
测试 https://qy-ci.fdccloud.com
预发 https://qy-qa.fdccloud.com
生产 https://www.fdccloud.com

1、获取access_token

根据corpid和corpsecret获取获取access_token,登录云助手企业平台 设置中心->企业设置->开发账号管理 中获取

接口地址:

HOST/api/tenant-open/get-access-token

传参方式 :

POST

参数:

{
    "corpid":"corpid,租户的唯一标识",
    "corpsecret":"企业secret" 
}

返回结果:

成功返回

{
    "errcode": 0,
    "errmsg": "ok",
    "isComplete": 1,
    "data": "RVla.....09" //token信息,有效期2小时
}

失败返回

{"errcode":"错误code","errmsg":"错误信息","data":""}

2、上传文件

接口地址:

HOST/api/tenant-open/upload-file?access_token=ACCESS_TOKEN

传参方式:

Post

参数:

{
    "files": [{
        "id": 1,
        "source": "dGhpcyBpcyBhIHRlc3QgY29udGVudA==",
        "file_type":"txt"
    }]
}
参数 必填 说明
files 必填 文件列表
id 必填 文件id,上传成功后会回传这个id
source 必填 文件流(需要做base64编码)
file_type 必填 文件类型(扩展名)

备注

source为文件流信息,比如php可以通过file_get_contents获取文件的流信息

返回结果:

成功

{
    "errcode": 0,
    "errmsg": "ok",
    "data": [{
        "id": 1,
        "file_url": "https://oss-mytest.oss-cn-hangzhou.aliyuncs.com/0000/my596c24f03fc0e/openapi/files/562a9e0d3f4007978900d7f87fa2b07d.txt"
    }]
}

失败

{
       "errcode" => "错误代码",
       "errmsg" => "错误信息",
       "data" => ""
}

3、发送公告

接口地址:

HOST/api/tenant-open/send-qy-notice?access_token=ACCESS_TOKEN

传参方式:

Post

参数:

{
    "title": "公告标题",
    "content": "公告内容",
    "author": "发布者",
    "attachments": [{
        "file_url": "附件的url地址",
        "file_name": "附件名称"
     },
     {
        "file_url": "附件的url地址2",
        "file_name": "附件名称2"
     }
    ],
    "depts": ["xx-xxx-xx", "xx-xxx-xx"],
    "users": ["xx-xxx-xx", "xxx-xx-xxx"],
    "category": "企业通知",
    "from": "erp",
    "enable_push_msg": 0
}
参数 必填 说明
title 必填 标题
content 必填 内容
author 非必填 如果未空则默认为当前企业名称
attachments 非必填 附件列表
depts 非必填 发送部门的guid,发送给指定部门及子部门下的用户
users 非必填 发送用户的guid,如果有值则会针对用户发送公告
category 非必填 公告类别,默认为“企业通知”
from 非必填 公告来源:erp,yzs。默认为yzs公告,erp公告不会反向同步到erp
enable_push_msg 非必填 0:不推送 1:推送 默认不推送(无通知栏提醒,无应用消息,进入公告应用可以看到内容)

备注

如果depts和users都是空,则发送顶级公司下的所有的人

返回结果:

成功

{
   "errcode" => 0,
   "errmsg' => "ok",
   "data" => {"notice_id":"xxxx"} //消息的ID,请保存下来,可以用于后面的修改和删除操作
}

失败

{
       "errcode" => "错误代码",
       "errmsg" => "错误信息",
       "data" => ""
}

备注:

  1. 附件支持.txt,.doc,.docx,.xls,.xlsx,.ppt,.pptx,.pdf类型文件,20M以内

4、修改公告

接口地址:

HOST/api/tenant-open/edit-qy-notice?access_token=ACCESS_TOKEN

传参方式:

Post

参数:

{
    "notice_id":"公告的ID",
    "content":"公告内容",
    "author":"发布者"
    "attachments":[
        {"file_url":"附件的url地址","file_name":"附件名称"},
        {"file_url":"附件的url地址2","file_name":"附件名称2"}
    ]
}
参数 必填 说明
notice_id 必填 公告id
content 必填 内容
author 非必填 不填则不修改发布者
attachments 非必填 不填则不修改附件

返回结果:

成功

{
   "errcode" => 0,
   "errmsg' => "ok",
   "data" => ""
}

失败

{
       "errcode" => "错误代码",
       "errmsg" => "错误信息",
       "data" => ""
}

5、删除公告

接口地址:

HOST/api/tenant-open/del-qy-notice?access_token=ACCESS_TOKEN

传参方式:

Post

参数:

{
    "notice_id":"100,200"公告ID,多个以逗号分隔
}

返回结果:

成功

{
   "errcode" => 0,
   "errmsg' => "ok",
   "data" => ""
}

失败

{
       "errcode" => "错误代码",
       "errmsg" => "错误信息",
       "data" => ""
}
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注