COconnexcs
Class 5 Group

Update

Changed on

Update an existing Class 5 Group record by ID.

put/api/cp/class5/group/{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

Request body

idinteger

Id

account_idinteger

Account Id (references account.id)

customer_idinteger

Customer Id

namestring required

Name

deststring

Dest

agent_login_deststring

Agent Login Dest

agent_logout_deststring

Agent Logout Dest

agent_offhook_deststring

Agent Offhook Dest

distribution_method'parallel' | 'sequential' | 'queue'

Distribution Method

server_affinitystring

Server Affinity

on_hold_musicstring

On Hold Music

join_messagestring

Join Message

chime_liststring

Chime List

chime_intervalinteger

Chime Interval

pbx_serverstring

Pbx Server

Example request

{
  "id": 12345,
  "account_id": 1,
  "customer_id": 1,
  "name": "Example Name",
  "dest": "example_dest",
  "agent_login_dest": "example_agent_login_dest",
  "agent_logout_dest": "example_agent_logout_dest",
  "agent_offhook_dest": "example_agent_offhook_dest",
  "distribution_method": "parallel",
  "server_affinity": "example_server_affinity",
  "on_hold_music": "example_on_hold_music",
  "join_message": "example_join_message",
  "chime_list": "example_chime_list",
  "chime_interval": 1,
  "pbx_server": "example_pbx_server"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

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