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

Name	Type	Description
id	String	The id of the retrieved category
name	String	The name of the retrieved category
code	String	The code of the retrieved category
description	String	The description of the retrieved category
parent_id	String	The id of the retrieved category's parent category

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "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)

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

Name	Type	Description
id	String	The ID of the communication queue external system
name	String	The name of the communication queue external system
alternative_code	String	The alternative code of the communication queue external system
description	String	A description of the communication queue external system
character_count_limit	Number	The message character count limit of the communication queue external system
log_information	Log Information Object	The log information of the communication queue external system
supported_media_set	Set of Communication Media Objects	The media that can be used in combination with the specific communication queue external system. The media is filtered against the queue external system's supported media. Available from CRM.COM R10.0.0

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

communication media object response data

Name	Type	Description
media	String	The media that was will be used to send the communication, which can be EMAIL, SMS, PHONE, LETTER, FACE_TO_FACE, DEVICE

Examples

Example 1

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the communication category

name

(semi-optional)

String

The name of the communication category

code

(semi-optional)

String

The code of the communication category

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

Name	Type	Description
id	String	The ID of the communication template
name	String	The name of the communication template
alternative_code	String	The alternative code of the communication template
description	String	A description of the communication template
life_cycle_state	String	The life cycle state of the communication template, which can be EFFECTIVE or NOT_EFFECTIVE
direction	String	The direction of the communication template, which can be INCOMING or OUTGOING
media	String	The media of the communication template, which can be EMAIL, SMS, PHONE, LETTER, F2F
subject	String	The subject of the communication template
content	String	The content of the communication template
category	Communication Category Object	The category of the communication template
communication_queue_external_system	Communication Queue External System	The communication queue external system of the communication template Available from CRM.COM R10.0.0
log_information	Log Information Object	The log information of the communication queue external system

Referred Objects Response Data

communication_category response data object

Name	Type	Description
Id	String	The ID of the retrieved communication category
name	String	The Name of the retrieved communication category
code	String	The code of the retrieved communication category
description	String	The Description of the retrieved communication category

communication_queue_external_system object response data

Name	Type	Description
Id	String	The ID of the communication queue external system
name	String	The name of the communication queue external system
alternative_code	String	The alternative code of the communication queue external system

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response: