Sign in
Class 5 Group

Create

Create a new Class 5 Group record.

post/api/cp/class5/group

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

Successful response

statusstring

Operation status

Example response

{
  "id": 12345,
  "status": "OK"
}

Changes