Sv translation | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
Retrieve allAcdEventTypesAcdEventsThis function retrieves all AcdEventTypes AcdEvents from the systemclient 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 all AcdEventStatusThis function retrieves all AcdEventStatus from the system. URL Translations Ignore |
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: | ||||||||||||||||||||||||||||||||||||||||||||
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 | AcdEventStatus [] | An array of AcdEventStatus. | |||||||||||||||||||||||||||||||||||||||||||
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). | |||||||||||||||||||||||||||||||||||||||||||
Translations Ignore |
Code Block | ||
---|---|---|
| ||
{
"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
} |
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
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.
Translations Ignore | |||||
---|---|---|---|---|---|
|
Retrieve
ACD Groupan AcdEvent by
NameID
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 returnedAcdEvent by ID from the client account.
URL
Translations Ignore | ||
---|---|---|
|
Parameters
Parameter | Where | Type | Data | ||
---|---|---|---|---|---|
AcdEventsID | QueryURL | StringInteger | The | nameID of the | acd group(s) to retrieveAcdEvent. |
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.following fields:
Field | Type | Data |
---|---|---|
records | AcdGroup AcdEvent [] | An array of ACD groupsAcdEvents containing one AcdEvent. |
count | Integer | The number of records returned.1 |
status | Integer | The return code (also provided by the http status code). |
Example
Note, the records array has been shortened for readability.status code). |
Example
Translations Ignore | |||||
---|---|---|---|---|---|
|
Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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)A JSON Structure containing the following fields:
ExampleNote, 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
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 campaign.
ExampleNote, the dialler campaign array has been shortened for readability.
Retrieve Dialler Campaigns by NameThis 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
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 campaign.
ExampleNote, the dialler campaign data has been shortened for readability.
Retrieve the Result Codes from a Dialler CampaignThis function retrieves all result codes from a particular dialler campaign. 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 result codes.
ExampleNote, the dialler campaign result codes array has been shortened for readability.
Clone a Dialler CampaignThis 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:
Example:
ResponsesIf 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.
ExampleNote, the dialler campaign data has been shortened for readability.
Delete a Dialler Campaign by IDThis function deletes a dialler campaign including all related data. URL
Parameters
ResponsesIf 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 NameThis function deletes a dialler campaign including all related data. URL
Parameters
ResponsesIf 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.
|