Edit a Queue

Configure the settings of a queue, such as queue name, ring strategy, etc.

Endpoint

POST /api/v1.1.0/queue/update?token={token}

Request Parameters


Name	Importance	Type	Description
`queueid`	Required	Int	The requested queue number.
`queuenumber`	Optional	Int	The queue number.
`queuename`	Optional	String	The queue number.
`password`	Optional	String	The password to join dynamic agent.
`ringstrategy`	Optional	String	The ring strategy. Ring All Least Recent Fewest Calls Random Rrmemory Linear
`failoveraction`	Optional	String	The failover destination. Hangup Extension Voicemail IVR Ring Group Queue Conference Fax to Email Dial by name
`failoverdest`	Optional	String	The failover destination.
`agents`	Optional	String	Static agents.
`dynamicagents`	Optional	String	Dynamic agents.
`agenttimeout`	Optional	String	The agent timeout. Options: 10, 20, 30, 40, 50
`wrapuptime`	Optional	Int	The wrap-up time. Options: 10, 20, 30, 40, 50
`ringinuse`	Optional	String	Ring the members whose device are known to be “in use”. on: enable off: disable
`retry`	Optional	Int	The number of seconds to wait before trying all the phones again. Options: 10, 20, 30, 40, 50
`maxwaittime`	Optional	Int	The caller max wait time. Options: 300, 600, 900, 1200, 1800
`joinempty`	Optional	String	Allow callers to join a queue that has no agents. on: enable off: disable
`leavewhenempty`	Optional	String	Callers already on hold will be forced out of a queue when no agents are available. on: enable off: disable
`announcepos`	Optional	String	Announce position of caller in the queue. on: enable off: disable
`announcefreq`	Optional	String	How often to announce queue position and estimated hold time. Options: 0, 15, 30, 45, 60, 120, 180, 240, 300, 600, 1200
`announceholdtime`	Optional	Int	Announce the hold time to the caller periodically. on: enable off: disable
`userannouncefreq`	Optional	Int	How often to play the periodic announcements. Options: 0, 15, 30, 45, 60, 120, 180, 240, 300, 600, 1200
`breakoutkey`	Optional	String	The breakout key. Options: None, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #
`breakoutaction`	Optional	String	The breakout action. Hang up Extension Voicemail IVR Ring Group Queue Conference Fax to Email Dial by Name
`breakoutdest`	Optional	String	The breakout destination.
`idannouncement`	Optional	String	The file name of the prompt that announces the agent ID. It is "None" by default. Note: When querying one or more queues, this parameter is bound to return value(s).
`satisfactionsurvey`	Optional	String	The file name of the prompt for customer satisfaction survey. It is "None" by default. If it is not specified, the prompt will not be played.

Examples

Request Example

Modify the queue number.

POST /api/v1.1.0/queue/update?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "queueid": "6701",
    "queuenumber": "6702"
}

Response Example

HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success"
}