PATCH /api/v2/callcenters/{id}

Updates a call center by id.

Requires a company admin API key.

Rate limit: 1200 per minute.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The call center's id.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
routing_options Object No
routing_options.closed Object Yes
routing_options.closed.operator_routing String No

The routing strategy that should be used when dialing operators.

Possible values:

  • "mostskilled"
  • "longestidle"
  • "roundrobin"
  • "fixedorder"
  • "random"
  • "simultaneous"
routing_options.closed.dtmf[] Array No

DTMF menu options.

routing_options.closed.dtmf[].input String No

The DTMF key associated with this menu item. (0-9)

routing_options.closed.dtmf[].options Object No
routing_options.closed.dtmf[].options.action String No

The routing action type.

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.closed.dtmf[].options.action_target_type String No

The type of the target that should be dialed.

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
routing_options.closed.dtmf[].options.action_target_id Integer No

The ID of the target that should be dialed.

routing_options.closed.action String Yes

The action that should be taken if no operators are available.

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.closed.action_target_type String No

The type of the Target that inbound calls should be routed to.

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
routing_options.closed.try_dial_operators Boolean Yes

Whether operators should be dialed on inbound calls.

routing_options.closed.action_target_id Integer No

The ID of the Target that inbound calls should be routed to.

routing_options.open Object Yes
routing_options.open.operator_routing String No

The routing strategy that should be used when dialing operators.

Possible values:

  • "mostskilled"
  • "longestidle"
  • "roundrobin"
  • "fixedorder"
  • "random"
  • "simultaneous"
routing_options.open.dtmf[] Array No

DTMF menu options.

routing_options.open.dtmf[].input String No

The DTMF key associated with this menu item. (0-9)

routing_options.open.dtmf[].options Object No
routing_options.open.dtmf[].options.action String No

The routing action type.

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.open.dtmf[].options.action_target_type String No

The type of the target that should be dialed.

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
routing_options.open.dtmf[].options.action_target_id Integer No

The ID of the target that should be dialed.

routing_options.open.action String Yes

The action that should be taken if no operators are available.

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.open.action_target_type String No

The type of the Target that inbound calls should be routed to.

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
routing_options.open.try_dial_operators Boolean Yes

Whether operators should be dialed on inbound calls.

routing_options.open.action_target_id Integer No

The ID of the Target that inbound calls should be routed to.

advanced_settings Object No
advanced_settings.auto_call_recording Object No
advanced_settings.auto_call_recording.call_recording_outbound Boolean No

Whether or not outbound calls from this call center get automatically recorded. Default is False.

advanced_settings.auto_call_recording.call_recording_inbound Boolean No

Whether or not inbound calls to this call center get automatically recorded. Default is False.

advanced_settings.auto_call_recording.allow_pause_recording Boolean No

Allow agents to stop/restart a recording during a call. Default is False.

advanced_settings.max_wrap_up_seconds Integer No

Include a post-call wrap-up time before agents can receive their next call. Default is 0.

tuesday_hours[] Array No

The Tuesday hours of operation. Default value is ["08:00", "18:00"].

voice_intelligence Object No
voice_intelligence.auto_start Boolean No

Auto start Vi for this call center. Default is True.

voice_intelligence.allow_pause Boolean No

Allow individual users to start and stop Vi during calls. Default is True.

alerts Object No
alerts.cc_service_level_seconds Integer No

Inbound calls should be answered within how many seconds. Default is 60.

alerts.cc_service_level Integer No

Alert supervisors when the service level drops below how many percent. Default is 95%.

friday_hours[] Array No

The Friday hours of operation. Default value is ["08:00", "18:00"].

monday_hours[] Array No

The Monday hours of operation. To specify when hours_on is set to True. e.g. ["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is ["08:00", "18:00"].

group_description String No

The description of the call center. Max 256 characters.

name String No

[single-line only]

The name of the call center. Max 100 characters.

hours_on Boolean No

The time frame when the call center wants to receive calls. Default value is false, which means the call center will always take calls (24/7).

thursday_hours[] Array No

The Thursday hours of operation. Default value is ["08:00", "18:00"].

saturday_hours[] Array No

The Saturday hours of operation. Default is empty array.

ring_seconds Integer No

The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds.

hold_queue Object No
hold_queue.queue_callback_threshold Integer No

Allow callers to request a callback when the queue has more than this number of calls. Default is 5.

hold_queue.allow_queue_callback Boolean No

Whether or not to allow callers to request a callback. Default is False.

hold_queue.queue_escape_dtmf String No

Allow callers to exit the hold queue to voicemail by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is *.

hold_queue.announce_position Boolean No

Whether or not to let callers know their place in the queue. This option is not available when a maximum queue wait time of less than 2 minutes is selected. Default is True.

hold_queue.max_hold_seconds Integer No

Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min).

hold_queue.max_hold_count Integer No

If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-1000. Default is 50.

hold_queue.queue_callback_dtmf String No

Allow callers to request a callback when the queue has more than queue_callback_threshold number of calls by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is 9.

hold_queue.unattended_queue Boolean No

Whether or not to allow callers to be placed in your hold queue when no agents are available. Default is False.

hold_queue.stay_in_queue_after_closing Boolean No

Whether or not to allow existing calls to stay in queue after the call center has closed. Default is False.

hold_queue.announcement_interval_seconds Integer No

Hold announcement interval wait time. Default is 2 min.

sunday_hours[] Array No

The Sunday hours of operation. Default is empty array.

wednesday_hours[] Array No

The Wednesday hours of operation. Default value is ["08:00", "18:00"].

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.