- Created by Former user, last modified by Joseph Ioannou on Jul 19, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Current »
Available from CRM.COM R10.1.0
This method returns information related with the latest pending to be viewed and completed 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:
| |||||||||||||||||||||
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:
| |||||||||||||||||||||
number_of_results (optional) | Number | The number of communications to be retrieved from the queue, starting from the latest one For releases prior CRM.COM R13.0.0 the parameter's name is number | |||||||||||||||||||||
offset (optional) | Number | Defines the number of 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 Available from CRM.COM R13.0.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.
Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved communication queue entry |
number | String | The number of the retrieved communication queue entry |
life_cycle_state | String | The lifecycle state of the retrieved communication queue entry which can be PENDING, REJECTED, COMPLETED or COMPLETED_AND_REMOVED. Life Cycle State COMPLETED_AND_REMOVED is available from CRM.COM R10.1.0 |
error_code | String | The code of a possible error that occur while processing the communication queue entry |
error_description | String | The description of a possible error that might occur while processing the communication queue entry |
communication | Communication object | The communication that is sent through the retrieved communication queue entry |
communication_queue_external_system | Communication Queue External System object | The external system which process the communication waiting in retrieved communication queue entry |
Log Information Object | The log information related with the retrieved communication queue entry |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
Id | String | The ID of the communication |
number | String | The code of communication |
life_cycle_state | String | The lifecycle state of the retrieved communication which can be DRAFT or COMPLETE |
subject | String | The subject of the retrieved communication |
viewed | Boolean | Defines whether the communication was viewed, or not Available from CRM.COM R12.2.0 |
viewed_on | Date | The date that the communication was viewed Available from CRM.COM R12.2.0 |
contact_information | Contact Information object | The contact information related with the specified communication |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
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 |
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 |
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 | |
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 | |
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 | |
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 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
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
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 |
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 |
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 |
String | The email of the retrieved user |
Examples
HTTP Method: GET
Request:
Response:
{ "status": { "message": "", "description": "", "code": "OK" }, "data": [ { "log_information": { "updated_date": "2016-08-02T12:00:31", "created_date": "2016-08-02T12:00:31", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "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", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "error_code": null, "life_cycle_state": "PENDING", "error_description": null, "communication": { "life_cycle_state": "COMPLETED", "number": "CM003005", "id": "5281488906FD41FEB07C67FA5E6E0474", "subject": "Testing", "contact_information": { "last_name": "Anton", "middle_name": "333", "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Mrs", "first_name": "Mara", "type": "PERSON", "id": "3358197AD0334CE2834DB60933B2CE88", "name": null, "company_name": null, "demographics": { "gender": "FEMALE", "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "568941", "industry": null, "id_issued_by_country": null } } }, "number": "2701", "id": "A05B9FAC995B4A95BDBA2588E7799574", "communication_queue_external_system": { "id": "DC30CF64A5F4426A84F1E9E76281443A", "name": "EXT 1", "alternative_code": "E1" } }, { "log_information": { "updated_date": "2016-08-02T12:00:29", "created_date": "2016-08-02T12:00:29", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "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", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "error_code": null, "life_cycle_state": "PENDING", "error_description": null, "communication": { "life_cycle_state": "COMPLETED", "number": "CM003004", "id": "18163D6F2F7E42A8A4FB14E7E8858697", "subject": "Testing", "contact_information": { "last_name": "Anton", "middle_name": "333", "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Mrs", "first_name": "Mara", "type": "PERSON", "id": "3358197AD0334CE2834DB60933B2CE88", "name": null, "company_name": null, "demographics": { "gender": "FEMALE", "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "568941", "industry": null, "id_issued_by_country": null } } }, "number": "2700", "id": "B4C256103AB94B1A9643B0588B9A51AA", "communication_queue_external_system": { "id": "DC30CF64A5F4426A84F1E9E76281443A", "name": "EXT 1", "alternative_code": "E1" } }, { "log_information": { "updated_date": "2016-08-02T11:59:40", "created_date": "2016-08-02T11:49:39", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "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", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "error_code": null, "life_cycle_state": "COMPLETED", "error_description": null, "communication": { "life_cycle_state": "COMPLETED", "number": "CM003003", "id": "B10683F37EFC4490B09BC9D7CB92BF7A", "subject": "Testing", "contact_information": { "last_name": "Anton", "middle_name": "333", "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Mrs", "first_name": "Mara", "type": "PERSON", "id": "3358197AD0334CE2834DB60933B2CE88", "name": null, "company_name": null, "demographics": { "gender": "FEMALE", "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "568941", "industry": null, "id_issued_by_country": null } } }, "number": "2699", "id": "3214F9AC59B34A52B02BCC0576B8587A", "communication_queue_external_system": { "id": "DC30CF64A5F4426A84F1E9E76281443A", "name": "EXT 1", "alternative_code": "E1" } } ] }
HTTP Method: GET
Request:
Response:
{ "status": { "message": "", "description": "", "code": "OK" }, "data": [ { "log_information": { "updated_date": "2016-05-06T10:46:13", "created_date": "2016-05-06T10:46:13", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "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", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "error_code": null, "life_cycle_state": "COMPLETED", "error_description": null, "communication": { "life_cycle_state": "COMPLETED", "number": "CM002486", "id": "EC919C4132E44608A16C51345801FD52", "subject": null, "contact_information": { "last_name": "Papapavlou", "middle_name": null, "life_cycle_state": "MARKETING", "company_profile": null, "title": null, "first_name": "Lucia", "type": "PERSON", "id": "BD4FADA34FE94CC79FA2D6B19095C948", "name": null, "company_name": null, "demographics": { "gender": null, "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "SNLP001", "industry": null, "id_issued_by_country": null } } }, "number": "2231", "id": "38541560C7E84730960481380A496762", "communication_queue_external_system": null }, { "log_information": { "updated_date": "2016-05-06T10:46:13", "created_date": "2016-05-06T10:46:12", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "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", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "error_code": null, "life_cycle_state": "COMPLETED", "error_description": null, "communication": { "life_cycle_state": "COMPLETED", "number": "CM002485", "id": "382CC99BDDA94D3EAC2D5A9664C8C771", "subject": null, "contact_information": { "last_name": "Papapavlou", "middle_name": null, "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Miss", "first_name": "Loukia", "type": "PERSON", "id": "37072CF6ED884737B6592A7CBB6D5342", "name": null, "company_name": null, "demographics": { "gender": "FEMALE", "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "LP1234", "industry": null, "id_issued_by_country": null } } }, "number": "2230", "id": "7F5F857865A24F8796856C3CAEFE9E84", "communication_queue_external_system": null }, { "log_information": { "updated_date": "2016-05-06T10:12:19", "created_date": "2016-05-06T10:12:18", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "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", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "error_code": null, "life_cycle_state": "COMPLETED", "error_description": null, "communication": { "life_cycle_state": "COMPLETED", "number": "CM002484", "id": "06EFB1BC15674BFAA69EF5CFD5F46AFA", "subject": null, "contact_information": { "last_name": "Papapavlou", "middle_name": null, "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Miss", "first_name": "Loukia", "type": "PERSON", "id": "37072CF6ED884737B6592A7CBB6D5342", "name": null, "company_name": null, "demographics": { "gender": "FEMALE", "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "LP1234", "industry": null, "id_issued_by_country": null } } }, "number": "2229", "id": "DCFFC6F6290844B89CD6ABCCD022917C", "communication_queue_external_system": null }, { "log_information": { "updated_date": "2015-06-10T11:07:20", "created_date": "2015-06-10T11:07:20", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "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", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "error_code": null, "life_cycle_state": "PENDING", "error_description": null, "communication": { "life_cycle_state": "COMPLETED", "number": "CM001117", "id": "7231E98516044A1DAFF1941745EA0ED6", "subject": null, "contact_information": { "last_name": "Mika", "middle_name": "m", "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Mr", "first_name": "Darko", "type": "PERSON", "id": "531C8308457947EFAFA91776AA4F4B4E", "name": null, "company_name": null, "demographics": { "gender": "MALE", "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "1457889", "industry": null, "id_issued_by_country": null } } }, "number": "986", "id": "86B26957A08848C59554C6DEF4BA3890", "communication_queue_external_system": { "id": "234CC2ED054D47BF6C70088A777513C2", "name": "External SMS System", "alternative_code": "ESMSS" } } ] }
- No labels