| Tip |
|---|
Available from CRM.COM R4.0.0 |
GET communications/show
This method returns information related with a communication. A single communication is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Identifier
The identifier of the communication that should be returned as a result. The allowed communication identifier fields are the following:
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"notes": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "CM000680",
"udf_float_4": null,
"udf_string_1": null,
"follow_up_set":
[
],
"communication_queue_external_system": null,
"udf_string_2": null,
"privacy_level": null,
"contact_information":
{
"last_name": "Clark",
"middle_name": "S.",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Kathy",
"type": "PERSON",
"id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
"name": "Clark Kathy",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "88996633",
"passport_number": "4564455",
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day":
{
"month": 1,
"day": 1
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1980
},
"id_number": "87878000",
"industry": null,
"id_issued_by_country": null
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"id": "AFC7A8F8F2174A099CDC3AD168B85B3E",
"media": "EMAIL",
"udf_date_1": null,
"udf_date_2": null,
"referring_to":
{
"payment_gateway_card":
{
"expiration_month": 6,
"payment_gateway_reference_number": "card_15WlpWE0IcJRGs11IN3Sm8cd",
"brand": "Visa",
"type": null,
"id": "D7F36E20368C4CBB8A93C85B18755880",
"expiration_year": 2019,
"card_holder_name": "Kathy Clark",
"last_digits": "**** **** **** 5556"
},
"service_request": null,
"payment":
{
"payment_amount": 20,
"issued_on": "2014-10-27T10:40:32",
"life_cycle_state": "POSTED",
"number": "182",
"id": "21AAC918C91E0295113CEA1FC550E85C",
"reference_number": "198",
"posted_on": "2014-10-27T10:41:16"
},
"bill": null,
"notification":
{
"life_cycle_state": "COMPLETED",
"accounts_receivable": null,
"number": "187",
"id": "619B766FAD6699F09383A5EED04CDBFB",
"contact_information":
{
"last_name": "Clark",
"middle_name": "S.",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Kathy",
"type": "PERSON",
"id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
"name": null,
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "88996633",
"passport_number": "4564455",
"industry_sector": null,
"name_day":
{
"month": 1,
"day": 1
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1980
},
"id_number": "87878000",
"industry": null,
"id_issued_by_country": null
}
}
},
"activity": null,
"spend_reward_transaction": null,
"award_reward_transaction": null,
"accounts_receivable": null,
"communication": null,
"rewards_participant": null,
"payment_gateway_request":
{
"life_cycle_state": "POSTED",
"execution_date": null,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Clark",
"middle_name": "S.",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Kathy",
"type": "PERSON",
"id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
"name": null,
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "88996633",
"passport_number": "4564455",
"industry_sector": null,
"name_day":
{
"month": 1,
"day": 1
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1980
},
"id_number": "87878000",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "253",
"id": "3CCC9B1B4D2AB43F57E49751DF63B916",
"name": "CityFlat Sub"
},
"payment": null,
"bill":
{
"total_amount_to_be_paid": 497.41,
"to_date": null,
"from_date": null,
"life_cycle_state": "PRESENTED",
"total_billed_amount": 10,
"number": "BL000102",
"bill_status": null,
"id": "294822C19247401784A2414B0AD95D75"
},
"number": "1",
"id": "3246C278AF1C4ED0A68E68C0AA985C79"
},
"lead": null,
"subscription": null,
"job": null
},
"udf_date_3": null,
"from": "e_michailidou@crm.com",
"udf_date_4": null,
"subject": " Information for your STRIPE Payment Registered Card",
"code": "657",
"log_information":
{
"updated_date": "2015-04-30T13:23:51",
"created_date": "2015-02-19T09:48:00",
"created_by_unit":
{
"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":
{
"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": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"owned_by_group":
{
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"life_cycle_state": "DRAFT",
"content": "Dear Kathy Clark We would like to notify you that you Card registered for use via STRIPE Payment Method and linked with your Account CityFlat Sub and Num 253 will be expired next month. Below you will find your Card and Account details: The expiration month of the card: 2 The expiration date of the card: 2/2015 The card holder name: Kathy Clark253 The brand of the card: Visa The type of the card: The cards last four digits: 4242 Account Balance: 510.41 Account Outstanding Amount: 510.41000000000002501110429875552654266357421875 Please contact our Customer Centre to update your Card details and avoid any disconnections which will be due to failures of your recurring payments Regards AluxSat Co",
"to": "eleni.sites@gmail.com",
"category":
{
"id": "E7A5682FD665927F9C04723E9E79C42D",
"name": "Customer Care Information",
"description": "Customer Care Information",
"code": "cci"
},
"direction": "OUTGOING"
}
}
|
|
GET communications/list
This method returns information related with a communication. Multiple communications are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
contact_information_identifier (semi-optional)
...
The identifier of the contact information related with the communication that will be returned as results. The allowed contact information identifier fields are the following:
...
(semi-optional)
...
Communication category Identifier
The identifier of the communication category. The allowed communication category identifier fields are the following:
...
direction
(optional)
...
media
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
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
| Tip |
|---|
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 at least one of the semi-optional parameters. Both of those parameters are allowed to be specified.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"number": "77",
"udf_string_1": null,
"follow_up_set": null,
"udf_string_2": null,
"communication_queue_external_system": null,
"privacy_level": null,
"contact_information":
{
"last_name": "Michael",
"life_cycle_state": "FINANCIAL",
"middle_name": "A",
"company_profile": null,
"title": "Mrs",
"type": "PERSON",
"first_name": "Elena",
"name": "Elena Michael",
"id": "2A3FD24CF1586E31D9DC7CAF43C38A96",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "CYPRUS",
"id": "181"
},
"industry_sector": null,
"date_of_birth":
{
"month": 1,
"day": 6,
"year": 1980
},
"name_day":
{
"month": 5,
"day": 21
},
"id_number": "878787",
"id_issued_by_country": null,
"industry": null
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"id": "49EFA6FADA3FA0C1562B5DBC16C512FA",
"media": "EMAIL",
"udf_date_1": null,
"udf_date_2": null,
"referring_to":
{
"notification":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriakos",
"name": null,
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"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": "87878000",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "195",
"name": "Xenofontos",
"id": "5B51429862A7BCBAD60CC81982BBD45B"
},
"life_cycle_state": null,
"number": "1",
"id": "B3064E16981C76A0A61D3C1FFF54993C",
"contact_information":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriakos",
"name": null,
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"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": "87878000",
"id_issued_by_country": null,
"industry": null
}
}
}
},
"udf_date_3": null,
"from": "test@gmail.com",
"udf_date_4": null,
"subject": "Template",
"code": "63",
"owned_by_group":
{
"community_name": null,
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"log_information":
{
"updated_date": "2014-09-23T13:43:52",
"created_by_unit":
{
"community_name": null,
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-09-19T12:45:56",
"updated_by_unit":
{
"community_name": null,
"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": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"life_cycle_state": "COMPLETED",
"content": "Content",
"to": "e_michael@crm.com",
"category":
{
"name": "000",
"id": "85ED9457795B97D0AD826E1D8EBBB8AF",
"description": "000",
"code": "000"
},
"direction": "OUTGOING"
},
....
} |
|
POST communications/create
This method creates a communication. A single communication can be created by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
contact_information_identifier
(mandatory)
...
The contact information related with the communication. The allowed contact information identifiers are the following:
...
template_identifier
(optional)
...
The communication template that will be used to automatically set communication information such as the direction, media, subject and content. The allowed communication template identifiers are the following:
...
category_identifier
(optional)
...
The category of the communication. The allowed communication category identifiers are the following:
...
communication_queue_external_system_identifier
(optional)
...
The communication queue external system. The allowed communication queue external system identifiers are the following:
...
direction
(mandatory unless template is specified)
...
media
(mandatory unless template is specified)
...
subject
(mandatory unless template is specified)
...
The subject of the communication
...
content
(mandatory unless template is specified)
...
to
(mandatory only if media is email)
...
notes
(optional)
...
life_cycle_state
(optional)
...
The lifecycle state of the retrieved communication which can be DRAFT or COMPLETED. If not specified then the communication is created as COMPLETED
...
owned_by_group_identifier
(optional)
...
The owned by group information of the activity. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the activity. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
referring_to
(optional)
...
and
| Status |
|---|
| colour | Green |
|---|
| title | Available from CRM.COM R5.0.0 |
|---|
|
Service Requests, Rewards Participants, Award Transactions, Spend Transactions, Leads| Status |
|---|
| colour | Blue |
|---|
| title | Available from CRM.COM R8.0.0 |
|---|
|
Buy in Advance Requests, Access Tokens| Status |
|---|
| colour | Blue |
|---|
| title | Available from CRM.COM R12.0.0 |
|---|
|
Purchase Customer Events, Spend Request Customer Events...
unrestricted_parameter_set
(optional)
...
A list of all the unrestricted parameters that should be defined for the specific communication
| Tip |
|---|
Available from CRM.COM R9.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
| 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.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"1B4D09A2C62B477791544314C3847FE5",
"contact_information_identifier":{"id":"31260911295E70BB660EBEB0C4F941AC"},
"direction":"OUTGOING",
"media":"EMAIL",
"subject":"Subscription Notice",
"to":"mariosmichael88@gmail.com",
"content":"We would like to remind you that your Subscription #subscription.number is overdue. Please pay by 23-January to avoid disconnections.",
"referring_to":
{
"subscription_identifier":{"number":"S60302"},
}
}
|
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"notes": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"number": "554",
"udf_string_1": null,
"follow_up_set":
[
],
"udf_string_2": null,
"communication_queue_external_system": null,
"privacy_level": null,
"contact_information":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Kyriacos",
"name": "Kyriacos Xenofontos",
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"passport_number": "3463463",
"social_security_number": "73473567",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": 5,
"day": 6,
"year": 1988
},
"name_day":
{
"month": 5,
"day": 3
},
"id_number": "87878000",
"id_issued_by_country":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry": null
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"id": "74570FC2E74547F78AFD82D63F010A92",
"media": "EMAIL",
"udf_date_1": null,
"udf_date_2": null,
"referring_to":
{
"award_reward_transaction": null,
"accounts_receivable": null,
"service_request": null,
"communication": null,
"bill": null,
"rewards_participant": null,
"notification": null,
"lead": null,
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Kyriacos",
"name": "Kyriacos Xenofontos",
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"passport_number": "3463463",
"social_security_number": "73473567",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": 5,
"day": 6,
"year": 1988
},
"name_day":
{
"month": 5,
"day": 3
},
"id_number": "87878000",
"id_issued_by_country":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "195",
"name": "Xenofontos",
"id": "5B51429862A7BCBAD60CC81982BBD45B"
},
"life_cycle_state": "EFFECTIVE",
"number": "S60302",
"type":
{
"name": "London",
"id": "3100B0D56E7C7EADF073C34BCE1E42AF",
"description": "For Subscribers residing in London
",
"alternative_code": "LND"
},
"id": "9C684858373B49FF97668E4FD9281357"
},
"job": null,
"activity": null,
"spend_reward_transaction": null
},
"udf_date_3": null,
"from": "info@crm.com",
"udf_date_4": null,
"subject": "Subscription Notice",
"code": "534",
"owned_by_group":
{
"community_name": "Main Community",
"name": "Collaboration Group 1",
"id": "F2992C3F2976F6B80D1F236628916141",
"description": null,
"alternative_code": "CG1"
},
"log_information":
{
"updated_date": "2015-03-07T12:48:28",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-03-07T12:48:28",
"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"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1"
}
},
"life_cycle_state": "COMPLETED",
"content": "We would like to remind you that your Subscription S60302 is overdue. Please pay by 23-January to avoid disconnections.",
"to": "mariosmichael88@gmail.com",
"category": null,
"direction": "OUTGOING"
}
} |
|
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"6EC469B056564F10BF5C24EFF703BEF6",
"contact_information_identifier":{"id":"531C8308457947EFAFA91776AA4F4B4E"},
"direction":"OUTGOING",
"media":"EMAIL",
"subject":"Unbound Test",
"to":"m_michael@crm.com",
"life_cycle_state":"DRAFT",
"content":"We would like to remind you that #unrestricted_string.name left the building. STRING: #unrestricted_string.test Please pay by 23-January to avoid disconnections. DATE: #unrestricted_date.date FLOAT: #unrestricted_float.float #unrestricted_float.newfl ",
"unrestricted_parameter_set":
[
{
"type":"STRING",
"string_value":"Marios",
"name":"name"
},
{
"type":"STRING",
"string_value":"test2",
"name":"test"
},
{
"type":"FLOAT",
"float_value":"10",
"name":"float"
},
{
"type":"DATE",
"date_value":"2014-05-05T15:49:59",
"name":"date"
}
]
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"unrestricted_parameter_set":
[
{
"integer_value": null,
"date_value": null,
"string_value": null,
"type": "FLOAT",
"id": "80C490A1FE19493790A5B1393CC1EC68",
"name": "float",
"float_value": 10,
"key": "unrestricted_float.float"
},
{
"integer_value": null,
"date_value": "Mon May 05 15:49:59 EEST 2014",
"string_value": null,
"type": "DATE",
"id": "5BA839A8B0AB46198A2BA0F8A27E9659",
"name": "date",
"float_value": null,
"key": "unrestricted_date.date"
},
{
"integer_value": null,
"date_value": null,
"string_value": "Marios",
"type": "STRING",
"id": "08645766E4DF4763814D073E29AD5910",
"name": "name",
"float_value": null,
"key": "unrestricted_string.name"
},
{
"integer_value": null,
"date_value": null,
"string_value": "test2",
"type": "STRING",
"id": "A5CE0C3898E44D9E9D8F9A459AC61500",
"name": "test",
"float_value": null,
"key": "unrestricted_string.test"
}
],
"notes": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "CM001634",
"udf_float_4": null,
"udf_string_1": null,
"follow_up_set":
[
],
"communication_queue_external_system": null,
"udf_string_2": null,
"privacy_level": 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": "Mika Darko",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": 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
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"id": "A560FF21AA9D42FFBD46B6519B4B40EA",
"media": "EMAIL",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"from": "dev@crm.com",
"referring_to":
{
"payment_gateway_card": null,
"service_request": null,
"payment": null,
"bill": null,
"notification": null,
"activity": null,
"spend_reward_transaction": null,
"award_reward_transaction": null,
"buy_in_advance_request": null,
"accounts_receivable": null,
"communication": null,
"rewards_participant": null,
"payment_gateway_request": null,
"lead": null,
"subscription": null,
"job": null
},
"udf_date_4": null,
"subject": "Unbound Test",
"code": "1579",
"log_information":
{
"updated_date": "2015-11-19T09:38:57",
"created_date": "2015-11-19T09:38:52",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"owned_by_group":
{
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"life_cycle_state": "DRAFT",
"content": "We would like to remind you that Marios left the building. STRING: test2 Please pay by 23-January to avoid disconnections. DATE: Mon May 05 15:49:59 EEST 2014 FLOAT: 10 #unrestricted_float.newfl ",
"to": "m_michael@crm.com",
"category": null,
"direction": "OUTGOING"
}
} |
|
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"{{token}}",
"contact_information_identifier":{"id":"475904FB959FE8D3DDAEB22FBFEC5FFB"},
"direction":"OUTGOING",
"media":"EMAIL",
"subject":"Subscription Notice",
"to":"mariosmichael88@gmail.com",
"content":"We would like to remind you that your Subscription #subscription.number is overdue. Please pay by 23-January to avoid disconnections.",
"referring_to":
{
"subscription_identifier":{"number":"S60105"},
},
"fields_set":"contact_information,media,subject,subscription"
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"media": "EMAIL",
"subject": "Subscription Notice",
"contact_information": {
"last_name": "Mercer",
"middle_name": "111111111",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Ben11 omonoia",
"type": "PERSON",
"id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
"name": "Mercer Ben11 omonoia",
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": {
"three_character_code": "AND",
"two_character_code": "AD",
"id": "132",
"name": "ANDORRA",
"alternative_code": null
},
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": 6,
"day": 14
},
"date_of_birth": {
"month": 11,
"day": 9,
"year": 1963
},
"id_number": "1212125",
"industry": {
"id": "31BC2070C79EAE5455BFAD41599C5190",
"name": "Marketing1",
"code": "MK"
},
"id_issued_by_country": {
"three_character_code": "DZA",
"two_character_code": "DZ",
"id": "130",
"name": "ALGERIA",
"alternative_code": null
}
}
}
}
} |
|
POST communications/update
This method updates a communication. Single communication can be updated by each call. Only draft communications can be updated. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
communication_identifier
(mandatory)
...
The communication that should be updated. The allowed contact information identifiers are the following:
...
template_identifier
(optional)
...
The communication template that will be used to automatically set communication information such as the direction, media, subject and content. The allowed communication template identifiers are the following:
...
category_identifier
(optional)
...
The category of the communication. The allowed communication category identifiers are the following:
...
communication_queue_external_system_identifier
(optional)
...
The communication queue external system. The allowed communication queue external system identifiers are the following:
...
direction
(optional)
...
media
(optional)
...
subject
(optional)
...
The subject of the communication
...
content
(optional)
...
to
(optional)
...
notes
(optional)
...
life_cycle_state
(optional)
...
The lifecycle state of the retrieved communication which can be DRAFT or COMPLETED. If not specified then the communication is created as COMPLETED
...
owned_by_group_identifier
(optional)
...
The owned by group information of the activity. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the activity. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
referring_to
(optional)
...
| Status |
|---|
| colour | Green |
|---|
| title | Available from CRM.COM R5.0.0 |
|---|
|
Service Requests, Rewards Participants, Award Transactions, Spend Transactions, Leads| Status |
|---|
| colour | Blue |
|---|
| title | Available from CRM.COM R8.0.0 |
|---|
|
Buy in Advance Requests...
unrestricted_parameter_set
(optional)
...
A list of all the unrestricted parameters that should be defined for the specific communication.
...
| Tip |
|---|
Available from CRM.COM R9.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
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"9FDAD3358048E75F08B504A9E85315BD",
"communication_identifier":{"number":"290"},
"template_identifier":{"name":"Subscription Information"},
"content":"Dear #contact_information.first_name we would like to inform you that the subscription #subscription.number is #subscription.life_cycle_state subscription",
"referring_to" : { "lead_identifier" : {"number" : "60"} }
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"number": "290",
"udf_string_1": null,
"follow_up_set": null,
"udf_string_2": null,
"communication_queue_external_system": null,
"privacy_level": null,
"contact_information":
{
"last_name": "Paulou",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Paulos",
"name": "Paulos Paulou",
"id": "82E762747ABB3A87D5EB6DE58CC71F1E",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "JAPAN",
"id": "237"
},
"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
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"id": "BE46BADA62B8E7710C91EC9ED5373EF9",
"media": "EMAIL",
"udf_date_1": null,
"udf_date_2": null,
"referring_to":
{
"lead":
{
"life_cycle_state": "PENDING",
"number": "60",
"id": "84E75C50C44E67F8E545458179646CBB",
"description": null,
"contact_information":
{
"last_name": "Paulou",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Paulos",
"name": null,
"id": "82E762747ABB3A87D5EB6DE58CC71F1E",
"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
}
}
},
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Paulou",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Paulos",
"name": "Paulos Paulou",
"id": "82E762747ABB3A87D5EB6DE58CC71F1E",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "JAPAN",
"id": "237"
},
"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
}
},
"life_cycle_state": "ACTIVE",
"number": "74",
"name": "Paulou",
"id": "2D2252B13ADE97C20E5AE89A2FDE79B4"
},
"life_cycle_state": "CANCELLED",
"number": "S60052",
"type":
{
"name": "Normal Subscription",
"id": "6BB2B984CC9309775D06650C7493A836",
"description": null,
"alternative_code": "ST"
},
"id": "E8B11F7565F50496A1FD94B6447BEE0C"
}
},
"udf_date_3": null,
"from": "activeDef@crm.com",
"udf_date_4": null,
"subject": " Information for subscription S60052",
"code": "270",
"owned_by_group":
{
"community_name": null,
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"log_information":
{
"updated_date": "2015-02-18T15:53:59",
"created_by_unit":
{
"community_name": null,
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-01-23T11:57:09",
"updated_by_unit":
{
"community_name": null,
"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": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"life_cycle_state": "DRAFT",
"content": "Dear Paulos we would like to inform you that the subscription S60052 is CANCELLED subscription",
"to": "paulos@crm.com",
"category": null,
"direction": "OUTGOING"
}
} |
|
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"E308F1E28F194720A0280B4B6DD56C6C",
"life_cycle_state":"DRAFT",
"communication_identifier":{"number":"CM001642"},
"subject":"We would like to #unrestricted_string.test remind you that #unrestricted_string.test_string #unrestricted_string.name left the building.#unrestricted_float.float #unrestricted_string.update",
"unrestricted_parameter_set":
[
{
"action":"add",
"type":"STRING",
"string_value":"test",
"name":"test_string"
},
{
"action":"update",
"unrestricted_parameter_identifier":{"name":"test"},
"string_value":"update",
"name":"update"
},
{
"action":"remove",
"unrestricted_parameter_identifier":{"key":"unrestricted_float.float "}
}
]
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"unrestricted_parameter_set":
[
{
"integer_value": null,
"date_value": null,
"string_value": "test",
"type": "STRING",
"id": "51675B3DF4D147F9A24B57E19F7C21A3",
"name": "test_string",
"float_value": null,
"key": "unrestricted_string.test_string"
},
{
"integer_value": null,
"date_value": null,
"string_value": "Marios",
"type": "STRING",
"id": "679CD7E2988C4AF5B7900FB48A0D1F46",
"name": "name",
"float_value": null,
"key": "unrestricted_string.name"
},
{
"integer_value": null,
"date_value": null,
"string_value": "update",
"type": "STRING",
"id": "DB3BD07D28BF4AC8B8AE35EC52E6BE3A",
"name": "update",
"float_value": null,
"key": "unrestricted_string.update"
},
{
"integer_value": null,
"date_value": "Mon May 05 15:49:59 EEST 2014",
"string_value": null,
"type": "DATE",
"id": "BADF9965686448E79986DF5EFD7F4BCB",
"name": "date",
"float_value": null,
"key": "unrestricted_date.date"
}
],
"notes": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "CM001642",
"udf_float_4": null,
"udf_string_1": null,
"follow_up_set":
[
],
"communication_queue_external_system": null,
"udf_string_2": null,
"privacy_level": 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": "Mika Darko",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": 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
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"id": "7442DAFB398743CDA11CD12C58B9ADF0",
"media": "EMAIL",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"from": "dev@crm.com",
"referring_to":
{
"payment_gateway_card": null,
"service_request": null,
"payment": null,
"bill": null,
"notification": null,
"activity": null,
"spend_reward_transaction": null,
"award_reward_transaction": null,
"buy_in_advance_request": null,
"accounts_receivable": null,
"communication": null,
"rewards_participant": null,
"payment_gateway_request": null,
"lead": null,
"subscription": null,
"job": null
},
"udf_date_4": null,
"subject": "We would like to #unrestricted_string.test remind you that test Marios left the building.#unrestricted_float.float update",
"code": "1587",
"log_information":
{
"updated_date": "2015-11-19T11:14:50",
"created_date": "2015-11-19T11:12:04",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"owned_by_group":
{
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"life_cycle_state": "DRAFT",
"content": "We would like to remind you that Marios left the building. STRING: test2 Please pay by 23-January to avoid disconnections. DATE: Mon May 05 15:49:59 EEST 2014 FLOAT: 10 #unrestricted_float.newfl ",
"to": "m_michael@crm.com",
"category": null,
"direction": "OUTGOING"
}
} |
|
POST communications/complete
This method completes a communication by setting its life cycle state to completed. Only draft communications can be specified in the parameters. Single communication can be completed by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Identifier
The identifier of the communication that should be returned as a result. The allowed communication identifier fields are the following:
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"B679A1250F36F8D4DAF607B2D83ED551",
"communication_identifier":{"number":"41"}
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"life_cycle_state": "COMPLETED",
"number": "41",
"id": "252F3A1A87C26866A1E1A1B18D6043EA",
"contact_information":
{
"last_name": "Spector",
"middle_name": null,
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Stephane",
"name": "Stephane Spector",
"id": "3DA4F031963FCAD2E299CB23190AF295",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "121212",
"social_security_number": null,
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "121212",
"id_issued_by_country": null,
"industry": null
}
}
}
} |
|
POST communications/set_as_viewed
| Tip |
|---|
Available from CRM.COM R12.2.0 |
This method sets the specified communication as viewed, offering as optional the ability to specify the viewed on date. Only completed communications can be specified in the parameters. Single communication can be completed by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Identifier
The identifier of the communication that should be set as viewed. The allowed communication identifier fields are the following:
...
viewed_on
(optional)
...
The date that the communication was viewed
If not specified, the viewed on date should be set as the current date
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"{{token}}",
"communication_identifier":{"number":"2781"}
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"data": {
"viewed_on": "Mon May 22 12:42:03 EEST 2017",
"number": "2781",
"subject": "Access Details",
"viewed": 1,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Xenopoulou",
"id": "71894DE2FC944DDD9E7B8C6626BB23C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Persia",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"id": "04F8A6F48E30433FA1B2ED3E0D84A9CD",
"life_cycle_state": "COMPLETED"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
|
GET communications/queue/show
This method returns information related with a communication queue entry. Single communication queue entry is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Communication queue Identifier
The identifier of the communication queue. The allowed communication queue identifier fields are the following:
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2014-10-07T16: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": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"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
}
} |
|
GET communications/queue/list
This method returns information related with 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
...
(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)
...
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)
...
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:
...
| Tip |
|---|
Available from CRM.COM R5.0.0 |
...
life_cycle_state
(optional)
...
The life cycle state of the retrieved communication queue entry which can be PENDING, REJECTED, COMPLETED or COMPLETED_AND_REMOVED
| Tip |
|---|
Life Cycle State COMPLETED_AND_REMOVED is available from CRM.COM R10.1.0 |
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
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
| Tip |
|---|
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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"log_information":
{
"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": "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": "COMPLETED",
"communication":
{
"life_cycle_state": "COMPLETED",
"number": "58",
"id": "A64E373760604E0380F667094674E47C",
"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": "2",
"id": "56C07F98AD477714FC915011095D307C",
"communication_queue_external_system": null
},
{
"log_information":
{
"updated_date": "2014-10-07T14:58:05",
"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": "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": "COMPLETED",
"communication":
{
"life_cycle_state": "COMPLETED",
"number": "65",
"id": "45542CFDBDBD14272FCD1B3DCF0A6609",
"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": "6",
"id": "C4CF001253372CBD041C3F84DE82DC39",
"communication_queue_external_system": null
},
{
"log_information":
{
"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": "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": "COMPLETED",
"communication":
{
"life_cycle_state": "COMPLETED",
"number": "65",
"id": "45542CFDBDBD14272FCD1B3DCF0A6609",
"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": "7",
"id": "6389A3A596C2BC83DB3449BE427811EF",
"communication_queue_external_system": null
},
....
} |
|
GET communications/queue/get_latest
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
...
(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)
...
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)
...
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:
...
| Tip |
|---|
Available from CRM.COM R5.0.0 |
...
number
(mandatory)
...
The number of communications to be retrieved from the queue, starting from the latest one
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| 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"
}
},
.....
} |
|
POST communications/queue/process
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
...
(mandatory)
...
Communication queue Identifier
The identifier of the communication queue. The allowed communication queue identifier fields are the following:
...
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.
Response Data
...
Examples
...
HTTP Method: POST
Request:
Body:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"token" : "F8B463306703A63FF1CF93DD832CD68B",
"communication_queue_identifier" : { "number" : "1" }
} |
Response:
| Code Block |
|---|
| 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
}
} |
...
HTTP Method: POST
Request:
Body:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"token":"{{token}}",
"communication_queue_identifier" : { "number" : "2" },
"fields_set":"number,id,communication"
} |
Response:
| Code Block |
|---|
| 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"
}
} |
POST communications/queue/reject
This method is used to set the life cycle state of a communication queue to rejected
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Communication queue Identifier
The identifier of the communication queue. The allowed communication queue identifier fields are the following:
...
error_code
(mandatory)
...
error_description
(mandatory)
...
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.
Response Data
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token" : "F8B463306703A63FF1CF93DD832CD68B",
"communication_queue_identifier" : { "number" : "9" },
"error_code" : "01",
"error_description" : "Communication definition is not configured."
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2014-11-11T15:51:19",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-09-15T13:02:04",
"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": "01",
"error_description": "Communication definition is not configured.",
"life_cycle_state": "REJECTED",
"communication":
{
"life_cycle_state": "COMPLETED",
"number": "70",
"id": "8152EA00439301ECC2FB57F2001E5433",
"contact_information":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriakos",
"name": null,
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"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": "87878000",
"id_issued_by_country": null,
"industry": null
}
}
},
"number": "9",
"id": "8AB1EBDE1854122C91B1EF8BD344BF62",
"communication_queue_external_system": null
}
} |
|
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"{{token}}",
"communication_queue_identifier" : { "number" : "10" },
"error_code" : "01",
"error_description" : "Communication definition is not configured.",
"fields_set":"number,id,communication"
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"communication": {
"life_cycle_state": "COMPLETED",
"number": "14",
"id": "D0C1DE5D9D2566EC6A26A45D5DFE899F",
"subject": "#activity.number",
"contact_information": {
"last_name": "Clark",
"middle_name": "S.",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Kathy",
"type": "PERSON",
"id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
"name": null,
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "88996633",
"passport_number": "4564455",
"industry_sector": null,
"name_day": {
"month": 1,
"day": 1
},
"date_of_birth": {
"month": 1,
"day": 1,
"year": 1980
},
"id_number": "87878000",
"industry": null,
"id_issued_by_country": null
}
}
},
"number": "10",
"id": "E970FDFD76788C14FCC87DF5A71AECC7"
}
} |
|
POST communications/queue/remove
| Tip |
|---|
Available from CRM.COM R11.0.0 |
This method is used by external systems in order to set the life cycle state of a communication queue to "Completed and Removed".
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Communication queue Identifier
The identifier of the communication queue. The allowed communication queue identifier fields are the following:
...
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
...
Examples
| Expand |
|---|
|
HTTP Method: POST Request: Body: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"DA65E787C4DD445082AF248F552E83AA",
"communication_queue_identifier":{"number":"2700"}
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"log_information": {
"updated_date": "2016-08-02T13:13:18",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"error_code": null,
"error_description": null,
"life_cycle_state": "COMPLETED_AND_REMOVED",
"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"
}
}
} |
|
GET communications/queue/get_pending_completed
| Tip |
|---|
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
...
(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)
...
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)
...
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)
...
The number of communications to be retrieved from the queue, starting from the latest one
| Tip |
|---|
For releases prior CRM.COM R13.0.0 the parameter's name is number |
...
offset
(optional)
...
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
| Tip |
|---|
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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
{
"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"
}
}
]
} |
|
| Expand |
|---|
|
HTTP Method: GET
Request:
Response:
| Code Block |
|---|
{
"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"
}
}
]
}| Panel |
|---|
|
| Child pages (Children Display) |
|---|
|
|