Sv translation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieve all AcdEventsThis function retrieves all AcdEvents 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:
Example
Retrieve an AcdEvent by IDThis function retrieves one AcdEvent by ID from the client account. 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 following fields:
Example
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sv translation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Create an AcdEventThis function creates an AcdEvent
Retrieve all Dialler CampaignsThis function retrieves all dialler campaigns 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)Post DataA JSON Structure structure containing the following fieldsparameters:
ExampleNote, the dialler campaign array has been shortened for readability. Translations Ignore |
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). |
ID of the AcdGroup to which this event should be distributed. Either specify this, or the parameters AcdConfigurationGroupsID and AcdAgentGroupsID. | ||||||||||
AcdConfigurationGroupsID | OR BOTH OF THESE | All | Integer | The ID of the Configuration Group to which this event should be distributed. Either specify this with AcdAgentGroupsID, or specify AcdGroupsID. | ||||||
AcdAgentGroupsID | OR BOTH OF THESE | All | Integer | The ID of the Agent Group to which this event should be distributed. Either specify this with AcdAgentGroupsID, or specify AcdGroupsID. | ||||||
UsersID | No | All | Integer | The ID of the User to which this event should be distributed. If not provided, the event is distributed via the group queue. | ||||||
Sender | Yes | All | String | A string identifying the sender. For telephone related events this should be a telephone number in E.164 format (Voice Mail and Callback Requests). For other events the data may be context specific - for example an email address. | ||||||
Receiver | No | All | String | A string identifying the receiver. For telephone related events this should be a telephone number which is available in the system as a configured service number in E.164 format (Voice Mail and Callback Requests). For other events, the data may be context specific - for example an email address. | ||||||
Subject | Yes | All | String | A string subject to associate with the event. Can be any text. | ||||||
Body | No | Callback | String | A body which will be added to the event body data. | ||||||
CrmURL | No | All | String | An URL which will be associated with the event. This should correspond to a well formed URL. | ||||||
UserData | No | All | String | An optional user data field which will be associated with the event. For Ticket (Workflow) events, this will correspond to the foreign system ticket number. | ||||||
nPriority
| No | All | Integer | The priority of the event. If not specified, 50 is used. | ||||||
dtAppointmentDate
| No | All | String | The date part of the required appointment in the format yyyy-mm-dd or yyyymmdd The fields dtAppointmentDate and dtAppointmentTime are set as follows:
Note: actual distribution depends on the agents logged in and the distribution requirements (skill, priority etc.). | ||||||
dtAppointmentTime
| No | All | String | The time part of the required appointment in the format hh:mm or hhmm See dtAppointmentDate above for important details on how to use this parameter. |
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 |
---|---|---|
records | AcdEvent [] | An array of AcdEvents containing the created AcdEvent. |
count | Integer | 1 |
status | Integer | The return code (also provided by the http status code). |
Example Post Data
Create a callback event:
Translations Ignore | ||
---|---|---|
|
Create a callback event for a specific user:
Translations Ignore | ||
---|---|---|
|
Create a ticket event:
Translations Ignore | ||
---|---|---|
|
Example response:
Translations Ignore | |||||
---|---|---|---|---|---|
|
Example
Note, the dialler campaign array 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 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.
Translations Ignore | |||||
---|---|---|---|---|---|
|
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.
Translations Ignore | |||||
---|---|---|---|---|---|
|
Clone a Dialler Campaign
|
Info | ||
---|---|---|
| ||
NOTE: If the Result_ parameter is received in the returned event and this contains the value "UPDATED", then this means the ACD group configuration stipulates that no duplicate ACD events should be created. In this case, the existing event is returned and updated with a comment. |
Sv translation | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
Récupérer tous les AcdEventsCette fonction récupère tous les AcdEvents du compte client. URL
ParamètresAucun RéponsesSi 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 :
Exemple
Récupérer un AcdEvent par IDCette fonction récupère un AcdEvent par ID du compte clientThis function clones a dialler campaign including all related data except for the contacts in the campaign. URL
POST DataA JSON Structure containing the following parameters: | ||||||||||||||||||||||||||||||||||||||||||||||
Field | Type | Value | ||||||||||||||||||||||||||||||||||||||||||||
source | String | The name of the dialler campaign to clone. | ||||||||||||||||||||||||||||||||||||||||||||
destination | String | The name of the new destination campaign to create. | ||||||||||||||||||||||||||||||||||||||||||||
userData | String | UserData which can be associated with the newly cloned dialler campaign. | ||||||||||||||||||||||||||||||||||||||||||||
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.
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
Code Block |
---|
DELETE {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID} |
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 |
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.
|
Paramètres
Paramètre | Où | Type | Données |
---|---|---|---|
AcdEventsID | URL | Entier | L'ID de l'AcdEvent. |
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 |
---|---|---|
enregistrements | AcdEvent [] | Un ensemble d'AcdEvents contenant un AcdEvent. |
compter | Entier | 1 |
statut | Entier | Le code de retour (également fourni par le code de statut http). |
Exemple
Translations Ignore | |||||
---|---|---|---|---|---|
|
Créer un AcdEvent
Cette fonction crée un AcdEvent.
URL
Translations Ignore | ||
---|---|---|
|
Paramètres
Aucun.
Après Données
Une structure JSON contenant les paramètres suivants :
Paramètre | Requise | Soutenu dans les AcdEventTypes | Type | Données | ||||||
---|---|---|---|---|---|---|---|---|---|---|
AcdEventTypesID | Oui | Entier | L'ID de l'AcdEventType à créer. | |||||||
AcdGroupsID | Oui | Tous | Entier | L'ID de l'AcdGroup auquel cet événement doit être distribué. | ||||||
UsersID | Non | Tous | Entier | L'ID de l'utilisateur auquel cet événement doit être distribué. S'il n'est pas fourni, l'événement est distribué via la file d'attente de groupe. | ||||||
Expéditeur | Oui | Tous | Chaîne de caractères | Une chaîne de caractères identifiant l'expéditeur. Pour les événements liés au téléphone, il doit s'agir d'un numéro de téléphone au format E.164 (messagerie vocale et demandes de rappel). Pour d'autres événements, les données peuvent être spécifiques au contexte - par exemple une adresse électronique. | ||||||
Récepteur | Non | Tous | Chaîne de caractères | Une chaîne de caractères identifiant le récepteur. Pour les événements liés au téléphone, il doit s'agir d'un numéro de téléphone qui est disponible dans le système en tant que numéro de service configuré au format E.164 (messagerie vocale et demandes de rappel). Pour d'autres événements, les données peuvent être spécifiques au contexte - par exemple une adresse email. | ||||||
Sujet | Oui | Tous | Chaîne de caractères | Une chaîne de caractères à associer à l'événement. Peut être n'importe quel texte. | ||||||
Corps | Non | Rappel | Chaîne de caractères | Un corps qui sera ajouté aux données du corps de l'événement. | ||||||
CrmURL | Non | Tous | Chaîne de caractères | Une URL qui sera associée à l'événement. Cela doit correspondre à une URL bien formée. | ||||||
UserData | Non | Tous | Chaîne de caractères | Un champ de données utilisateur facultatif qui sera associé à l'événement. Pour les événements avec billets (Workflow), cela correspondra au numéro de billet du système étranger. | ||||||
nPriority
| Non | Tous | Entier | La priorité de l'événement. Si elle n'est pas spécifiée, la priorité est de 50. | ||||||
dtAppointmentDate
| Non | Tous | Chaîne de caractères | La date du rendez-vous requis au format yyyy-mm-dd ou yyyy-mm-dd. Les champs dtAppointmentDate et dtAppointmentTime sont définis comme suit :
Remarque : la distribution réelle dépend des agents connectés et des exigences de distribution (compétence, priorité, etc.). | ||||||
dtAppointmentTime
| Non | Tous | Chaîne de caractères | La partie temporelle du rendez-vous requis au format hh:mm ou hhmm Voir dtAppointmentDate ci-dessus pour des détails importants sur l'utilisation de ce paramètre. |
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 |
---|---|---|
enregistrements | AcdEvent [] | Un tableau d'AcdEvents contenant l'AcdEvent créé. |
compter | Entier | 1 |
statut | Entier | Le code de retour (également fourni par le code de statut http). |
Exemple Après-données
Créer un événement de rappel :
Translations Ignore | ||
---|---|---|
|
Créer un événement de rappel pour un utilisateur spécifique :
Translations Ignore | ||
---|---|---|
|
Créer un événement de ticket:
Translations Ignore | ||
---|---|---|
|
Exemple de réponse :
Translations Ignore | |||||
---|---|---|---|---|---|
|