Skip to end of banner
Go to start of banner

communications/configuration

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

descriptionStringThe description of the retrieved category
parent_idStringThe 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

media

(optional)

String

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.

Available from CRM.COM R9.1.0

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

NameType Description
idStringThe ID of the communication queue external system
nameStringThe name of the communication queue external system

alternative_code

String

The alternative code of the communication queue external system

descriptionStringA description of the communication queue external system
character_count_limitNumber

The message character count limit of the communication queue external system

log_informationLog Information ObjectThe 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

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe 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
NameType Description
mediaStringThe 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:

 

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "updated_date": "2015-05-27T18:19:16",
                "created_date": "2015-05-27T18:11:08",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": null,
            "id": "DC30CF64A5F4426A84F1E9E76281443A",
            "name": "EXT 1",
            "description": null,
            "alternative_code": "E1"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-27T18:19:25",
                "created_date": "2015-05-27T18:19:17",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": null,
            "id": "41C56FC7230740FA9B222192305859C8",
            "name": "EXT 2",
            "description": null,
            "alternative_code": "E2"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-27T18:19:30",
                "created_date": "2015-05-27T18:19:27",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": null,
            "id": "CF8AEDF4DAF54B6B876352B845E6F92F",
            "name": "EXT 3",
            "description": null,
            "alternative_code": "E3"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-27T18:19:33",
                "created_date": "2015-05-27T18:19:31",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": null,
            "id": "825A4995EF314D77BD26E43C22D41746",
            "name": "EXT 4",
            "description": null,
            "alternative_code": "E4"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-27T18:19:37",
                "created_date": "2015-05-27T18:19:34",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": null,
            "id": "F3425DD0B25A410EA12CDFC42E8120E7",
            "name": "EXT 5",
            "description": null,
            "alternative_code": "E5"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-27T18:19:41",
                "created_date": "2015-05-27T18:19:38",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": null,
            "id": "F9C1CAC24F484C66B36DB384C74EC07F",
            "name": "EXT 6",
            "description": null,
            "alternative_code": "E6"
        },
        {
            "log_information":
            {
                "updated_date": "2015-06-19T14:38:27",
                "created_date": "2015-06-19T14:38:02",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": 256,
            "id": "8CF3465E223E4898874E045AD9C9F351",
            "name": "NAGRA Mail",
            "description": null,
            "alternative_code": "NM"
        },
        {
            "log_information":
            {
                "updated_date": "2015-09-04T12:09:30",
                "created_date": "2015-09-04T12:08:42",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": 157,
            "id": "D3EAD867A36F4527BE910AB83D8A0BA0",
            "name": "Exset mail",
            "description": null,
            "alternative_code": "EXSET"
        },
        {
            "log_information":
            {
                "updated_date": "2014-10-15T17:02:19",
                "created_date": "2014-10-10T12:47:52",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": 141,
            "id": "CD30D0C1C0F69BE84008EDAA561B9B15",
            "name": "CONAX Mail",
            "description": null,
            "alternative_code": "CM"
        },
        {
            "log_information":
            {
                "updated_date": "2015-08-27T09:14:09",
                "created_date": "2014-10-10T12:48:18",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "character_count_limit": 129,
            "id": "310D8F6AA965F1F52934124204C670DB",
            "name": "CONAX Bark Mail",
            "description": null,
            "alternative_code": "CBM"
        },
        {
            "log_information":
            {
                "updated_date": "2014-11-14T17:32:03",
                "created_date": "2014-11-14T17:31:28",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438"
                },
                "updated_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438"
                }
            },
            "character_count_limit": null,
            "id": "2914A35B81F7337DE411444B2EF9F8FE",
            "name": "OSM Messages",
            "description": "System used for OSM Messages of Panaccess",
            "alternative_code": "OSM"
        },
        {
            "log_information":
            {
                "updated_date": "2014-12-02T10:55:55",
                "created_date": "2014-12-02T10:55:32",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438"
                },
                "updated_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438"
                }
            },
            "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)

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)

StringThe direction of the communication templates that will be retrieved, which can be INCOMING or OUTGOING

media

(optional)

StringThe 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

communication_queue_external_system_identifierCommunication Queue External System Identifier

The communication queue external system of the communication template that will be retrieved. The allowed communication queue external system identifiers are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the communication queue external system

name

(semi-optional)

String

The code of the communication queue external system

alternative_code

(semi-optional)

String

The alternative code of  the communication queue external system

Available from CRM.COM R9.1.0


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

NameType Description
idStringThe ID of the communication template
nameStringThe name of the communication template

alternative_code

String

The alternative code of the communication template

descriptionStringA description of the communication template
life_cycle_stateStringThe life cycle state of the communication template, which can be EFFECTIVE or NOT_EFFECTIVE
directionStringThe direction of the communication template, which can be INCOMING or OUTGOING
mediaStringThe media of the communication template, which can be EMAIL, SMS, PHONE, LETTER, F2F
subjectStringThe subject of the communication template 
contentStringThe content of the communication template
categoryCommunication Category ObjectThe category of the communication template
communication_queue_external_systemCommunication Queue External System

The communication queue external system of the communication template

Available from CRM.COM R10.0.0

log_informationLog Information ObjectThe log information of the communication queue external system

Referred Objects Response Data

 communication_category response data object
NameType Description
IdStringThe ID of the retrieved communication category
nameStringThe Name of the retrieved communication category
codeStringThe code of the retrieved communication category
descriptionStringThe Description of the retrieved communication category

 communication_queue_external_system object response data
Name
Type
Description
IdStringThe ID of the communication queue external system
nameStringThe 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

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe 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:

 

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
                },
                "updated_by_user":
                {
                    "person_name": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "Dear
 #contact_information.name,

We would like to welcome you in our company!

Your subscription #subscription.number is now activated for the following services:
#subscription.services 

The following installed items are used: 

#subscription.installed_items 

Your subscription #subscription.number will be paid by account #accounts_receivable.number.

Your current account balance is #accounts_receivable.balance

Please do not hesitate to contact us via our Customer Support channels at any time!

Regards
AluxSat Co.",
            "id": "01F545B8648EDDC3273DC3C86A23AC5B",
            "name": "Email Template",
            "description": "A tempalte for sending emails",
            "subject": " Information for subscription #subscription.number",
            "category":
            {
                "parent_id": null,
                "id": "E7A5682FD665927F9C04723E9E79C42D",
                "name": "Customer Care Information",
                "description": "Customer Care Information",
                "code": "cci"
            },
            "alternative_code": "EMAILTEMP",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
                },
                "updated_by_user":
                {
                    "person_name": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "#notification.number
 
Dear #notification.contact_information.name
 
We would like to remind you that the outstanding amount for your account #notification.accounts_receivable.number is #notification.total_notified_amount, which is related with the following subscriptions
#notification.subscriptions_notified_amount
 
Regards
AluxSat Co.",
            "id": "E4FF2938C24CBAA8C5B7322BBC444C69",
            "name": "Unsettled Subscriptions",
            "description": "Communication Template for Unsettled Subscriptions",
            "subject": "Unsettled Subscription #subscriptions.number",
            "category": null,
            "alternative_code": "USub",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "#notification.number
 
Dear #notification.contact_information.name
 
We would like to remind you that the outstanding amount for your account #notification.accounts_receivable.number is #notification.total_notified_amount, which is related with the following bill
#notification.bills_notified_amount
 
Regards
AluxSat Co.",
            "id": "6E6EBBFC793CAA36ACB13456F24070F9",
            "name": "Unsettled Accounts Receivable",
            "description": "Communication Template Unsettled Accounts Receivable",
            "subject": "Unsettled Accounts Receivable",
            "category": null,
            "alternative_code": "UAR",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "updated_date": "2014-11-07T16:17:46",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "#notification.number
 
Dear #notification.contact_information.name
 
We would like to remind you that the remaining amount in your wallets is estimated to be consumed by
#notification.wallets_estimated_consumption_date

#notification.wallets_estimated_consumption_days	

 
Regards
AluxSat Co.",
            "id": "7F76E517989A0ABBCE39DE3FCAE54098",
            "name": "Wallet with low credit",
            "description": "Communication Template for Wallet with low credit",
            "subject": "Wallet with low credit",
            "category": null,
            "alternative_code": "WWLC",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "updated_date": "2014-11-03T18:11:33",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "#notification.number
 
Dear #notification.contact_information.name
 
We would like to remind you that the remaining amount for your prepaid services is the following:
#notification.wallets_product_available_amount
 
This amount is estimated to be consumed by
#notification.wallets_product_estimated_consumption_date
 
Regards
AluxSat Co.",
            "id": "D3FE80B46AAEE911BB5B6AF5AF28B389",
            "name": "Wallet Product Consumption near estimated date",
            "description": "Communication Template Wallet Product Consumption near estimated date",
            "subject": "Wallet Product Consumption near estimated date",
            "category": null,
            "alternative_code": "WPCED",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "#notification.number
 
Dear #notification.contact_information.name
 
We would like to welcome you and congratulate you for subscribing with us. Your subscription information is the following:
#notification.subscriptions_type
 
Regards
AluxSat Co.",
            "id": "35F18609EA47BC52E0600084E4E28538",
            "name": "New Subscribers",
            "description": "Communication Template for New subscribers",
            "subject": "Welcome to AluxSat Co. Family",
            "category": null,
            "alternative_code": "NS",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "updated_date": "2015-10-23T10:31:43",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "#notification.number Dear #notification.contact_information.name We would like to inform you that the following jobs have been completed successfully. #notification.jobs_type Regards AluxSat Co. kokoui

",
            "id": "536BD3451CFDE4565C33876C1F97B376",
            "name": "Completed Jobs",
            "description": "Communication Template for Completed Jobs",
            "subject": "Completed Jobs",
            "category": null,
            "alternative_code": "CJ",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "updated_date": "2015-10-26T12:10:10",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": "#notification.number Dear #contact_information.name We would like to inform you that the following activities have been completed successfully. #notification.activities_type Regards AluxSat Co.#subscription.accounts_receivable.name  testasdasdas

",
            "id": "E8C427F604AD575163CE55979E888B04",
            "name": "Completed Activities",
            "description": "Communication Template for Completed Activities",
            "subject": "Completed Activities3423",
            "category":
            {
                "parent_id": "E55C28E9C03DAF559B1CBE0B0D29C8F5",
                "id": "9D665495E4F60D9CA119888D76FCED3D",
                "name": "Customer Care Complaint",
                "description": "Customer Care Complaint",
                "code": "CCC"
            },
            "alternative_code": "CA",
            "direction": "OUTGOING"
        },
        {
            "log_information":
            {
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                }
            },
            "media": "EMAIL",
            "life_cycle_state": "EFFECTIVE",
            "content": null,
            "id": "2F3F7CF239420102BAD64B6EB06D607E",
            "name": "Incoming Test",
            "description": "FSDFDSF",
            "subject": null,
            "category": null,
            "alternative_code": "IT",
            "direction": "INCOMING"
        },
        {
            "log_information":
            {
                "updated_date": "2014-12-01T17:09:54",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persia_xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E"
                },
                "updated_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438"
                }
            },
            "media": "DEVICE",
            "life_cycle_state": "EFFECTIVE",
            "content": "Dear customer your subscription will be disconnected tomorrow due to unsettled amount",
            "id": "25F373AB873BABF9AD83DD5F51C35041",
            "name": "Sub Info via Conax",
            "description": null,
            "subject": "Sub Info",
            "category": null,
            "alternative_code": "CNX",
            "direction": "OUTGOING"
        }
} 
  • No labels