Tip |
---|
Table of Contents | ||
---|---|---|
|
GET communications/configuration/categories/list
This method returns the communication categories that are allowed to be used by communications. Multiple communications categories are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET communications/configuration/queue_external_systems/list
This method returns the communication queue external systems that are allowed to be used in communications. Multiple communication queue external systems are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
group_identifier
(optional)
...
The identifier of the group that will be creating the communication. The group is filtered against the queue external system's allowed organisational units. The allowed group identifier fields are the following:
...
unit_identifier
(optional)
...
The identifier of the unit that will be creating the communication. The unit is filtered against the queue external system's allowed organisational units. The allowed unit identifier fields are the following:
...
media
(optional)
...
The media that will be used to send the communication, which can be EMAIL, SMS, PHONE, LETTER, FACE_TO_FACE or DEVICE. The media is filtered against the queue external system's supported media.
Tip |
---|
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET communications/configuration/templates/list
This method returns the communication templates that are allowed to be used in communications. Multiple communication templates are returned by each call. Note that only effective communication templates are retrieve by this method.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
group_identifier
(optional)
...
The identifier of the group that will be creating the communication. The group is filtered against the templates' allowed organisational units. The allowed group identifier fields are the following:
...
unit_identifier
(optional)
...
The identifier of the unit that will be creating the communication. The unit is filtered against the templates' allowed organisational units. The allowed unit identifier fields are the following:
...
direction
(optional)
...
media
(optional)
...
category_identifier
(optional)
...
The category of the communication template that will be retrieved. The allowed communication category identifiers are the following:
...
The communication queue external system of the communication template that will be retrieved. The allowed communication queue external system identifiers are the following:
...
Tip |
---|
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
Code Block | ||||||
| ||||||
Panel | ||||||
| ||||||
|