| Excerpt |
|---|
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 | ||||||
| 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 |
...