订阅服务台事件

POST

/open-apis/helpdesk/v1/events/subscribe

本接口用于订阅服务台事件。

服务台请求Header中还需添加“服务台token”参数：

Key: X-Lark-Helpdesk-Authorization

Value: base64(helpdesk_id:helpdesk_token)，通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。

错误码

HTTP状态码	错误码	描述	排查建议
400	154000	Bad request, please check your request body	请求不合法，请检查参数
403	154003	Please check you have the correct access	检查是否申请正确权限
500	155000	Internal error	内部错误，请联系我们

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

Body 参数application/json

示例

返回响应

🟢200200 Success

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/open-apis/helpdesk/v1/events/subscribe' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "events": [
        {
            "type": "helpdesk.ticket_message",
            "subtype": "ticket_message.created_v1"
        }
    ]
}'

响应示例

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

修改于 2023-02-02 07:29:27

取消推送

取消订阅服务台事件

订阅服务台事件

错误码#

请求参数

返回响应

错误码