--- title: "Update a call queue" method: POST path: "/call_queues/{id}" tags: ["Call Queue"] --- # Update a call queue `POST /call_queues/{id}` Update call queue properties by it's unique ID. ## Path parameters - `id` string, required — The unique ID of the resource. ## Request body - object - `name` string — The name of call queue. - `polling_strategy` 'RING_SIMULTANEOUSLY' | 'PRIORITIZED_HUNT' | 'CYCLIC_HUNT' | 'LEAST_WORKED_HUNT' | 'SKILL_BASED_ROUTING_PRIORITIZED_HUNT' | 'SKILL_BASED_ROUTING_CYCLIC_HUNT' | 'SKILL_BASED_ROUTING_LEAST_WORKED_HUNT' — Polling strategy: Can be either: - `RING_SIMULTANEOUSLY`: Ring all available agents of the queue simultaneously. - `PRIORITIZED_HUNT`: Ring each available agent of the queue serially in the configured order. - `CYCLIC_HUNT`: Ring each available agent of the queue serially, ring the agent that hasn't been rang from a call from this queue in the longest amount of time first. - `LEAST_WORKED_HUNT`: Ring each available agent of the queue serially, ring the agent that hasn't answered a call from this queue in the longest amount of time first. - `SKILL_BASED_ROUTING_PRIORITIZED_HUNT`: The call assign to the agents in the level "1" skill group first, and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group. Ring each available agent of the queue serially in the configured order. - `SKILL_BASED_ROUTING_CYCLIC_HUNT`: The call assign to the agents in the level "1" skill group first, and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group. Ring each available agent of the queue serially, ring the agent that hasn't been rang from a call from this queue in the longest amount of time first. - `SKILL_BASED_ROUTING_LEAST_WORKED_HUNT`: The call assign to the agents in the level "1" skill group first, and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group. Ring each available agent of the queue serially, ring the agent that hasn't answered a call from this queue in the longest amount of time first. - `ring_time` integer — Duration that each extension will ring, in seconds. - `max_callers` integer — The maximum number of callers allowed in queue. - `moh_prompt_file_id` string — The unique ID of the resource. - `intro_type` 'DISABLE' | 'NORMAL' | 'FULL' — Introductory tone: - `DISABLE`: disable introductory tone - `NORMAL`: play normal introductory tone. - `FULL`: play full introductory tone. - `intro_prompt_file_id` string — The unique ID of the resource. - `max_waiting_time` integer — The maximum time limit for waiting in the queue, in seconds. After this time interval, the call will be handled as pre-configured. - `wait_when_no_agents_online` boolean — Queue will waiting when no agent online. - `inform_position` 'DISABLE' | 'PERIODICALLY' | 'ON_CONNECTED' — Queue will announce the actual position of the caller who's currently waiting in the queue. Callback mode can be either: - `DISABLE`: Disable informing waiting position. - `PERIODICALLY`: Inform waiting position periodically. - `ON_CONNECTED`: Inform waiting position once caller connected and then play periodically. - `inform_position_interval` integer — Time interval for repeating announcement of the waiting position, in seconds. This parameter will be available only if `inform_position` is `PERIODICALLY` or `ON_CONNECTED`. - `agent_auto_ready` boolean — Automatically set agent status to `Ready` after logging in to a queue or completing a call (ACD call or non AC call). - `agent_auto_not_ready_after_non_acd_call` boolean — Automatically set agent status to `Not Ready` after completing a non-ACD call. This option will be ignored if `agent_auto_ready` is enabled. - `sla_time` integer — The SLA time of call queue in seconds. - `language` string — BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US. - `no_answer_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: - `FORWARD_TO_VOICEMAIL`: - `HANGUP`: finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `enable_callback` boolean — Enable callback feature or not. - `callback_mode` 'ACTIVE' | 'TIMEOUT' — Callback mode includes: - `ACTIVE`: Triggered on user request (Press 3). - `TIMEOUT`: Offered to caller after timeout. - `callback_timeout` integer — Offered to caller after timeout in seconds. - `callback_outbound_prefix` string — Callback outbound prefix. - `outbound_caller_ids` object[] — A collection of outbound caller IDs. - `provider_id` string — The unique ID of the resource. - `caller_id` string — Outbound caller id. - `description` string — The descriptive information about this outbound caller id. - `enable_sticky_routing` boolean — When a customer calls the queue, if the customer has communicated with an agent before and the agent is currently in the ready state, then this agent will have priority to answer the call. - `sticky_routing_duration` integer — The duration of sticky routing in days. - `enable_paid` boolean — Whether to add call queue information into `P-Asserted-Identity` header. - `enable_prid` boolean — Whether to add call queue information into `Remote-Party-ID` header. - `extension_number_as_to_header` boolean — Whether to user extension number as invite `To` header. ## Response `200` OK ## Other responses - `4XX` — Error --- [API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)