Tip |
---|
Available from CRM.COM R4.0.0 |
Table of Contents | ||
---|---|---|
|
GET notifications/show
This method returns information related with a notification. A single notification is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(semi-optional)
...
Notification identifier
The identifier of the notification that should be returned as a result. The allowed notification identifier fields are the following:
...
communication_identifier
(semi-optional)
...
The identifier of the communication that was created for the notification 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:
|
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET notifications/list
This method returns information related with notifications. Multiple notifications are returned by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
type_identifier
(semi-optional)
...
The identifier of the notification type related with the notification that should be returned as a result. The allowed notification type identifier fields are the following:
...
notification_run_identifier
(semi-optional)
...
The identifier of the notification run that created the notifications that should be returned as a result. The allowed notification run identifier fields are the following:
...
Tip |
---|
Deprecated from CRM.COM R12.0.0 |
...
contact_information_identifier
(optional)
...
The identifier of the contact information notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:
...
accounts_receivable_identifier
(optional)
...
The identifier of the accounts receivable notified by the notifications that should be returned as a result. The allowed contact information 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:
|
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET notifications/get_latest_in_queue
This method returns the latest notifications having a communication created and also pending in the communication queue. Multiple notifications are returned by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
type_identifier
(semi-optional)
...
The identifier of the notification type related with the notification that should be returned as a result. The allowed notification type identifier fields are the following:
...
notification_run_identifier
(semi-optional)
...
The identifier of the notification run that created the notifications that should be returned as a result. The allowed notification run identifier fields are the following:
...
Tip |
---|
Deprecated from CRM.COM R12.0.0 |
...
communication_queue_external_system_identifier
(optional)
...
The identifier of the external system that should process the notification communication through the communication queue. The allowed communication queue external system identifier fields are the following:
...
contact_information_identifier
(optional)
...
The identifier of the contact information notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:
...
accounts_receivable_identifier
(optional)
...
The identifier of the accounts receivable notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:
...
number
(mandatory)
...
The number of notifications to be retrieved, 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 | ||||||
---|---|---|---|---|---|---|
| ||||||
Code Block | ||||||
| ||||||
Panel | ||||||
| ||||||
|