Page Comparison

...

Excerpt
This method is used to set the life cycle state of a communication queue

...

entry to processed

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

communication_queue_identifier

(mandatory)

Communication queue Identifier

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

Include Page

	V4:communication_queue_identifier
	V4:communication_queue_identifier

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

Tip
Available from CRM.COM R10.0.0

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

Request:

Body:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "token" : "F8B463306703A63FF1CF93DD832CD68B",
    "communication_queue_identifier" : { "number" : "1" }
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "log_information":
        {
            "updated_date": "2014-11-11T15:48:01",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "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": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "error_code": "05",
        "error_description": "Error with life cycle state.",
        "life_cycle_state": "COMPLETED",
        "communication":
        {
            "life_cycle_state": "COMPLETED",
            "number": "50",
            "id": "0FDED62CF74B9D9F5101B670F7DB0AB0",
            "contact_information":
            {
                "last_name": "Ioannou47",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Marios",
                "name": null,
                "id": "1D9EAB36B5034D366494B58F3D036EFB",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": null,
                    "id_issued_by_country": null,
                    "industry": null
                }
            }
        },
        "number": "1",
        "id": "BE4C746D2894889EF68DD79323D8CE88",
        "communication_queue_external_system": null
    }
}

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
	"token":"{{token}}",
	"communication_queue_identifier" : { "number" : "2" },
	"fields_set":"number,id,communication"
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "status": {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data": {
        "communication": {
            "life_cycle_state": "COMPLETED",
            "number": "6",
            "id": "902DC84C1589E36101290D0CE98234BF",
            "subject": " Information for subscription #subscription.number",
            "contact_information": {
                "last_name": "Pickman",
                "middle_name": "Li",
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": "Mr",
                "first_name": "Jessie",
                "type": "PERSON",
                "id": "F9A629E466B1EF473CECD46F2A4D63F3",
                "name": null,
                "company_name": null,
                "demographics": {
                    "gender": "MALE",
                    "social_security_number": "434567",
                    "passport_number": "54567432",
                    "name_day": {
                        "month": 4,
                        "day": 2
                    },
                    "date_of_birth": {
                        "month": 11,
                        "day": 1,
                        "year": 1988
                    },
                    "id_number": "983452"
                }
            }
        },
        "number": "2",
        "id": "A7F5966C72935844FCE7192E62BE141B"
    }
}

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Restrictions