| Tip |
|---|
Available from CRM.COM R9.0.0 |
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: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"parent_id": null,
"id": "58F9A79964F84E0267D3AC1DA660F435",
"name": "Technical",
"description": "Technical Communications",
"code": "TCH"
},
{
"parent_id": null,
"id": "D5A96C204FD8E6824F0FCD036B1C57CD",
"name": "Technical Issues",
"description": "Technical Issues",
"code": "TCHI"
},
{
"parent_id": null,
"id": "E55C28E9C03DAF559B1CBE0B0D29C8F5",
"name": "Customer Care",
"description": "Customer Care Communications",
"code": "CCARE"
},
{
"parent_id": "E55C28E9C03DAF559B1CBE0B0D29C8F5",
"id": "E5F155D007BC24C57FF23DD8D7CB88F4",
"name": "Customer Care Questions",
"description": "Customer Care Questions",
"code": "CCQ"
},
{
"parent_id": "E55C28E9C03DAF559B1CBE0B0D29C8F5",
"id": "7CDB0FB41ACA95725AC62BE6FD41F87B",
"name": "Customer Care Issues",
"description": "Customer Care Issues",
"code": "CCIssue"
},
{
"parent_id": "E55C28E9C03DAF559B1CBE0B0D29C8F5",
"id": "9D665495E4F60D9CA119888D76FCED3D",
"name": "Customer Care Complaint",
"description": "Customer Care Complaint",
"code": "CCC"
},
{
"parent_id": null,
"id": "E7A5682FD665927F9C04723E9E79C42D",
"name": "Customer Care Information",
"description": "Customer Care Information",
"code": "cci"
}
]
}
|
|
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:
...
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: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"character_count_limit": null,
"id": "DC30CF64A5F4426A84F1E9E76281443A",
"name": "EXT 1",
"description": null,
"alternative_code": "E1"
},
{
"character_count_limit": null,
"id": "41C56FC7230740FA9B222192305859C8",
"name": "EXT 2",
"description": null,
"alternative_code": "E2"
},
{
"character_count_limit": null,
"id": "CF8AEDF4DAF54B6B876352B845E6F92F",
"name": "EXT 3",
"description": null,
"alternative_code": "E3"
},
{
"character_count_limit": null,
"id": "825A4995EF314D77BD26E43C22D41746",
"name": "EXT 4",
"description": null,
"alternative_code": "E4"
},
{
"character_count_limit": null,
"id": "F3425DD0B25A410EA12CDFC42E8120E7",
"name": "EXT 5",
"description": null,
"alternative_code": "E5"
},
{
"character_count_limit": null,
"id": "F9C1CAC24F484C66B36DB384C74EC07F",
"name": "EXT 6",
"description": null,
"alternative_code": "E6"
},
{
"character_count_limit": 256,
"id": "8CF3465E223E4898874E045AD9C9F351",
"name": "NAGRA Mail",
"description": null,
"alternative_code": "NM"
},
{
"character_count_limit": 157,
"id": "D3EAD867A36F4527BE910AB83D8A0BA0",
"name": "Exset mail",
"description": null,
"alternative_code": "EXSET"
},
{
"character_count_limit": 141,
"id": "CD30D0C1C0F69BE84008EDAA561B9B15",
"name": "CONAX Mail",
"description": null,
"alternative_code": "CM"
},
{
"character_count_limit": 129,
"id": "310D8F6AA965F1F52934124204C670DB",
"name": "CONAX Bark Mail",
"description": null,
"alternative_code": "CBM"
},
{
"character_count_limit": null,
"id": "2914A35B81F7337DE411444B2EF9F8FE",
"name": "OSM Messages",
"description": "System used for OSM Messages of Panaccess",
"alternative_code": "OSM"
},
{
"character_count_limit": 129,
"id": "ACDF82ECE93FD231E137BA3C46DB6E8D",
"name": "Conax Bark Repeated Mail",
"description": null,
"alternative_code": "CNXBR"
}
]
} |
|
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:
...
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:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
| Panel |
|---|
|
| Child pages (Children Display) |
|---|
|
|