Rate this page:

SmartQueue

Methods

GetSmartQueueRealtimeMetrics

Copy URL

Gets the metrics for the specified smart queue for the last 30 minutes.

GetSmartQueueRealtimeMetrics example

GetSmartQueueRealtimeMetrics example

Get the time agents spent in the DIALING status for all smart queues within one application.

Parameters

  • application_id:

    number

    The application ID

  • application_name:

    string

    The application name which a new user will be bound to. Can be used instead of the application_id parameter

  • user_id:

    intlist

    Optional

    The user ID list with a maximum of 5 values separated by the ';' symbol. Use the 'all' value to select all users. Can operate as a filter for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • user_name:

    stringlist

    Optional

    The user name list separated by the ';' symbol. user_name can be used instead of user_id

  • sq_queue_id:

    intlist

    Optional

    The smart queue ID list with a maximum of 5 values separated by the ';' symbol. Can operate as filter for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • sq_queue_name:

    stringlist

    Optional

    The smart queue name list separated by the ';' symbol. Can be used instead of sq_queue_id

  • from_date:

    timestamp

    Optional

    The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 30 minutes

  • to_date:

    timestamp

    Optional

    The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time

  • timezone:

    string

    Optional
    Defaults on:  UTC

    The selected timezone or the 'auto' value (the account location)

  • interval:

    string

    Optional
    Defaults on:  0-0-0 0:30:0

    Interval format: YYYY-MM-DD HH:mm:ss. Default is 30 minutes

  • report_type:

    stringlist

    The report type. Possible values are calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_time_in_queue,max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime

  • group_by:

    string

    Optional

    Group the result by agent or queue. The agent grouping is allowed for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The queue grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • max_waiting_sec:

    number

    Optional

    Maximum waiting time. Required for the service_level report type

Returns

  • result:

    [SmartQueueMetricsResult]

  • timezone:

    string

    The used timezone, e.g., 'Etc/GMT'

GetSmartQueueDayHistory

Copy URL

Gets the metrics for the specified smart queue for the last 2 days.

GetSmartQueueDayHistory example

GetSmartQueueDayHistory example

Get the time agents spent in the ONLINE status for all smart queues within one application.

Parameters

  • application_id:

    number

    The application ID

  • application_name:

    string

    The application name which a new user will be bound to. Can be used instead of the application_id parameter

  • user_id:

    intlist

    Optional

    The user ID list with a maximum of 5 values separated by the ';' symbol. Use the 'all' value to select all users. Can operate as a filter for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • user_name:

    stringlist

    Optional

    The user name list separated by the ';' symbol. user_name can be used instead of user_id

  • sq_queue_id:

    intlist

    The smart queue ID list with a maximum of 5 values separated by the ';' symbol. Can operate as filter for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • sq_queue_name:

    stringlist

    Optional

    The smart queue name list separated by the ';' symbol. Can be used instead of sq_queue_id

  • from_date:

    timestamp

    Optional

    The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 1 day

  • to_date:

    timestamp

    Optional

    The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time

  • timezone:

    string

    Optional
    Defaults on:  UTC

    The selected timezone or the 'auto' value (the account location)

  • interval:

    string

    Optional
    Defaults on:  0-0-1 0:0:0

    Interval format: YYYY-MM-DD HH:mm:ss. Default is 1 day

  • report_type:

    stringlist

    The report type. Possible values are calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_time_in_queue,max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime

  • group_by:

    string

    Optional

    Group the result by agent or queue. The agent grouping is allowed only for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The queue grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • max_waiting_sec:

    number

    Optional

    Maximum waiting time. Required for the service_level report type

Returns

  • result:

    [SmartQueueMetricsResult]

  • timezone:

    string

    The used timezone, e.g., 'Etc/GMT'

RequestSmartQueueHistory

Copy URL

Gets history for the specified smart queue.

RequestSmartQueueHistory example

RequestSmartQueueHistory example

Generate a service_level report file in csv format for the period from 2021-03-17 00:00:00 to 2021-03-17 22:00:00.

Parameters

  • application_id:

    number

    The application ID

  • application_name:

    string

    The application name which a new user will be bound to. Can be used instead of the application_id parameter

  • user_id:

    intlist

    Optional

    The user ID list with a maximum of 5 values separated by the ';' symbol. Use the 'all' value to select all users. Can operate as a filter for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • user_name:

    stringlist

    Optional

    The user name list separated by the ';' symbol. Can be used instead of user_id

  • sq_queue_id:

    intlist

    The smart queue ID list with a maximum of 5 values separated by the ';' symbol. Can operate as filter for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • sq_queue_name:

    stringlist

    Optional

    The smart queue name list separated by the ';' symbol. Can be used instead of sq_queue_id

  • from_date:

    timestamp

    The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 1 day

  • to_date:

    timestamp

    The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time

  • timezone:

    string

    Optional
    Defaults on:  UTC

    The selected timezone or the 'auto' value (the account location)

  • interval:

    string

    Optional
    Defaults on:  0-0-1 0:0:0

    Interval format: YYYY-MM-DD HH:mm:ss. Default is 1 day

  • report_type:

    stringlist

    The report type. Possible values are calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_time_in_queue,max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime

  • group_by:

    string

    Optional

    Group the result by agent or queue. The agent grouping is allowed only for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The queue grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types

  • max_waiting_sec:

    number

    Optional

    Maximum waiting time. Required for the service_level report type

Returns

  • result:

    number

    1

  • history_report_id:

    number

    History report ID

GetSQState

Copy URL

Gets the current state of the specified smart queue.

GetSQState example

GetSQState example

Gets the current state of the smart queue with id = 1.

Parameters

  • application_id:

    number

    The application ID

  • application_name:

    string

    Optional

    The application name which a new user will be bound to. Can be used instead of the application_id parameter

  • sq_queue_id:

    intlist

    The smart queue ID list separated by the ';' symbol. Use the 'all' value to select all smart queues

  • sq_queue_name:

    stringlist

    Optional

    The smart queue name list separated by the ';' symbol. Can be used instead of sq_queue_id

  • timezone:

    string

    Optional
    Defaults on:  UTC

    The selected timezone or the 'auto' value (the account location)

Returns

  • result:

    [SmartQueueState]

SQ_AddQueue

Copy URL

Adds a new queue.

SQ_AddQueue example

SQ_AddQueue example

Add a new queue.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_queue_name:

    string

    Unique smart queue name within the application, up to 100 characters

  • call_agent_selection:

    [SQAgentSelectionStrategies]

    Agent selection strategy for calls

  • im_agent_selection:

    [SQAgentSelectionStrategies]

    Optional

    Agent selection strategy for messages. Equals to the call_agent_selection value by default

  • call_task_selection:

    [SQTaskSelectionStrategies]

    Strategy of prioritizing CALL-type requests for service

  • im_task_selection:

    [SQTaskSelectionStrategies]

    Optional

    Strategy of prioritizing IM-type requests for service. Equals to the call_task_selection value by default

  • description:

    string

    Optional

    Comment, up to 200 characters

  • call_max_waiting_time:

    number

    Optional
    Defaults on:  120

    Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent

  • im_max_waiting_time:

    number

    Optional
    Defaults on:  120

    Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent

  • call_max_queue_size:

    number

    Optional
    Defaults on:  1000

    Maximum size of the queue with CALL-type requests

  • im_max_queue_size:

    number

    Optional
    Defaults on:  1000

    Maximum size of the queue with IM-type requests

Returns

  • sq_queue_id:

    number

    ID of the added queue

SQ_SetQueueInfo

Copy URL

Edits an existing queue.

SQ_SetQueueInfo example

SQ_SetQueueInfo example

Edit the queue with id = 1.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_queue_id:

    number

    ID of the smart queue to search for

  • sq_queue_name:

    string

    Optional

    Name of the smart queue. Can be used instead of sq_queue_id

  • new_sq_queue_name:

    string

    Optional

    New smart queue name within the application, up to 100 characters

  • call_agent_selection:

    [SQAgentSelectionStrategies]

    Optional

    Agent selection strategy for calls

  • im_agent_selection:

    [SQAgentSelectionStrategies]

    Optional

    Agent selection strategy for messages. Equals to the call_agent_selection value by default

  • call_task_selection:

    [SQTaskSelectionStrategies]

    Optional

    Strategy of prioritizing CALL-type requests for service

  • im_task_selection:

    [SQTaskSelectionStrategies]

    Optional

    Strategy of prioritizing IM-type requests for service. Equals to the call_task_selection value by default

  • description:

    string

    Optional

    Comment, up to 200 characters

  • call_max_waiting_time:

    number

    Optional
    Defaults on:  120

    Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent

  • im_max_waiting_time:

    number

    Optional
    Defaults on:  120

    Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent

  • call_max_queue_size:

    number

    Optional
    Defaults on:  1000

    Maximum size of the queue with CALL-type requests

  • im_max_queue_size:

    number

    Optional
    Defaults on:  1000

    Maximum size of the queue with IM-type requests

Returns

  • result:

    number

    1

SQ_DelQueue

Copy URL

Deletes a queue.

SQ_DelQueue example

SQ_DelQueue example

Delete the queue with id = 3.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_queue_id:

    intlist

    List of smart queue IDs separated by the ';' symbol. Use 'all' to delete all the queues

  • sq_queue_name:

    stringlist

    Optional

    List of smart queue names separated by the ';' symbol. Can be used instead of sq_queue_id

Returns

  • result:

    number

    1

SQ_GetQueues

Copy URL

Gets the queue(s).

SQ_GetQueues example

SQ_GetQueues example

Get all the queues.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_queue_id:

    intlist

    Optional

    List of smart queue IDs separated by the ';' symbol

  • sq_queue_name:

    stringlist

    Optional

    List of smart queue names separated by the ';' symbol. Can be used instead of sq_queue_id

  • sq_queue_name_template:

    string

    Optional

    Substring of the smart queue name to filter

  • user_id:

    number

    Optional

    ID of the user that is bound to the queue

  • user_name:

    string

    Optional

    Name of the user that is bound to the queue. Can be used instead of user_id

  • excluded_user_id:

    number

    Optional

    ID of the user that is not bound to the queue

  • excluded_user_name:

    string

    Optional

    Name of the user that is not bound to the queue. Can be used instead of excluded_user_id

  • count:

    number

    Optional
    Defaults on:  20

    Number of items to show in the output

  • offset:

    number

    Optional
    Defaults on:  0

    Number of items to skip in the output

Returns

SQ_AddSkill

Copy URL

Adds a new skill to the app.

SQ_AddSkill example

SQ_AddSkill example

Add a new skill.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_skill_name:

    string

    Unique skill name within the application

  • description:

    string

    Optional

    Comment, up to 200 characters

Returns

  • result:

    number

    1

SQ_DelSkill

Copy URL

Deletes a skill and detaches it from agents.

SQ_DelSkill example

SQ_DelSkill example

Delete the skill with id = 5.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_skill_id:

    intlist

    List of skill IDs separated by the ';' symbol. Use 'all' to delete all the skills

  • sq_skill_name:

    stringlist

    Optional

    List of skill names separated by the ';' symbol. Can be used instead of sq_skill_id

Returns

  • result:

    number

    1

SQ_SetSkillInfo

Copy URL

Edits an existing skill.

SQ_SetSkillInfo example

SQ_SetSkillInfo example

Edit a skill.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_skill_id:

    number

    ID of the skill

  • sq_skill_name:

    string

    Optional

    Name of the skill. Can be used instead of sq_skill_id

  • new_sq_skill_name:

    string

    Optional

    New unique skill name within the application

  • description:

    string

    Optional

    Comment, up to 200 characters

Returns

  • result:

    number

    1

SQ_BindSkill

Copy URL

Binds skills to agents.

SQ_BindSkill example

SQ_BindSkill example

Bind the skills with id 1 and 2 to all users.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • user_id:

    intlist

    List of user IDs separated by the ';' symbol. Use 'all' to select all the users

  • user_name:

    stringlist

    Optional

    List of user names separated by the ';' symbol. Can be used instead of user_id

  • sq_skills:

    Object

    Skills to be bound to agents in the json array format. The array should contain objects with the sq_skill_id/sq_skill_name and sq_skill_level keys where skill levels range from 1 to 5

  • Optional
    Defaults on:  add

    Binding mode

Returns

  • result:

    number

    1

SQ_UnbindSkill

Copy URL

Unbinds skills from agents.

SQ_UnbindSkill example

SQ_UnbindSkill example

Unbind the skill with id = 1 from the user with id = 1.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • user_id:

    intlist

    List of user IDs separated by the ';' symbol. Use 'all' to select all the users

  • user_name:

    stringlist

    Optional

    List of user names separated by the ';' symbol. Can be used instead of user_id

  • sq_skill_id:

    intlist

    List of skill IDs separated by the ';' symbol. Use 'all' to undbind all the skills

  • sq_skill_name:

    stringlist

    Optional

    List of skill names separated by the ';' symbol. Can be used instead of sq_skill_id

Returns

  • result:

    number

    1

SQ_GetSkills

Copy URL

Gets the skill(s).

SQ_GetSkills example

SQ_GetSkills example

Get the skills with id 2 and 4

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • user_id:

    intlist

    Optional

    List of user IDs separated by the ';' symbol

  • user_name:

    stringlist

    Optional

    List of user names separated by the ';' symbol. Can be used instead of user_id

  • sq_skill_id:

    intlist

    Optional

    List of skill IDs separated by the ';' symbol

  • sq_skill_name:

    stringlist

    Optional

    List of skill names separated by the ';' symbol. Can be used instead of sq_skill_id

  • sq_skill_name_template:

    string

    Optional

    Substring of the skill name to filter, case-insensitive

  • excluded_user_id:

    number

    Optional

    ID of the user that is not bound to the skill

  • excluded_user_name:

    string

    Optional

    Name of the user that is not bound to the skill. Can be used instead of excluded_user_id

  • count:

    number

    Optional
    Defaults on:  20

    Number of items to show in the output

  • offset:

    number

    Optional
    Defaults on:  0

    Number of items to skip in the output

Returns

SQ_BindAgent

Copy URL

Binds agents to a queue.

SQ_BindAgent example

SQ_BindAgent example

Bind the agent with id 1 and 2 to the queue with id = 1.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_queue_id:

    number

    ID of the smart queue

  • sq_queue_name:

    string

    Optional

    Name of the smart queue

  • user_id:

    intlist

    List of user IDs separated by the ';' symbol. Use 'all' to select all the users

  • user_name:

    stringlist

    Optional

    List of user names separated by the ';' symbol. Can be used instead of user_id

  • Optional
    Defaults on:  add

    Binding mode

Returns

  • result:

    number

    1

SQ_UnbindAgent

Copy URL

Unbinds agents from queues.

SQ_UnbindAgent example

SQ_UnbindAgent example

Unbind the agent with id 1 from all queues.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_queue_id:

    intlist

    List of smart queue IDs separated by the ';' symbol. Use 'all' to select all the queues

  • sq_queue_name:

    stringlist

    Optional

    List of smart queue names separated by the ';' symbol. Can be used instead of sq_queue_id

  • user_id:

    intlist

    List of user IDs separated by the ';' symbol. Use 'all' to select all the users

  • user_name:

    stringlist

    Optional

    List of user names separated by the ';' symbol. Can be used instead of user_id

Returns

  • result:

    number

    1

SQ_GetAgents

Copy URL

Gets agents.

SQ_GetAgents example

SQ_GetAgents example

Get all agents with their current statuses.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • sq_queue_id:

    intlist

    Optional

    List of smart queue IDs separated by the ';' symbol. Use 'all' to select all the queues

  • sq_queue_name:

    stringlist

    Optional

    List of smart queue names separated by the ';' symbol. Can be used instead of sq_queue_id

  • excluded_sq_queue_id:

    number

    Optional

    ID of the smart queue to exclude

  • excluded_sq_queue_name:

    string

    Optional

    Name of the smart queue to exclude. Can be used instead of excluded_sq_queue_id

  • sq_skills:

    Object

    Optional

    Skills to filter in the json array format. The array should contain objects with the sq_skill_id/sq_skill_name, min_sq_skill_level, and max_sq_skill_level keys where skill levels range from 1 to 5

  • user_id:

    intlist

    Optional

    List of user IDs separated by the ';' symbol

  • user_name:

    stringlist

    Optional

    List of user names separated by the ';' symbol. Can be used instead of user_id

  • user_name_template:

    string

    Optional

    Substring of the user name to filter

  • sq_statuses:

    Object

    Optional

    Filter statuses in the json array format. The array should contain objects with the sq_status_type and sq_status_name keys. Possible values for sq_status_type are 'CALL' and'IM'. Possible values for sq_status_name are 'OFFLINE', 'ONLINE', 'READY', 'IN_SERVICE', 'AFTER_SERVICE', 'DND'

  • with_sq_skills:

    boolean

    Optional
    Defaults on:  false

    Display agent skills

  • with_sq_queues:

    boolean

    Optional
    Defaults on:  false

    Display agent queues

  • with_sq_statuses:

    boolean

    Optional
    Defaults on:  false

    Display agent current statuses

  • count:

    number

    Optional
    Defaults on:  20

    Number of items to show in the output

  • offset:

    number

    Optional
    Defaults on:  0

    Number of items to skip in the output

Returns

SQ_SetAgentInfo

Copy URL

Edits the agent settings.

SQ_SetAgentInfo example

SQ_SetAgentInfo example

Edit settings of the agent with id = 2.

Parameters

  • application_id:

    number

    ID of the application

  • application_name:

    string

    Optional

    Name of the application. Can be used instead of application_id

  • user_id:

    intlist

    List of user IDs separated by the ';' symbol. Use 'all' to select all the users

  • user_name:

    stringlist

    Optional

    List of user names separated by the ';' symbol. Can be used instead of user_id

  • max_simultaneous_conversations:

    number

    Optional
    Defaults on:  5

    Maximum number of chats that the user processes simultaneously

  • handle_calls:

    boolean

    The agent can handle calls. When set to false, the agent is excluded from the CALL-request distribution

Returns

  • result:

    number

    1