更新推送

PATCH

/open-apis/helpdesk/v1/notifications/{notification_id}

自建应用

更新推送信息，只有在草稿状态下才可以调用此接口进行更新

错误码

HTTP状态码	错误码	描述	排查建议
400	154000	Bad request, please check your request body	请求不合法，请检查参数
401	154001	Unauthorized, please check you have the correct access	检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确，应用和服务台属于同一租户
403	154003	Please check you have the correct access	检查是否申请正确权限
404	154004	Resource not found	资源不存在，请检查ID值
405	154005	Method Forbidden	检查是否有权限创建推送
500	155000	Internal error	内部错误，请联系我们

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://open.feishu.cn/open-apis/helpdesk/v1/notifications/6985032626234982420?user_id_type=open_id' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "6981801914270744596",
    "job_name": "测试推送任务",
    "status": 0,
    "create_user": {
        "user_id": "ou_7277fd1262bfafc363d5b2a1f9c2ac90",
        "avatar_url": "http://*.com/*.png",
        "name": "test"
    },
    "created_at": "1626332244719",
    "update_user": {
        "user_id": "ou_7277fd1262bfafc363d5b2a1f9c2ac90",
        "avatar_url": "http://*.com/*.png",
        "name": "test"
    },
    "updated_at": "1626332244719",
    "target_user_count": 1,
    "sent_user_count": 1,
    "read_user_count": 1,
    "send_at": "1626332244719",
    "push_content": "{   \"config\": {     \"wide_screen_mode\": true   },   \"elements\": [     {       \"tag\": \"div\",       \"text\": {         \"tag\": \"lark_md\",         \"content\": \"[飞书](https://www.feishu.cn)整合即时沟通、日历、音视频会议、云文档、云盘、工作台等功能于一体，成就组织和个人，更高效、更愉悦。\"       }     }   ] }",
    "push_type": 0,
    "push_scope_type": 0,
    "new_staff_scope_type": 0,
    "new_staff_scope_department_list": [
        {
            "department_id": "od_7277fd1262bfafc363d5b2a1f9c2ac90",
            "name": "测试部门"
        }
    ],
    "user_list": [
        {
            "user_id": "ou_7277fd1262bfafc363d5b2a1f9c2ac90",
            "avatar_url": "http://*.com/*.png",
            "name": "test"
        }
    ],
    "department_list": [
        {
            "department_id": "od_7277fd1262bfafc363d5b2a1f9c2ac90",
            "name": "测试部门"
        }
    ],
    "chat_list": [
        {
            "chat_id": "oc_7277fd1262bfafc363d5b2a1f9c2ac90",
            "name": "测试群聊"
        }
    ],
    "ext": "{}"
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

请求参数

Path 参数

notification_id

string

必需

push任务唯一id 示例值："6985032626234982420"

示例值:

6985032626234982420

Query 参数

user_id_type

string

可选

用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

示例值:

open_id

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

string

必需

非必填，创建成功后返回示例值："6981801914270744596"

job_name

string

必需

必填，任务名称示例值："测试推送任务"

status

integer

必需

非必填，创建成功后返回示例值：0

create_user

object

非必填，创建人

必需

user_id

string

必需

非必填，用户id 示例值："ou_7277fd1262bfafc363d5b2a1f9c2ac90"

avatar_url

string

必需

非必填，头像地址示例值："http://.com/.png"

name

string

必需

非必填，用户名称示例值："test"

created_at

string

必需

非必填，创建时间（毫秒时间戳）示例值："1626332244719"

update_user

object

非必填，更新用户

必需

user_id

string

必需

非必填，用户id 示例值："ou_7277fd1262bfafc363d5b2a1f9c2ac90"

avatar_url

string

必需

非必填，头像地址示例值："http://.com/.png"

name

string

必需

非必填，用户名称示例值："test"

updated_at

string

必需

非必填，更新时间（毫秒时间戳）示例值："1626332244719"

target_user_count

integer

必需

非必填，目标推送用户总数示例值：1

sent_user_count

integer

必需

非必填，已推送用户总数示例值：1

read_user_count

integer

必需

非必填，已读用户总数示例值：1

send_at

string

必需

非必填，推送任务触发时间（毫秒时间戳）示例值："1626332244719"

push_content

string

必需

必填，推送内容，详见：https://open.feishu.cn/tool/cardbuilder?from=howtoguide 示例值："{ "config": { "wide_screen_mode": true }, "elements": [ { "tag": "div", "text": { "tag": "lark_md", "content": "飞书整合即时沟通、日历、音视频会议、云文档、云盘、工作台等功能于一体，成就组织和个人，更高效、更愉悦。" } } ] }"

push_type

integer

必需

必填，0（定时推送：push_scope不能等于3） 1（新人入职推送：push_scope必须等于1或者3；new_staff_scope_type不能为空）示例值：0

push_scope_type

integer

必需

必填，推送范围（服务台私信） 0：组织内全部成员（user_list和department_list必须为空） 1：不推送任何成员（user_list和department_list必须为空，chat_list不可为空） 2：推送到部分成员（user_list或department_list不能为空） 3：入职新人以上四种状态，chat_list都相对独立，只有在推送范围为1时，必须需要设置chat_list 示例值：0

new_staff_scope_type

integer

必需

非必填，新人入职范围类型（push_type为1时生效） 0：组织内所有新人 1：组织内特定的部门（new_staff_scope_department_list 字段不能为空）示例值：0

new_staff_scope_department_list

array [object {2}]

必需

非必填，新人入职生效部门列表

department_id

string

可选

部门ID 示例值："od_7277fd1262bfafc363d5b2a1f9c2ac90"

name

string

可选

非必填，部门名称示例值："测试部门"

user_list

array [object {3}]

必需

非必填，push推送到成员列表

user_id

string

可选

非必填，用户id 示例值："ou_7277fd1262bfafc363d5b2a1f9c2ac90"

avatar_url

string

可选

非必填，头像地址示例值："http://.com/.png"

name

string

可选

非必填，用户名称示例值："test"

department_list

array [object {2}]

必需

非必填，push推送到的部门信息列表

department_id

string

可选

部门ID 示例值："od_7277fd1262bfafc363d5b2a1f9c2ac90"

name

string

可选

非必填，部门名称示例值："测试部门"

chat_list

array [object {2}]

必需

非必填，push推送到的会话列表(群)

chat_id

string

可选

非必填，会话ID 示例值："oc_7277fd1262bfafc363d5b2a1f9c2ac90"

name

string

可选

非必填，会话名称示例值："测试群聊"

ext

string

必需

非必填，预留扩展字段示例值："{}"

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

修改于 2023-02-02 07:22:07

创建推送

查询推送

更新推送

错误码#

请求参数

返回响应

错误码