communications

communications/configuration
- GET communications/configuration/queue_external_systems/list — This method returns the communication queue external systems that are allowed to be used in communications. Multiple communication queue external systems are returned by each call
- GET communications/configuration/categories/list — This method returns the communication categories that are allowed to be used by communications. Multiple communications categories are returned by each call
- GET communications/configuration/queue_systems/list — This method returns the communication queue systems that are allowed to be used in communications. Multiple communication queue systems are returned by each call
- GET communications/configuration/templates/list — This method returns the communication templates that are allowed to be used in communications. Multiple communication templates are returned by each call. Note that only effective communication templates are retrieve by this method.
GET communication_plan/preview — This method returns the customers that will be communicated through a specific communication plan.
GET communications/list — This method returns information related with a communication. Multiple communications are returned by each call
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
GET communications/queue/get_pending_completed — 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
GET communications/queue/list — This method returns information related with communication queue entries. Multiple communication queue entries are returned by each call
GET communications/queue/show — This method returns information related with a communication queue entry. Single communication queue entry is returned by each call
GET communications/show — This method returns information related with a communication. A single communication is returned by each call
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.
POST communications/create — This method creates a communication. A single communication can be created by each call.
POST communications/queue/process — This method is used to set the life cycle state of a communication queue entry to processed
POST communications/queue/reject — This method is used to set the life cycle state of a communication queue to rejected
POST communications/queue/remove — This method is used by external systems in order to set the life cycle state of a communication queue to "Completed and Removed".
POST communications/set_as_viewed — 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.
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.