Fetch task limits
Retrieve the org’s current task limits configuration. Business hours use a timezone plus grouped windows; days are 0 (Sunday) through 6 (Saturday).
OpenAPI
````yaml get /api/v2/tasks/limits
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/tasks/limits:
get:
tags:
- Tasks
summary: Fetch task limits
description: >-
Retrieve the org’s current task limits configuration. Business hours use
a timezone plus grouped windows; days are 0 (Sunday) through 6
(Saturday).
responses:
'200':
description: Limits
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
limits:
type: object
properties:
businessHours:
type: object
properties:
timezone:
type: string
example: America/Chicago
windows:
type: array
items:
type: object
properties:
days:
type: array
example:
- 5
items:
type: number
start:
type: string
example: '09:00'
end:
type: string
example: '15:00'
daily:
type: object
properties:
calls:
type: number
example: 100
texts:
type: number
example: 200
tasks:
type: number
example: 300
maxConcurrentCalls:
type: number
example: 10
callsPerSecond:
type: number
example: 1
cooldowns:
type: object
properties:
calls:
type: number
example: 86400
texts:
type: number
example: 300
defaultRetryConfiguration:
type: object
properties:
goal:
type: object
properties:
completionCriteria:
type: string
example: The contact schedules an appointment.
retryPolicy:
type: object
properties:
delaysSeconds:
type: array
example:
- 86400
- 259200
items:
type: number
retryOn:
type: array
example:
- no_answer
- voicemail
- goal_incomplete
items:
type: string
responseTimeoutSeconds:
type: number
example: 86400
xml:
name: main
application/xml:
schema:
type: object
properties:
success:
type: boolean
example: true
limits:
type: object
properties:
businessHours:
type: object
properties:
timezone:
type: string
example: America/Chicago
windows:
type: array
items:
type: object
properties:
days:
type: array
example:
- 5
items:
type: number
start:
type: string
example: '09:00'
end:
type: string
example: '15:00'
daily:
type: object
properties:
calls:
type: number
example: 100
texts:
type: number
example: 200
tasks:
type: number
example: 300
maxConcurrentCalls:
type: number
example: 10
callsPerSecond:
type: number
example: 1
cooldowns:
type: object
properties:
calls:
type: number
example: 86400
texts:
type: number
example: 300
defaultRetryConfiguration:
type: object
properties:
goal:
type: object
properties:
completionCriteria:
type: string
example: The contact schedules an appointment.
retryPolicy:
type: object
properties:
delaysSeconds:
type: array
example:
- 86400
- 259200
items:
type: number
retryOn:
type: array
example:
- no_answer
- voicemail
- goal_incomplete
items:
type: string
responseTimeoutSeconds:
type: number
example: 86400
xml:
name: main
'401':
description: Unauthorized
'500':
description: Internal Server Error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
