Create a new call group

This action will create a new call group for a given unit

Try this request in your browser

/api/ /call_groups/create

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

unit_id Integer
name String
noanswer_timeout Integer
noanswer_destination_id
noanswer_destination_type
paging_enabled Boolean
pickup_group_id Integer
members Array

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/call_groups/create

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

unit_id

The ID of the unit

Integer null

name

The name of the call group

String null

noanswer_timeout

The length of time the group should ring before being directed to no answer destination (in seconds)

Integer null

noanswer_destination_id

null

noanswer_destination_type

null

paging_enabled

Is paging enabled for this call group?

Boolean null

pickup_group_id

The id of the pickup group

Integer null

members

An array of all members for this object

Array null

Errors

Error Attributes

UnitNotFound

The given unit was not found

  • id

    The provided ID

InvalidPickupGroup

The pickup group provided was invalid

  • id

    The id that was looked up

InvalidMembers

The members array provided was not valid

  • issue_message

    A message describing the issue

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a call group structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.