Versions Compared

Old Version 2

changes.mady.by.user jtel Support

Saved on

compared with

New Version Current

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.

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.

Example

Note, the record array has been shortened for readability.

Sv translation
languageen

Table of Contents
maxLevel1

Retrieve all

ACD Groups

AcdEventTypes

This function retrieves all ACD groups AcdEventTypes from the client accountsystem.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events/groupstypes


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:

FieldTypeData
filterStringThe applied filter. This is reserved for future use.
limitStartIntegerThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.
recordsAcdGroups AcdEventType []An array of ACD groupsAcdEventTypes.
countIntegerThe number of records returned.
orderByStringThe field used to sort the records. 
ascendingBooleanWhether the array of records is sorted ascending or descending.
statusIntegerThe return code (also provided by the http status code).

Example

Note, the records array has been shortened for readability.

Translations Ignore


Code Block
languagejs
{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "QueueMusicID4SecShortText": -1"AcdEventTypes.VoiceMail",
            "SupervisorAggregationSkill5IDID": null,1
        },
       "DistributionAlgorithmID": 1, {
            "ServiceLevelSecondsShortText": 30,
..."AcdEventTypes.Fax",
            "bPositionAnnouncement3ID": false 2
        },
        {
    "TarifAnnouncementWavesID        "ShortText": null"AcdEventTypes.Callback",
            "bCallRedirectionAfterNumberAnnouncementID": false3
        },
        ],{
    "count": 40,
    "orderBy   "ShortText": "NameAcdEventTypes.SMS",
            "ascendingID": true 4
        },
    "status    {
            "ShortText": 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

ParameterWhereTypeData
AcdGroupsIDURLIntegerThe ID of the ACD Group.
FieldTypeData
recordsAcdGroups []An array of ACD groups, containing one group.
countInteger1
statusIntegerThe return code (also provided by the http status code).
Translations Ignore
Code Block
languagejs
{
    "records": ["AcdEventTypes.Email",
            "ID": 5
        },
        {
            "ShortText": "AcdEventTypes.WorkFlowConnector",
            "ID": 6
        },
        {
            "ShortText": "AcdEventTypes.Chat",
            "ID": 7
        {}
    ],
        "QueueMusicID4Seccount": -17,
            "SupervisorAggregationSkill5IDorderBy": null"ID",
            "DistributionAlgorithmID"ascending": 1true,
...
            "bPositionAnnouncement3status": 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

ParameterWhereTypeDataAcdGroupsNameQueryStringThe 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.

FieldTypeDatarecordsAcdGroup []

An array of ACD groups.

countIntegerThe number of records returned.statusIntegerThe return code (also provided by the http status code).
200
}


Retrieve all AcdEventStatus

This function retrieves all AcdEventStatus from the system.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events/status


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:

FieldTypeData
filterStringThe applied filter. This is reserved for future use.
limitStartIntegerThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.
recordsAcdEventStatus []An array of AcdEventStatus.
countIntegerThe number of records returned.
orderByStringThe field used to sort the records. 
ascendingBooleanWhether the array of records is sorted ascending or descending.
statusIntegerThe return code (also provided by the http status code).

Example

Translations Ignore


Code Block
languagejs
{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,

Example

Note, the records array has been shortened for readability.

Translations Ignore
Code Block
languagejs
{
    "records": [
        {
            "QueueMusicID4SecShortText": 10"AcdEventStatus.EnterSystem",
            "SupervisorAggregationSkill5IDID": null,0
        },
    "DistributionAlgorithmID": 3,
...    {
            "QueueOffhookAnnouncementIDShortText": null"AcdEventStatus.Distribute",
            "bPositionAnnouncement3ID": false 1
        },
        {
    "TarifAnnouncementWavesID        "ShortText": null"AcdEventStatus.TransportSMTP",
            "bCallRedirectionAfterNumberAnnouncementID": false2
        },
     ],   {
    "count        "ShortText": 3"AcdEventStatus.TransportToGroup",
    "status        "ID": 200
}
Sv translation
languagede

Table of Contents
maxLevel1

Retrieve all Dialler Campaigns

This function retrieves all dialler campaigns from the client account.

URL

Translations Ignore
Code Block
GET {baseURL}/dialler/campaigns

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:

FieldTypeDatafilterStringThe applied filter. This is reserved for future use.limitStartIntegerThe first record index. Currently 0, reserved for future use.limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.recordsDiallerCampaigns []An array of dialler campaigns.countIntegerThe number of dialler campaigns returned.orderByStringThe field used to sort the dialler campaigns. ascendingBooleanWhether the array of campaigns is sorted ascending or descending.statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler campaign array has been shortened for readability.

Translations Ignore
Code Block
languagejs
{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [4
        },
        {
            "ShortText": "AcdEventStatus.TransportAgent",
            "ID": 10
        },
        {
            "ShortText": "AcdEventStatus.New",
            "ID": 20
        },
        {
            "ShortText": "AcdEventStatus.Seen",
            "ID": 30
        },
        {
            "ShortText": "AcdEventStatus.Remind",
            "ID": 40
        },
        {
            "ShortText": "AcdEventStatus.ChatClosed",
            "ID": 98
        },
        {
            "ContactPreviewTimeShortText": 5"AcdEventStatus.Done",
            "nMaxParallelLinesID": null,99
        },
       "bCloseContactsOnIncomingCallsMatchCallerID": true, {
            "dtToShortText": null"AcdEventStatus.Error",
            "LanguagesIDID": 2,100
        }
    "bCallerIDActive": false],
        "count": 11,
    "NameorderBy": "Campaign 1000ID",
...
            "ClientsID": 1,
  "ascending": true,
          "AbortOnNoTelNumberResultCodesID"status": 2492,
            "IncomingCallResultCodesID": 2494
        }
    ],
    "count": 1,
    "orderBy": "Name",
    "ascending": true,
    "status": 200
}

Retrieve a specific Dialler Campaign by ID

This function retrieves a specific dialler campaign by ID.

URL

200
}



Sv translation
languagede

Status
colourRed
titleThis page is only available in English

Responses

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

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

Returned Data

(200 OK)

A JSON Structure containing the returned campaign.

Une structure JSON contenant les champs suivants :

Sv translation
languagefr

Table of Contents
maxLevel1

Récupérer tous les AcdEventTypes

Cette fonction récupère tous les AcdEventTypes du système.

URL

Translations Ignore


Code Block
GET {baseURL}/
dialler
acd/
campaigns
events/
{DiallerCampaignsID}
types
Parameters


Paramètres

Parameter

Aucun

WhereTypeData
DiallerCampaignsIDURLIntegerThe ID of the Dialler Campaign.
ChampFieldTypeDataDonnées
recordsDiallerCampaigns []An array of dialler campaigns, containing one campaign.
countInteger1
statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler campaign array has been shortened for readability.

Translations Ignore
Code Block
languagejs
{
     "records": [
        {
            "ContactPreviewTime": 5,
            "nMaxParallelLines": null,
            "bCloseContactsOnIncomingCallsMatchCallerID": true,
            "dtTo": null,
            "LanguagesID": 2,
            "bCallerIDActive": false,
            "Name": "Campaign 1000",
...
            "ClientsID": 1,
            "AbortOnNoTelNumberResultCodesID": 2492,
            "IncomingCallResultCodesID": 2494
        }
    ],
    "count": 1,
    "status": 200
}

Retrieve Dialler Campaigns by Name

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

URL

Translations Ignore
Code Block
GET {baseURL}/dialler/campaigns/campaign?name={DiallerCampaignsName}

Parameters

ParameterWhereTypeDataDiallerCampaignsNameQueryStringThe name of the dialler campaign(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 campaign.

FieldTypeDatarecordsDiallerCampaigns []An array of dialler campaigns, containing one campaign.countInteger1statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler campaign data has been shortened for readability.

Translations Ignore
Code Block
languagejs
{
     "records": [
        {
            "ContactPreviewTime": 5,
            "nMaxParallelLines": null,
            "bCloseContactsOnIncomingCallsMatchCallerID": true,
            "dtTo": null,
            "LanguagesID": 2,
            "bCallerIDActive": false,
            "Name": "Campaign 1000",
...
            "ClientsID": 1,
            "AbortOnNoTelNumberResultCodesID": 2492,
            "IncomingCallResultCodesID": 2494
        }
    ],
    "count": 1,
    "status": 200
}

Retrieve the Result Codes from a Dialler Campaign

This function retrieves all result codes from a particular dialler campaign.

URL

Translations Ignore
Code Block
GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID}

Parameters

ParameterWhereTypeDataDiallerCampaignsIDURLIntegerThe ID of the dialler campaign for which to retrieve the result codes.languagesIDQueryInteger

The ID of the language in which to retrieve the result codes.

Currently supported:

1 = English

2 = German

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 result codes.

FieldTypeDatarecordsDiallerCampaigns []An array of dialler campaign result codes.countIntegerThe number of returned result codes.statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler campaign result codes array has been shortened for readability.

Translations Ignore
Code Block
languagejs
{
    "records": [
        {
            "bDone": true,
            "DiallerResultCodesTypesContent": "Abschluss",
            "bDelay": false,
            "DiallerCampaignsID": 535,
            "DiallerResultCodesTypesShortText": "DiallerResultCodesTypes.1",
            "bAllowDelete": true,
            "ExportKey": "ABG",
            "Content": "Abgeschlossen",
            "ShortText": "DiallerCampaignsResultCodes.2695",
            "bAborted": false,
            "ID": 2695,
            "bAgentBound": null,
            "TimeOffset": null,
            "bAppointment": false,
            "DiallerResultCodesTypesID": 1
        },
        ...
        {
            "bDone": false,
            "DiallerResultCodesTypesContent": "Abbruch",
            "bDelay": false,
            "DiallerCampaignsID": 535,
            "DiallerResultCodesTypesShortText": "DiallerResultCodesTypes.2",
            "bAllowDelete": true,
            "ExportKey": "Aufleger",
            "Content": "Aufleger",
            "ShortText": "DiallerCampaignsResultCodes.2698",
            "bAborted": true,
            "ID": 2698,
            "bAgentBound": null,
            "TimeOffset": null,
            "bAppointment": false,
            "DiallerResultCodesTypesID": 2
        }
    ],
    "count": 7,
    "status": 200

Clone a Dialler Campaign

This function clones a dialler campaign including all related data except for the contacts in the campaign.

URL

Translations Ignore
Code Block
POST {baseURL}/dialler/campaigns/clone

POST Data

A JSON Structure containing the following parameters:

FieldTypeValuesourceStringThe name of the dialler campaign to clone.destinationStringThe name of the new destination campaign to create.userDataStringUserData which can be associated with the newly cloned dialler campaign.

Example:

Translations Ignore
Code Block
{  
	"source": "Campaign 1000",
	"destination": "My New Campaign",
	"userData": "UserData Field Contents"
}
filtreChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futur.
limitStartEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSizeEntierLe nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrementsAcdEventType []Un tableau d' AcdEventTypes.
compterEntierLe nombre d'enregistrements retournés.
orderByChaîne de caractèresLe champ utilisé pour trier les enregistrements. 
ascendantBooléenSi l'ensemble des enregistrements est trié de manière ascendante ou descendante.
statutEntierLe code de retour (également fourni par le code de statut http).

Exemple

Translations Ignore


Code Block
languagejs
{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "ShortText": "AcdEventTypes.VoiceMail", "ID": 1 }, { "ShortText": "AcdEventTypes.Fax", "ID": 2 }, { "ShortText": "AcdEventTypes.Callback", "ID": 3 }, { "ShortText": "AcdEventTypes.SMS", "ID": 4 }, { "ShortText": "AcdEventTypes.Email", "ID": 5 }, { "ShortText": "AcdEventTypes.WorkFlowConnector", "ID": 6 }, { "ShortText": "AcdEventTypes.Chat", "ID": 7 } ], "count": 7, "orderBy": "ID", "ascending": true, "status": 200 }


Retrouvez tous les AcdEventStatus

Cette fonction récupère tous les AcdEventStatus du système.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events/status


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 :

ChampTypeDonnées
filtreChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futur.
limitStartEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSizeEntierLe nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrementsAcdEventStatus []Un tableau d' AcdEventTypes.
compterEntierLe nombre d'enregistrements retournés.
orderByChaîne de caractèresLe champ utilisé pour trier les enregistrements. 
ascendantBooléenSi l'ensemble des enregistrements est trié de manière ascendante ou descendante.
statutEntierLe code de retour (également fourni par le code de statut http).

Exemple

Translations Ignore


Code Block
languagejs
{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "ShortText": "AcdEventStatus.EnterSystem", "ID": 0 }, { "ShortText": "AcdEventStatus.Distribute", "ID": 1 }, { "ShortText": "AcdEventStatus.TransportSMTP", "ID": 2 }, { "ShortText": "AcdEventStatus.TransportToGroup", "ID": 4 }, { "ShortText": "AcdEventStatus.TransportAgent", "ID": 10 }, { "ShortText": "AcdEventStatus.New", "ID": 20 }, { "ShortText": "AcdEventStatus.Seen", "ID": 30 }, { "ShortText": "AcdEventStatus.Remind", "ID": 40 }, { "ShortText": "AcdEventStatus.ChatClosed", "ID": 98 }, { "ShortText": "AcdEventStatus.Done", "ID": 99 }, { "ShortText": "AcdEventStatus.Error", "ID": 100 } ], "count": 11, "orderBy": "ID", "ascending": true, "status": 200 }

Responses

If the request is performed, 200 OK is returned.

If the source campaign does not exist, 404 Not Found is returned.

If the destination campaign already exists, 409 Conflict is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the cloned campaign.

FieldTypeDatarecordsDiallerCampaigns []An array of dialler campaigns, containing one campaign.countInteger1statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler campaign data has been shortened for readability.

Translations Ignore
Code Block
languagejs
{
     "records": [
        {
            "ContactPreviewTime": 5,
            "nMaxParallelLines": null,
            "bCloseContactsOnIncomingCallsMatchCallerID": true,
            "dtTo": null,
            "LanguagesID": 2,
            "bCallerIDActive": false,
            "Name": "Campaign 1000",
...
            "ClientsID": 1,
            "AbortOnNoTelNumberResultCodesID": 2492,
            "IncomingCallResultCodesID": 2494
        }
    ],
    "count": 1,
    "status": 200
}

Delete a Dialler Campaign by ID

This function deletes a dialler campaign including all related data.

URL

Translations Ignore
Code Block
DELETE {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}

Parameters

ParameterWhereTypeDataDiallerCampaignsIDURLIntegerThe ID of the dialler campaign to delete.

Responses

If the request is performed, 200 OK is returned.

If the campaign does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

FieldTypeDatastatusIntegerThe return code (also provided by the http status code).

Delete a Dialler Campaign by Name

This function deletes a dialler campaign including all related data.

URL

Translations Ignore
Code Block
DELETE {baseURL}/dialler/campaigns/campaign?name=DiallerCampaignsName

Parameters

ParameterWhereTypeDataDiallerCampaignsNameQueryStringThe name of the dialler campaign to delete.

Responses

If the request is performed, 200 OK is returned.

If the campaign does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

FieldTypeDatastatusIntegerThe return code (also provided by the http status code).