Users
Get Breaks
Returns all breaks configured in your account.
When to use. Look up the available break types, for example to map break IDs to names when reading break sessions from GET /users/user-breaks/....
Returns. { "breaks": [ { "id": 2, "name": "...", "dtmf": "...", "is_active": 1, "is_global_default": 0 } ] }.
get/{sub_domain}/api/users/breaks
Request
- Base URLhttps://api.commpeak.com/dialer
- URLhttps://api.commpeak.com/dialer/{sub_domain}/api/users/breaks
- AuthAPI key in header Authorization
Path parameters
sub_domainstring required
Dialer Name (subdomain)
Response
Successful Response
Example response
{
"breaks": [
{
"dtmf": 1,
"id": 1,
"is_active": 1,
"is_global_default": 1,
"name": "Online"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.