COconnexcs
Class 5 Call Center

Read

Changed on

Retrieve a single Class 5 Call Center record by ID.

get/api/cp/class5/call-center/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Response

Successful response

idstring

Id

account_idinteger

Account Id (references account.id)

company_idinteger

Company Id

pbx_serverstring

Pbx Server

c4_serverstring

C 4 Server

namestring

Name

deststring

Dest

strategy'ring-all' | 'longest-idle-agent' | 'round-robin' | 'top-down' | 'agent-with-least-talk-time' | 'agent-with-fewest-calls' | 'sequentially-by-agent-order' | 'random' | 'ring-progressively'

Strategy

moh_soundstring

Moh Sound

record_templatestring

Record Template

time_base_score'system' | 'queue'

Time Base Score

max_wait_timeinteger

Max Wait Time

max_wait_time_with_no_agentinteger

Max Wait Time With No Agent

max_wait_time_with_no_agent_time_reachedinteger

Max Wait Time With No Agent Time Reached

agent_no_answer_status'Available' | 'Available (On Demand'

Agent No Answer Status

tier_rules_applyinteger

Tier Rules Apply

tier_rule_wait_secondinteger

Tier Rule Wait Second

tier_rule_wait_multiply_levelinteger

Tier Rule Wait Multiply Level

tier_rule_no_agent_no_waitinteger

Tier Rule No Agent No Wait

discard_abandoned_afterinteger

Discard Abandoned After

abandoned_resume_allowedinteger

Abandoned Resume Allowed

failover_deststring

Failover Dest

failover_dest_type'internal' | 'external'

Failover Dest Type

created_atstring date-time

Created At

updated_atstring date-time

Updated At

Example response

{
  "id": 12345,
  "account_id": 1,
  "company_id": 1,
  "pbx_server": "example_pbx_server",
  "c4_server": "example_c4_server",
  "name": "Example Name",
  "dest": "example_dest",
  "strategy": "ring-all",
  "moh_sound": "example_moh_sound",
  "record_template": "example_record_template",
  "time_base_score": "system",
  "max_wait_time": 123,
  "max_wait_time_with_no_agent": 123,
  "max_wait_time_with_no_agent_time_reached": 123,
  "agent_no_answer_status": "Available",
  "tier_rules_apply": 1,
  "tier_rule_wait_second": 123,
  "tier_rule_wait_multiply_level": 1,
  "tier_rule_no_agent_no_wait": 1,
  "discard_abandoned_after": 123,
  "abandoned_resume_allowed": 1,
  "failover_dest": "example_failover_dest",
  "failover_dest_type": "internal",
  "created_at": "2025-01-17T10:30:00Z",
  "updated_at": "2025-01-17T10:30:00Z"
}

Changes

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API