导出假期

导出步骤

获取导出文件的下载地址
下载导出文件

请求 URL

GET {base_url}/{api_path}/holidays/export?access_token={access_token}

请求参数


参数	是否必填	类型	说明
format	是	String	导出文件的格式。取值范围： `csv`：CSV 格式。
timezone_id	否	Integer	时区 ID。注：可通过查询时区列表接口获取时区 ID。
sort_by	否	String	定义排序字段。取值范围：`id`
order_by	否	String	定义显示顺序。取值范围： `asc`：升序。 `desc`：降序。

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
download_url	String	导出文件的下载地址。
file_name	String	导出文件的名称。

示例

请求示例

GET /openapi/v1.0/holidays/export?format=csv&order_by=desc&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "submsg": "",
    "file_name": "PBX-holiday.csv",
    "download_url": "/api/download/PBX-holiday.csv"
}

下载导出文件

获取导出文件的下载地址后，将该地址与 {base_url} 拼接，并在 URL 中添加 {access_token} 参数，组成完整的下载链接。使用该链接即可下载导出文件。

下载链接格式

{base_url}/{download_resource_url}?access_token={access_token}

下载链接示例

https://yeastardocs.example.yeastarcloud.comapi/download/PBX-holiday.csv?access_token=6LPooUthiIfL0yYvnljDHCyca2SB3atI