Sample Request

curl --request POST \
     --url https://api-account-uk.acefone.com/v1/department \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "ring_strategy": "simultaneous"
}
'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Body Params)

The following parameter is required to create a new department:

Variable Name	Description	Data Type
name*	Name for department.	String
description*	Description for department.	String
ring_strategy*	Order in which the agents under this department will receive calls.	String
timeout_dest_type	Destination type where the call lands in case of timeout.	String
timeout	Time in seconds for which the call tries to connect for each agent in this department.	Array of strings
destination	Number of the agent in the department where the call should land. Example: extension\|eid, eid: agents's eid eg: 050160000	Array of strings

Allowed Ring Strategies


Name	Description
simultaneous	Calls will ring one after the other.
order_by	Calls will ring in an order or sequence in which agents are added.
random	Calls ring agents in random order.
round_robin	Round Robin with memory, remember where we left off last ring pass.

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
Success	The request success status, the possible values are: True (default) for success. False for failure.	Boolean
Message	The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.	String