Sv translation

language	en

Table of Contents

maxLevel	1

Retrieve all ACD Groups

This function retrieves all ACD groups from the client account.

URL

Translations Ignore

Code Block
GET {baseURL}/acd/groups

Parameters

None

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the following fields:

Field	Type	Data
filter	String	The applied filter. This is reserved for future use.
limitStart	Integer	The first record index. Currently 0, reserved for future use.
limitPageSize	Integer	The number of records. -1 indicates all records. Reserved for future use.
records	AcdGroups []	An array of ACD groups.
count	Integer	The number of records returned.
orderBy	String	The field used to sort the records.
ascending	Boolean	Whether the array of records is sorted ascending or descending.
status	Integer	The return code (also provided by the http status code).

Example

Note, the records array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "QueueMusicID4Sec": -1,
            "SupervisorAggregationSkill5ID": null,
            "DistributionAlgorithmID": 1,
            "ServiceLevelSeconds": 30,
...
            "bPositionAnnouncement3": false,
            "TarifAnnouncementWavesID": null,
            "bCallRedirectionAfterNumberAnnouncement": false
        }
    ],
    "count": 40,
    "orderBy": "Name",
    "ascending": true,
    "status": 200
}

Retrieve a specific ACD Group by ID

This function retrieves a specific ACD group by ID.

URL

Code Block
GET {baseURL}/acd/groups/group/{AcdGroupsID}

Parameters

Parameter	Where	Type	Data
AcdGroupsID	URL	Integer	The ID of the ACD Group.

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the returned data.

Field	Type	Data
records	AcdGroups []	An array of ACD groups, containing one group.
count	Integer	1
status	Integer	The return code (also provided by the http status code).

Example

Note, the record array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "records": [
        {
            "QueueMusicID4Sec": -1,
            "SupervisorAggregationSkill5ID": null,
            "DistributionAlgorithmID": 1,
...
            "bPositionAnnouncement3": false,
            "TarifAnnouncementWavesID": null,
            "bCallRedirectionAfterNumberAnnouncement": false
        }
    ],
    "count": 1,
    "status": 200
}

Retrieve ACD Group by Name

This function retrieves one or more ACD groups, depending on the passed name. If more than one group is available which matches the name passed (partial match), then all corresponding groups will be returned.

URL

Translations Ignore

Code Block
GET {baseURL}/acd/groups/group?name={AcdGroupsName}

Parameters

Parameter	Where	Type	Data
AcdGroupsName	Query	String	The name of the acd group(s) to retrieve.

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the returned acd groups.

Field	Type	Data
records	AcdGroup []	An array of ACD groups.
count	Integer	The number of records returned.
status	Integer	The return code (also provided by the http status code).

Example

Note, the records array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "records": [
        {
            "QueueMusicID4Sec": 10,
            "SupervisorAggregationSkill5ID": null,
            "DistributionAlgorithmID": 3,
...
            "QueueOffhookAnnouncementID": null,
            "bPositionAnnouncement3": false,
            "TarifAnnouncementWavesID": null,
            "bCallRedirectionAfterNumberAnnouncement": false
        }
    ],
    "count": 3,
    "status": 200
}

Sv translation

language	de

Status

colour	Red
title	This page is only available in English

Sv translation

language	fr

Table of Contents

maxLevel	1

Retrouvez tous les groupes ACD

Cette fonction récupère tous les groupes ACD du compte client.

URL

Translations Ignore

Code Block
GET {baseURL}/acd/groups

Paramètres

Aucun

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les champs suivants :

Champ	Type	Données
filtre	Chaîne de caractères	Le filtre appliqué. Il est réservé à un usage futur.
limitStart	Entier	Le premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSize	Entier	Le nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrements	AcdGroups []	Un ensemble de groupes ACD.
compter	Entier	Le nombre d'enregistrements retournés.
orderBy	Chaîne de caractères	Le champ utilisé pour trier les enregistrements.
ascendant	Booléen	Si l'ensemble des enregistrements est trié de manière ascendante ou descendante.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau des enregistrements a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "QueueMusicID4Sec": -1, "SupervisorAggregationSkill5ID": null, "DistributionAlgorithmID": 1, "ServiceLevelSeconds": 30, ... "bPositionAnnouncement3": false, "TarifAnnouncementWavesID": null, "bCallRedirectionAfterNumberAnnouncement": false } ], "count": 40, "orderBy": "Name", "ascending": true, "status": 200 }

Retrouvez un groupe spécifique d'ACD par ID

Cette fonction permet de retrouver un groupe spécifique d'ACD par ID.

URL

Code Block
GET {baseURL}/acd/groups/group/{AcdGroupsID}

Paramètres

Paramètre	Où	Type	Données
AcdGroupsID	URL	Entier	L'ID du groupe ACD

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les données renvoyées.

Champ	Type	Données
enregistrements	AcdGroups []	Un ensemble de groupes ACD, contenant un groupe.
compter	Entier	1
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau d'enregistrement a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "records": [ { "QueueMusicID4Sec": -1, "SupervisorAggregationSkill5ID": null, "DistributionAlgorithmID": 1, ... "bPositionAnnouncement3": false, "TarifAnnouncementWavesID": null, "bCallRedirectionAfterNumberAnnouncement": false } ], "count": 1, "status": 200 }

Retrouvez le groupe ACD par son nom

Cette fonction récupère un ou plusieurs groupes ACD, selon le nom passé. S'il existe plusieurs groupes correspondant au nom transmis (correspondance partielle), tous les groupes correspondants seront renvoyés.

URL

Translations Ignore

Code Block
GET {baseURL}/acd/groups/group?name={AcdGroupsName}

Paramètres

Paramètre	Où	Type	Données
AcdGroupsName	Requête	Chaîne de caractères	Le nom du (des) groupe(s) acd à retrouver.

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les groupes acd retournés.

Champ	Type	Données
enregistrements	AcdGroups []	Un ensemble de groupes ACD.
compter	Entier	Le nombre d'enregistrements retournés.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau des enregistrements a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "records": [ { "QueueMusicID4Sec": 10, "SupervisorAggregationSkill5ID": null, "DistributionAlgorithmID": 3, ... "QueueOffhookAnnouncementID": null, "bPositionAnnouncement3": false, "TarifAnnouncementWavesID": null, "bCallRedirectionAfterNumberAnnouncement": false } ], "count": 3, "status": 200 }

Page tree

Page History

Versions Compared

Old Version 10

New Version Current

Key

Retrieve all ACD Groups

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve a specific ACD Group by ID

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve ACD Group by Name

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrouvez tous les groupes ACD

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Retrouvez un groupe spécifique d'ACD par ID

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Retrouvez le groupe ACD par son nom

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple