文档Engagement Platform API
Sign inGet started
Guides
API

Business Hours

GET
/workspaces/{workspaceId}/business-hours
Retrieve a list of defined business hours, showcasing their names, and other information.
查询参数
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
响应载荷
results
array of object
必填
显示子属性
results.id
string
必填
results.name
string
必填
results.description
string
results.timezone
string
必填
results.weeklySchedule
object
必填
显示子属性
results.weeklySchedule.monday
object
显示子属性
results.weeklySchedule.monday.from
object
必填
显示子属性
results.weeklySchedule.monday.from.hour
integer
必填
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
必填
显示子属性
results.weeklySchedule.monday.to.hour
integer
必填
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
显示子属性
results.weeklySchedule.tuesday.from
object
必填
显示子属性
results.weeklySchedule.tuesday.from.hour
integer
必填
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
必填
显示子属性
results.weeklySchedule.tuesday.to.hour
integer
必填
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
显示子属性
results.weeklySchedule.wednesday.from
object
必填
显示子属性
results.weeklySchedule.wednesday.from.hour
integer
必填
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
必填
显示子属性
results.weeklySchedule.wednesday.to.hour
integer
必填
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
显示子属性
results.weeklySchedule.thursday.from
object
必填
显示子属性
results.weeklySchedule.thursday.from.hour
integer
必填
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
必填
显示子属性
results.weeklySchedule.thursday.to.hour
integer
必填
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
显示子属性
results.weeklySchedule.friday.from
object
必填
显示子属性
results.weeklySchedule.friday.from.hour
integer
必填
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
必填
显示子属性
results.weeklySchedule.friday.to.hour
integer
必填
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
显示子属性
results.weeklySchedule.saturday.from
object
必填
显示子属性
results.weeklySchedule.saturday.from.hour
integer
必填
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
必填
显示子属性
results.weeklySchedule.saturday.to.hour
integer
必填
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
显示子属性
results.weeklySchedule.sunday.from
object
必填
显示子属性
results.weeklySchedule.sunday.from.hour
integer
必填
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
必填
显示子属性
results.weeklySchedule.sunday.to.hour
integer
必填
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
必填
显示子属性
results.holidays.name
string
必填
results.holidays.day
integer
必填
results.holidays.month
integer
必填
results.assignedTeamIds
array of string
results.createdAt
string
必填
results.updatedAt
string
必填
results.currentStatus
string
Possible values: open, closed
results.nextOpenTime
string
The next time the business will be open. Null when business is currently open or permanently closed.
results.nextCloseTime
string
The next time the business will close. Null when business is currently closed or permanently closed.
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/business-hours
Define and create new business hours, specifying the name, schedule.
请求载荷
name
string
必填
description
string
timezone
string
必填
weeklySchedule
object
必填
显示子参数
weeklySchedule.monday
object
显示子参数
weeklySchedule.monday.from
object
必填
显示子参数
weeklySchedule.monday.from.hour
integer
必填
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
必填
显示子参数
weeklySchedule.monday.to.hour
integer
必填
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
显示子参数
weeklySchedule.tuesday.from
object
必填
显示子参数
weeklySchedule.tuesday.from.hour
integer
必填
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
必填
显示子参数
weeklySchedule.tuesday.to.hour
integer
必填
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
显示子参数
weeklySchedule.wednesday.from
object
必填
显示子参数
weeklySchedule.wednesday.from.hour
integer
必填
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
必填
显示子参数
weeklySchedule.wednesday.to.hour
integer
必填
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
显示子参数
weeklySchedule.thursday.from
object
必填
显示子参数
weeklySchedule.thursday.from.hour
integer
必填
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
必填
显示子参数
weeklySchedule.thursday.to.hour
integer
必填
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
显示子参数
weeklySchedule.friday.from
object
必填
显示子参数
weeklySchedule.friday.from.hour
integer
必填
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
必填
显示子参数
weeklySchedule.friday.to.hour
integer
必填
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
显示子参数
weeklySchedule.saturday.from
object
必填
显示子参数
weeklySchedule.saturday.from.hour
integer
必填
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
必填
显示子参数
weeklySchedule.saturday.to.hour
integer
必填
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
显示子参数
weeklySchedule.sunday.from
object
必填
显示子参数
weeklySchedule.sunday.from.hour
integer
必填
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
必填
显示子参数
weeklySchedule.sunday.to.hour
integer
必填
weeklySchedule.sunday.to.minute
integer
holidays
array of object
必填
显示子参数
holidays.name
string
必填
holidays.day
integer
必填
holidays.month
integer
必填
assignedTeamIds
array of string
代码示例
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/business-hours' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/business-hours/{businessHourId}
Retrieve information about specific business hours, including their name, schedule.
响应载荷
id
string
必填
name
string
必填
description
string
timezone
string
必填
weeklySchedule
object
必填
显示子属性
weeklySchedule.monday
object
显示子属性
weeklySchedule.monday.from
object
必填
显示子属性
weeklySchedule.monday.from.hour
integer
必填
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
必填
显示子属性
weeklySchedule.monday.to.hour
integer
必填
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
显示子属性
weeklySchedule.tuesday.from
object
必填
显示子属性
weeklySchedule.tuesday.from.hour
integer
必填
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
必填
显示子属性
weeklySchedule.tuesday.to.hour
integer
必填
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
显示子属性
weeklySchedule.wednesday.from
object
必填
显示子属性
weeklySchedule.wednesday.from.hour
integer
必填
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
必填
显示子属性
weeklySchedule.wednesday.to.hour
integer
必填
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
显示子属性
weeklySchedule.thursday.from
object
必填
显示子属性
weeklySchedule.thursday.from.hour
integer
必填
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
必填
显示子属性
weeklySchedule.thursday.to.hour
integer
必填
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
显示子属性
weeklySchedule.friday.from
object
必填
显示子属性
weeklySchedule.friday.from.hour
integer
必填
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
必填
显示子属性
weeklySchedule.friday.to.hour
integer
必填
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
显示子属性
weeklySchedule.saturday.from
object
必填
显示子属性
weeklySchedule.saturday.from.hour
integer
必填
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
必填
显示子属性
weeklySchedule.saturday.to.hour
integer
必填
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
显示子属性
weeklySchedule.sunday.from
object
必填
显示子属性
weeklySchedule.sunday.from.hour
integer
必填
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
必填
显示子属性
weeklySchedule.sunday.to.hour
integer
必填
weeklySchedule.sunday.to.minute
integer
holidays
array of object
必填
显示子属性
holidays.name
string
必填
holidays.day
integer
必填
holidays.month
integer
必填
assignedTeamIds
array of string
createdAt
string
必填
updatedAt
string
必填
currentStatus
string
Possible values: open, closed
nextOpenTime
string
The next time the business will be open. Null when business is currently open or permanently closed.
nextCloseTime
string
The next time the business will close. Null when business is currently closed or permanently closed.
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/business-hours/{businessHourId}
Modify the details of specific business hours, such as their name, schedule.
请求载荷
name
string
description
string
timezone
string
weeklySchedule
object
显示子参数
weeklySchedule.monday
object
显示子参数
weeklySchedule.monday.from
object
必填
显示子参数
weeklySchedule.monday.from.hour
integer
必填
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
必填
显示子参数
weeklySchedule.monday.to.hour
integer
必填
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
显示子参数
weeklySchedule.tuesday.from
object
必填
显示子参数
weeklySchedule.tuesday.from.hour
integer
必填
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
必填
显示子参数
weeklySchedule.tuesday.to.hour
integer
必填
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
显示子参数
weeklySchedule.wednesday.from
object
必填
显示子参数
weeklySchedule.wednesday.from.hour
integer
必填
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
必填
显示子参数
weeklySchedule.wednesday.to.hour
integer
必填
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
显示子参数
weeklySchedule.thursday.from
object
必填
显示子参数
weeklySchedule.thursday.from.hour
integer
必填
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
必填
显示子参数
weeklySchedule.thursday.to.hour
integer
必填
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
显示子参数
weeklySchedule.friday.from
object
必填
显示子参数
weeklySchedule.friday.from.hour
integer
必填
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
必填
显示子参数
weeklySchedule.friday.to.hour
integer
必填
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
显示子参数
weeklySchedule.saturday.from
object
必填
显示子参数
weeklySchedule.saturday.from.hour
integer
必填
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
必填
显示子参数
weeklySchedule.saturday.to.hour
integer
必填
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
显示子参数
weeklySchedule.sunday.from
object
必填
显示子参数
weeklySchedule.sunday.from.hour
integer
必填
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
必填
显示子参数
weeklySchedule.sunday.to.hour
integer
必填
weeklySchedule.sunday.to.minute
integer
holidays
array of object
显示子参数
holidays.name
string
必填
holidays.day
integer
必填
holidays.month
integer
必填
assignedTeamIds
array of string
响应载荷
id
string
必填
name
string
必填
description
string
timezone
string
必填
weeklySchedule
object
必填
显示子属性
weeklySchedule.monday
object
显示子属性
weeklySchedule.monday.from
object
必填
显示子属性
weeklySchedule.monday.from.hour
integer
必填
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
必填
显示子属性
weeklySchedule.monday.to.hour
integer
必填
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
显示子属性
weeklySchedule.tuesday.from
object
必填
显示子属性
weeklySchedule.tuesday.from.hour
integer
必填
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
必填
显示子属性
weeklySchedule.tuesday.to.hour
integer
必填
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
显示子属性
weeklySchedule.wednesday.from
object
必填
显示子属性
weeklySchedule.wednesday.from.hour
integer
必填
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
必填
显示子属性
weeklySchedule.wednesday.to.hour
integer
必填
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
显示子属性
weeklySchedule.thursday.from
object
必填
显示子属性
weeklySchedule.thursday.from.hour
integer
必填
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
必填
显示子属性
weeklySchedule.thursday.to.hour
integer
必填
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
显示子属性
weeklySchedule.friday.from
object
必填
显示子属性
weeklySchedule.friday.from.hour
integer
必填
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
必填
显示子属性
weeklySchedule.friday.to.hour
integer
必填
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
显示子属性
weeklySchedule.saturday.from
object
必填
显示子属性
weeklySchedule.saturday.from.hour
integer
必填
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
必填
显示子属性
weeklySchedule.saturday.to.hour
integer
必填
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
显示子属性
weeklySchedule.sunday.from
object
必填
显示子属性
weeklySchedule.sunday.from.hour
integer
必填
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
必填
显示子属性
weeklySchedule.sunday.to.hour
integer
必填
weeklySchedule.sunday.to.minute
integer
holidays
array of object
必填
显示子属性
holidays.name
string
必填
holidays.day
integer
必填
holidays.month
integer
必填
assignedTeamIds
array of string
createdAt
string
必填
updatedAt
string
必填
currentStatus
string
Possible values: open, closed
nextOpenTime
string
The next time the business will be open. Null when business is currently open or permanently closed.
nextCloseTime
string
The next time the business will close. Null when business is currently closed or permanently closed.
代码示例
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/business-hours/{businessHourId}
Remove specific business hours, permanently deleting their defined schedule.
代码示例
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/business-hours/{businessHourId}/check
Determine if the current time falls within the defined business hours, providing information on availability.
响应载荷
isOpen
boolean
必填
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/business-hours/{businessHourId}/check' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'