| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
group_identifier (optional) | Group Identifier | 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) | Unit Identifier | 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:
| ||||||
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 |
...
| Include Page | ||||
|---|---|---|---|---|
|
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) | Group Identifier | 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) | Unit Identifier | 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) | String | The direction of the communication templates that will be retrieved, which can be INCOMING or OUTGOING | ||||||
media (optional) | String | The media of the communication templates that will be retrieved, which can be EMAIL, SMS, PHONE, LETTER, F2F | ||||||
category_identifier (optional) | Category Identifier | The category of the communication template that will be retrieved. The allowed communication category identifiers are the following:
| ||||||
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
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|