Page Comparison

...

Excerpt
This method returns information related with the latest pending communication queue entries. Multiple communication queue entries are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

communication_queue_external_system_identifier

(semi-optional)

Communication queue external system Identifier

The identifier of the communication queue external system. The allowed communication queue external system identifier fields are the following:

Include Page

	V4:communication_queue_external_system_identifier
	V4:communication_queue_external_system_identifier

media

(semi-optional)

String

The media that was used to send or receive the communication, which can be EMAIL, SMS, PHONE, LETTER, FACE_TO_FACE

contact_information_identifier

(optional)

Contact Information Identifier

The identifier of the contact information that will receive the communication kept in the communication queue. The allowed contact information identifier fields are the following:

Include Page

	V4:contact_information_identifier
	V4:contact_

information_identifier

number

(mandatory)

Number

The number of communications to be retrieved from the queue, starting from the latest one

Tip
Deprecated from CRM.COM R14.15.0

number_of_results

(optional)

Number

The number of communications to be retrieved from the queue, starting from the latest one

Tip
Available from CRM.COM

R5

R14.

0

15.0

number

offset

(

mandatory

optional)

Number

The

Defines the number of

communications to be retrieved from the queue, starting from the latest one

entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip
Available from CRM.COM R14.15.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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "updated_date": "2014-10-29T18:33:14",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-29T18:33:14",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "error_code": null,
            "error_description": null,
            "life_cycle_state": "PENDING",
            "communication":
            {
                "life_cycle_state": "COMPLETED",
                "number": "188",
                "id": "D5401B65FE1159FBA7E6EF85B9C6C546",
                "contact_information":
                {
                    "last_name": "Georgiou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Miss",
                    "type": "PERSON",
                    "first_name": "Michalis1",
                    "name": null,
                    "id": "02B4928EE8C9A170F888264D686927DD",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country": null,
                        "passport_number": "123456789",
                        "social_security_number": "45545123",
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "454545",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                }
            },
            "number": "57",
            "id": "6E3177E1F30875960B82ADCD122B12B0",
            "communication_queue_external_system":
            {
                "name": "CONAX Mail message",
                "id": "CD7D178AA593D7FF4A4D1BB2A8B576E2",
                "alternative_code": "CW5 MAIL"
            }
        },
        {
            "log_information":
            {
                "updated_date": "2014-10-23T12:38:00",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-23T12:38:00",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "error_code": null,
            "error_description": null,
            "life_cycle_state": "PENDING",
            "communication":
            {
                "life_cycle_state": "COMPLETED",
                "number": "143",
                "id": "620077BCCA968ADABE7E294D4C791C25",
                "contact_information":
                {
                    "last_name": "Georgiou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Miss",
                    "type": "PERSON",
                    "first_name": "Michalis1",
                    "name": null,
                    "id": "02B4928EE8C9A170F888264D686927DD",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country": null,
                        "passport_number": "123456789",
                        "social_security_number": "45545123",
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "454545",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                }
            },
            "number": "50",
            "id": "A2061541EF74DE0C09930B29B5F7B7B0",
            "communication_queue_external_system":
            {
                "name": "New Test",
                "id": "86F416641DB5E549D230C010302E9666",
                "alternative_code": "NT"
            }
        },
 ..... 
}

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Restrictions