查询全部客服工作日程

该接口用于获取所有客服信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/helpdesk/v1/agent_schedules
HTTP Method	GET
接口频率限制	特殊频控
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	helpdesk:all:readonly 获取服务台资源详情

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

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

Key: X-Lark-Helpdesk-Authorization

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

了解更多：获取与使用服务台token

查询参数

名称	类型	必填	描述
status	int\[\]	是	筛选条件 - 1：online客服 - 2：offline(手动)客服 - 3：off duty(下班)客服 - 4：移除客服 在 GET 请求中传入多个值的格式为 status=1&status=2。 示例值：1

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ agent_schedules	agent_schedule\[\]	客服列表
└ status	int	客服状态, 1 - online客服, 2 - offline(手动)客服, 3 - off duty(下班)自动处于非服务时间段
└ agent	agent_user	客服信息
└ id	string	客服 id
└ avatar_url	string	avatar url
└ name	string	客服名字
└ email	string	email
└ department	string	部门
└ company_name	string	公司名
└ schedule	weekday_schedule\[\]	工作日程列表
└ start_time	string	开始时间, format 00:00 - 23:59
└ end_time	string	结束时间, format 00:00 - 23:59
└ weekday	int	星期几, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, 6 - Saturday, 7 - Sunday, 9 - Everday, 10 - Weekday, 11 - Weekend
└ agent_skills	agent_skill_less_info\[\]	客服技能
└ id	string	客服技能 id
└ name	string	客服技能名
└ is_default	boolean	是默认技能

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "agent_schedules": [
            {
                "status": 1,
                "agent": {
                    "id": "ou_ea651a5c09e2d01af8acd34059f5359b",
                    "avatar_url": "https://avatar-url.com/test.png",
                    "name": "test-user",
                    "email": "test@bytedance.com",
                    "department": "测试部门",
                    "company_name": "test-company"
                },
                "schedule": [
                    {
                        "start_time": "00:00",
                        "end_time": "24:00",
                        "weekday": 9
                    }
                ],
                "agent_skills": [
                    {
                        "id": "agent-skill-id",
                        "name": "agent-skill",
                        "is_default": false
                    }
                ]
            }
        ]
    }
}

错误码

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