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.
Sv translation
languageen

Table of Contents
maxLevel1

Retrieve all Users

This function retrieves all users

from the client account.

URL

Translations Ignore


Code Block
GET {baseURL}/users



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.
recordsUsers []An array of users.
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": [
        {
            "bTelCallsForwarding": false,
            "bUseWebMail": false,
            "dtPBXTelephoneStatus": null,
...
            "ResellersID": 1,
            "TelStatusID": 0,
            "AgentStatusAfterLogoutRejectedID": null
        }
    ],
    "count": 22,
    "orderBy": "UID",
    "ascending": true,
    "status": 200
}



Retrieve a specific User by ID

This function retrieves a specific user by ID.

URL

Code Block
GET {baseURL}/users/user/{UsersID}

Parameters

ParameterWhereTypeData
UsersIDURLIntegerThe ID of the user.

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.

FieldTypeData
recordsUsers []An array of users, containing one user.
countInteger1
statusIntegerThe return code (also provided by the http status code).

Example

Note, the record array has been shortened for readability.

Translations Ignore


Code Block
languagejs
{
    "records": [
        {
            "bTelCallsForwarding": false,
            "bUseWebMail": true,
            "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558",
            "bUseWebEmail": true,
...
            "ResellersID": 1,
            "TelStatusID": 0,
            "AgentStatusAfterLogoutRejectedID": null
        }
    ],
    "count": 1,
    "status": 200
}



Retrieve User by UID

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

URL

Translations Ignore


Code Block
GET {baseURL}/users/user?uid={UID}



Parameters

ParameterWhereTypeData
UIDQueryStringThe UID of the user(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 users.

FieldTypeData
recordsUser []

An array of users.

countIntegerThe number of records returned.
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
{
    "records": [
        {
            "bTelCallsForwarding": false,
            "bUseWebMail": true,
            "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558",
...
            "ResellersID": 1,
            "TelStatusID": 0,
            "AgentStatusAfterLogoutRejectedID": null
        }
    ],
    "count": 2,
    "status": 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.

Returned Data (200 OK)

A JSON Structure containing the returned campaign.

Example

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

Sv translation
languagefr

Table of Contents
maxLevel1

Retrieve all Dialler Campaigns

Récupérer tous les utilisateurs

Cette fonction permet de retrouver tous les utilisateurs

du compte clientThis function retrieves all dialler campaigns from the client account.

URL

Translations Ignore


Code Block
GET {baseURL}/dialler/campaignsusers
Parameters



Paramètres

NoneAucun

Responses

Réponses

Si la demande est exécutéeIf the request is performed, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes.

Returned Data

pour d'autres codes de statut possibles.

Données retournées (200 OK)

A JSON Structure containing the following fieldsUne structure JSON contenant les champs suivants :

FieldChampTypeDataDonnées
filterfiltreStringChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futurThe applied filter. This is reserved for future use.
limitStartIntegerEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation futureThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerEntierLe nombre d'enregistrementsThe 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

indique tous les enregistrements. Réservé pour une utilisation future.
enregistrementsUtilisateurs []Un éventail d'utilisateurs.
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

Notez que le tableau des enregistrements a été raccourci pour des raisons de lisibilitéNote, the dialler campaign array has been shortened for readability.

Translations Ignore


Code Block
languagejs
{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
 "bTelCallsForwarding":           "ContactPreviewTimefalse, "bUseWebMail": 5false,
 "dtPBXTelephoneStatus": null, ... "ResellersID": 1, "TelStatusID": 0, "AgentStatusAfterLogoutRejectedID": null } ], "nMaxParallelLinescount": null22,
 "orderBy":           "bCloseContactsOnIncomingCallsMatchCallerID"UID", "ascending": true,
 "status": 200          "dtTo": null,
            "LanguagesID": 2,
            "bCallerIDActive": false,
            "Name": "Campaign 1000",
...
            "ClientsID": 1,
            "AbortOnNoTelNumberResultCodesID": 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

Code Block
GET {baseURL}/dialler/campaigns/{DiallerCampaignsID}

Parameters

ParameterWhereTypeData
DiallerCampaignsIDURLIntegerThe ID of the Dialler Campaign.
FieldTypeData
recordsDiallerCampaigns []An array of dialler campaigns, containing one campaign.
countInteger1
statusIntegerThe return code (also provided by the http status code).
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
}
}



Récupérer un utilisateur spécifique par ID

Cette fonction permet de retrouver un utilisateur spécifique par ID.

URL

Code Block
GET {baseURL}/users/user/{UsersID}

Paramètres

 ParamètreOùTypeDonnées
UsersIDURLEntierL'ID de l'utilisateur.

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.

ChampTypeDonnées
enregistrementsUtilisateurs []Un ensemble d'utilisateurs, contenant un utilisateur.
compterEntier1
statutEntierLe 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
languagejs
{ "records": [ { "bTelCallsForwarding": false, "bUseWebMail": true, "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558", "bUseWebEmail": true, ... "ResellersID": 1, "TelStatusID": 0, "AgentStatusAfterLogoutRejectedID": null } ], "count": 1, "status": 200 }



Récupérer Utilisateur par UID

Cette fonction récupère un ou plusieurs utilisateurs en fonction de l'UID passé. Si plusieurs utilisateurs correspondant à l'UID transmis (correspondance partielle) sont disponibles, tous les utilisateurs correspondants seront renvoyés

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"
}

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
DELETEGET {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
users/user?uid={UID}



Paramètres

 ParamètreOùTypeDonnées
UIDRequêteChaîne de caractèresL'UID de l'utilisateur(s) à récupérer.

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 utilisateurs renvoyés.

ChampTypeDonnées
enregistrementsUtilisateur []

Un éventail d'utilisateurs.

compterEntierLe nombre d'enregistrements retournés.
statutEntierLe 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
languagejs
{ "records": [ { "bTelCallsForwarding": false, "bUseWebMail": true, "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558", ... "ResellersID": 1, "TelStatusID": 0, "AgentStatusAfterLogoutRejectedID": null } ], "count": 2, "status": 200 }

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