Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieve all UsersThis function retrieves all users from the client account. URL
ParametersNone ResponsesIf 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:
ExampleNote, the records array has been shortened for readability.
Retrieve a specific User by IDThis function retrieves a specific user by ID. URL
Parameters
ResponsesIf 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.
ExampleNote, the record array has been shortened for readability.
Retrieve User by UIDThis 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
Parameters
ResponsesIf 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.
ExampleNote, the records array has been shortened for readability.
|
Sv translation | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieve all Dialler CampaignsRécupérer tous les utilisateursCette fonction permet de retrouver tous les utilisateurs du compte clientThis function retrieves all dialler campaigns from the client account. URL
ParamètresNoneAucun ResponsesRéponsesSi 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 Datapour 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 :
Example
ExempleNotez que le tableau des enregistrements a été raccourci pour des raisons de lisibilitéNote, the dialler campaign array has been shortened for readability.
Retrieve a specific Dialler Campaign by IDThis function retrieves a specific dialler campaign by ID. URL
Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter | Where | Type | Data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DiallerCampaignsID | URL | Integer | The ID of the Dialler Campaign. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field | Type | Data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
records | DiallerCampaigns [] | An array of dialler campaigns, containing one campaign. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
count | Integer | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | Integer | The return code (also provided by the http status code). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Translations Ignore |
Code Block | ||
---|---|---|
| ||
{
"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ètre | Où | Type | Données |
---|---|---|---|
UsersID | URL | Entier | L'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.
Champ | Type | Données |
---|---|---|
enregistrements | Utilisateurs [] | Un ensemble d'utilisateurs, contenant un utilisateur. |
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 | |||||
---|---|---|---|---|---|
|
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
Code Block |
---|
GET {baseURL}/dialler/campaigns/campaign?name={DiallerCampaignsName} |
Parameters
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 data has been shortened for readability.
Code Block | ||
---|---|---|
| ||
{
"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
Code Block |
---|
GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID} |
Parameters
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.
Example
Note, the dialler campaign result codes array has been shortened for readability.
Code Block | ||
---|---|---|
| ||
{
"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
Code Block |
---|
POST {baseURL}/dialler/campaigns/clone |
POST Data
A JSON Structure containing the following parameters:
Example:
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.
Example
Note, the dialler campaign data has been shortened for readability.
Code Block | ||
---|---|---|
| ||
{
"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 | ||
---|---|---|
|
Parameters
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.
Delete a Dialler Campaign by Name
This function deletes a dialler campaign including all related data.
URL
Code Block |
---|
DELETE {baseURL}/dialler/campaigns/campaign?name=DiallerCampaignsName |
|
Paramètres
Paramètre | Où | Type | Données |
---|---|---|---|
UID | Requête | Chaîne de caractères | L'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.
Champ | Type | Données |
---|---|---|
enregistrements | Utilisateur [] | Un éventail d'utilisateurs. |
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 | |||||
---|---|---|---|---|---|
|
Parameters
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.