Get call group details

This action will return all information about a given call group

Try this request in your browser

/api/ /call_groups/info

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

id Integer

Structures

Include extended attributes?
Include expansions? 

The request output will be shown here...

URL

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

Access

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

Parameters

Parameter Type Default

id Required

The ID of the call group

 Integer null

Errors

Error Attributes

CallGroupNotFound

No call group was found given the ID provided

  • id

    The provided ID

NoAccessToCallGroup

Your authenticated identity is not permitted to access this call group

Response Data

This action will return a call group structure.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. By default, you'll receive no expansions for the structure. You can add them by providing an array of new expansion names in the _expansions parameter on the request. You can send true rather than array to receive all expansions.