vocapableCreate a queue (CC1-R1)
const url = 'https://api.vocapable.com/v1/workspace/contact-center/queues';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","description":"example","priority":5,"strategy":"longest_idle","aging_seconds":60,"steps":[{"after_seconds":1,"requirements":[{"skill_id":"example","min_proficiency":1,"negate":false}],"include_queue_ids":["example"],"any_of":[{"alternatives":[[{"skill_id":"example","min_proficiency":1,"negate":false}]]}],"include_ai":false}],"overflow_queue_id":"example","overflow_after_seconds":1,"sticky_mode":"off","sticky_timeout_seconds":20,"vip_rules":[{"field":"tag","key":"example","value":"example","priority_boost":0,"requirements":[{"skill_id":"example","min_proficiency":1,"negate":false}],"label":"VIP","conditions":[{"field":"tag","key":"example","value":"example"}],"match":"all"}],"entry_rule":{"field":"tag","key":"example","value":"example"},"sla_percent":80,"sla_seconds":20,"short_abandon_seconds":5,"max_wait_seconds":600,"max_callers":1,"announce_ewt":true,"callback_ewt_seconds":120,"ai_after_seconds":1,"ai_capacity":1,"ai_overflow_ewt_seconds":1,"humans_only":false,"auto_answer_allowed":true,"team_id":"example","acw_seconds":1,"strict":false,"member_user_ids":["example"],"member_team_ids":["example"],"member_priorities":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.vocapable.com/v1/workspace/contact-center/queues \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "description": "example", "priority": 5, "strategy": "longest_idle", "aging_seconds": 60, "steps": [ { "after_seconds": 1, "requirements": [ { "skill_id": "example", "min_proficiency": 1, "negate": false } ], "include_queue_ids": [ "example" ], "any_of": [ { "alternatives": [ [ { "skill_id": "example", "min_proficiency": 1, "negate": false } ] ] } ], "include_ai": false } ], "overflow_queue_id": "example", "overflow_after_seconds": 1, "sticky_mode": "off", "sticky_timeout_seconds": 20, "vip_rules": [ { "field": "tag", "key": "example", "value": "example", "priority_boost": 0, "requirements": [ { "skill_id": "example", "min_proficiency": 1, "negate": false } ], "label": "VIP", "conditions": [ { "field": "tag", "key": "example", "value": "example" } ], "match": "all" } ], "entry_rule": { "field": "tag", "key": "example", "value": "example" }, "sla_percent": 80, "sla_seconds": 20, "short_abandon_seconds": 5, "max_wait_seconds": 600, "max_callers": 1, "announce_ewt": true, "callback_ewt_seconds": 120, "ai_after_seconds": 1, "ai_capacity": 1, "ai_overflow_ewt_seconds": 1, "humans_only": false, "auto_answer_allowed": true, "team_id": "example", "acw_seconds": 1, "strict": false, "member_user_ids": [ "example" ], "member_team_ids": [ "example" ], "member_priorities": {} }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Everything an owner edits on a queue. Defaults are the PRD’s (SL 80/20, short abandon 5 s, priority 5, aging +1/60 s, longest idle, callback offered at EWT > 2 min).
object
A bullseye ring: from after_seconds into the wait, the FULL requirement - the
plain requirements (all must hold) AND every any_of group - plus overflow
queues whose members join the pool from this step on (CC1-R2/R3). At most 20 skill
terms in all; POST …/requirements/parse turns the text form into this shape.
object
skill >= min_proficiency; negate: the agent must NOT hold it at that level.
object
An OR group (CC1-R2): at least one alternative holds; each alternative is the AND
of its terms. (Spanish>=3 OR Portuguese>=3) is two one-term alternatives.
object
CC1-R5: a matching caller is lifted (+1..+5) and/or needs skills. More
conditions (≤ 4) combine with the rule’s own by match: all (AND) or any
(OR), e.g. account.industry = "Healthcare" OR open_case.urgency = "urgent".
object
skill >= min_proficiency; negate: the agent must NOT hold it at that level.
object
object
Responses
Section titled “Responses”Successful Response
object
A bullseye ring: from after_seconds into the wait, the FULL requirement - the
plain requirements (all must hold) AND every any_of group - plus overflow
queues whose members join the pool from this step on (CC1-R2/R3). At most 20 skill
terms in all; POST …/requirements/parse turns the text form into this shape.
object
skill >= min_proficiency; negate: the agent must NOT hold it at that level.
object
An OR group (CC1-R2): at least one alternative holds; each alternative is the AND
of its terms. (Spanish>=3 OR Portuguese>=3) is two one-term alternatives.
object
CC1-R5: a matching caller is lifted (+1..+5) and/or needs skills. More
conditions (≤ 4) combine with the rule’s own by match: all (AND) or any
(OR), e.g. account.industry = "Healthcare" OR open_case.urgency = "urgent".
object
skill >= min_proficiency; negate: the agent must NOT hold it at that level.
object
object
object
A bullseye ring: from after_seconds into the wait, the FULL requirement - the
plain requirements (all must hold) AND every any_of group - plus overflow
queues whose members join the pool from this step on (CC1-R2/R3). At most 20 skill
terms in all; POST …/requirements/parse turns the text form into this shape.
object
skill >= min_proficiency; negate: the agent must NOT hold it at that level.
object
An OR group (CC1-R2): at least one alternative holds; each alternative is the AND
of its terms. (Spanish>=3 OR Portuguese>=3) is two one-term alternatives.
object
Example
{ "priority": 5, "strategy": "longest_idle", "aging_seconds": 60, "steps": [ { "requirements": [ { "negate": false } ], "any_of": [ { "alternatives": [ [ { "negate": false } ] ] } ], "include_ai": false } ], "sticky_mode": "off", "sticky_timeout_seconds": 20, "vip_rules": [ { "field": "tag", "priority_boost": 0, "requirements": [ { "negate": false } ], "label": "VIP", "conditions": [ { "field": "tag" } ], "match": "all" } ], "entry_rule": { "field": "tag" }, "sla_percent": 80, "sla_seconds": 20, "short_abandon_seconds": 5, "max_wait_seconds": 600, "announce_ewt": true, "callback_ewt_seconds": 120, "humans_only": false, "auto_answer_allowed": true, "strict": false, "members": [ { "priority": 5 } ], "effective_steps": [ { "requirements": [ { "negate": false } ], "any_of": [ { "alternatives": [ [ { "negate": false } ] ] } ], "include_ai": false } ]}Validation Error
object
object
object
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}