Edit Global Queue Settings

Change the global settings for queues.

Request URL

POST {base_url}/{api_path}/queue_option/update?access_token={access_token}

Request parameters

Parameter Required Type Description
dynamic_agent_default_status No String The default status assigned to dynamic agents when they are newly added to a queue.
Valid value:
  • login: Logged in.
  • logout: Logged out.
enb_honor_wrapup_time No Integer Whether to share break time among queues when an agent belongs to multiple queues.

Valid value:

  • 0: Disable. The break time is only valid for current queue, the agent will still receive calls from other queues during the break time.
  • 1: Enable. After an agent finishes a queue call, the break time of the queue will be shared across all queues, the agent will not receive calls from other queues during this break time.
enb_process_result_sync No Integer Whether to enable automatic synchronization for processing results of repeat calls from the same callers to the same queue within a specified time range.
time_range No Integer The time range (in hours) within which the processing result of repeat calls from the same callers to the same queue will synchronized.
Note: This window is defined as the period of {X} hours leading up to the time when the call processing result is updated. All records within this period will be updated accordingly.

Examples

Request example 1

Enable 'Shared Wrap-up Time Across Multiple Queues' feature.

POST /openapi/v1.0/queue_option/update?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
     "enb_honor_wrapup_time":1
}

Request example 2

Set default status for dynamic agents.

POST /openapi/v1.0/queue_option/update?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
     "dynamic_agent_default_status":"login"
}

Request example 3

Enable auto-sync for processing results of repeat calls.

POST /openapi/v1.0/queue_option/update?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "enb_process_result_sync":1,
    "time_range":8
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}