| Tip |
|---|
Available from CRM.COM R4.0.0 |
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| communication_identifier (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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
contact_information_identifier (semi-optional) | Contact Information identifier | 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:
| ||||||
| category_identifier (semi-optional) | Communication category Identifier | The identifier of the communication category. The allowed communication category identifier fields are the following:
| ||||||
direction (optional) | String | The communication direction which can be INCOMING or OUTGOING | ||||||
media (optional) | String | The media that was used to send or receive the communication, which can be EMAIL, SMS, PHONE, LETTER, FACE_TO_FACE | ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
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
| ||||||
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 |
...
Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||||||||||||
contact_information_identifier (mandatory) | Contact Information Identifier | The contact information related with the communication. The allowed contact information identifiers are the following:
| ||||||||||||||||||
template_identifier (optional) | Communication template Identifier | 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) | Category Identifier | The category of the communication. The allowed communication category identifiers are the following:
| ||||||||||||||||||
communication_queue_external_system_identifier (optional) | Communication Queue External System Identifier | The communication queue external system. The allowed communication queue external system identifiers are the following:
| ||||||||||||||||||
direction (mandatory unless template is specified) | String | The communication direction which can be INCOMING or OUTGOING | ||||||||||||||||||
media (mandatory unless template is specified) | String | The media that was used to send or receive the communication, which can be EMAIL, SMS, PHONE, LETTER, F2F | ||||||||||||||||||
subject (mandatory unless template is specified) | String | The subject of the communication | ||||||||||||||||||
content (mandatory unless template is specified) | String | The content of the communication | ||||||||||||||||||
to (mandatory only if media is email) | String | The sender of the communication which holds different type of information based on the selected media and direction. | ||||||||||||||||||
notes (optional) | String | Notes for the communication | ||||||||||||||||||
life_cycle_state (optional) | String | 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 identifier of the owned by group information | The owned by group information of the activity. The allowed group identifier fields are the following:
| ||||||||||||||||||
privacy_level_identifier (optional) | The identifier of the privacy level | The privacy level of the activity. The allowed privacy level identifier fields are the following:
| ||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_8 (optional) | String | 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 | ||||||||||||||||||
(optional) | Referring to object | The entities which are related with the communication and can include Subscriptions, Activities, Jobs, Communications, Accounts Receivable, Bill, Notifications and
| ||||||||||||||||||
(optional) | Set of Communications Unrestricted Parameter objects | A list of all the unrestricted parameters that should be defined for the specific communication
| ||||||||||||||||||
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
|
| Anchor | ||||
|---|---|---|---|---|
|
...
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||||||
communication_identifier (mandatory) | Communication Identifier | The communication that should be updated. The allowed contact information identifiers are the following:
| ||||||||||||
template_identifier (optional) | Communication template Identifier | 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) | Category Identifier | The category of the communication. The allowed communication category identifiers are the following:
| ||||||||||||
communication_queue_external_system_identifier (optional) | Communication Queue External System Identifier | The communication queue external system. The allowed communication queue external system identifiers are the following:
| ||||||||||||
direction (optional) | String | The communication direction which can be INCOMING or OUTGOING | ||||||||||||
media (optional) | String | The media that was used to send or receive the communication, which can be EMAIL, SMS, PHONE, LETTER, F2F | ||||||||||||
subject (optional) | String | The subject of the communication | ||||||||||||
content (optional) | String | The content of the communication | ||||||||||||
to (optional) | String | The sender of the communication which holds different type of information based on the selected media and direction. | ||||||||||||
notes (optional) | String | Notes for the communication | ||||||||||||
life_cycle_state (optional) | String | 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 identifier of the owned by group information | The owned by group information of the activity. The allowed group identifier fields are the following:
| ||||||||||||
privacy_level_identifier (optional) | The identifier of the privacy level | The privacy level of the activity. The allowed privacy level identifier fields are the following:
| ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_8 (optional) | String | 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 | ||||||||||||
(optional) | Referring to object | The entities which are related with the communication and can include Subscriptions, Activities, Jobs, Communications, Accounts Receivable, Bill, Notifications and
| ||||||||||||
(optional) | Set of Communications Unrestricted Parameter objects | A list of all the unrestricted parameters that should be defined for the specific communication.
| ||||||||||||
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 |
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
| communication_identifier (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 |
...
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.
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
| communication_identifier (mandatory) | Identifier | The identifier of the communication that should be set as viewed. The allowed communication identifier fields are the following:
| ||||||
viewed_on (optional) | Date | 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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| communication_queue_identifier (mandatory) | Communication queue Identifier | The identifier of the communication queue. The allowed communication queue identifier fields are the following:
| ||||||
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 |
...
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:
| ||||||||
life_cycle_state (optional) | String | The life cycle state of the retrieved communication queue entry which can be PENDING, REJECTED, COMPLETED or COMPLETED_AND_REMOVED
| ||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||||
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
| ||||||||
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 |
...
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 (mandatory) | Number | 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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| communication_queue_identifier (mandatory) | Communication queue Identifier | The identifier of the communication queue. The allowed communication queue identifier fields are the following:
| ||||||
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.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| communication_queue_identifier (mandatory) | Communication queue Identifier | The identifier of the communication queue. The allowed communication queue identifier fields are the following:
| ||||||
error_code (mandatory) | String | The code of a possible error that occur while processing the communication queue entry | ||||||
error_description (mandatory) | String | The description of a possible error that might occur while processing the communication queue entry | ||||||
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.
...
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".
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| communication_queue_identifier (mandatory) | Communication queue Identifier | The identifier of the communication queue. The allowed communication queue identifier fields are the following:
| ||||||
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
|
...
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
...
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 (optional) | Number | The number of communications to be retrieved from the queue, starting from the latest one | ||||||
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
| ||||||
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 |
...