Feed API Parameters
This table defines the parameters used by the feed API. The table below this one identifies which parameters apply to each feed type and whether they are required or optional.
Note | Email feeds contain parameters not used by other feed types. For information about parameters for email feeds, see Email Feed API Parameters. |
|
Parameter name |
Description |
Notes |
|---|---|---|
|
authenticationPassword |
The password for the username provided for an account. |
String |
|
authenticationUsername |
The username for an account. |
String |
|
authToken |
This is the oAuth access token. |
String |
|
changeStamp |
The change stamp of the feed record. |
Integer. Defaults to 0. Required for PUT (update). Is returned in GET. |
|
chatJoinTimeout |
The amount of time (in seconds) that the agent has to join the chat room. | |
|
chatInactivityTimeout |
The amount of idle time (in seconds) between chat messages. If a chat message is not sent in this amount of time, the chat session is taken down. | |
|
description |
The description of the feed. |
String |
|
|
A collection of parameters specific to creating an email feed. |
For information about these email-specific parameters, see Email Feed API Parameters. For an example of an email feed, see POST (Create an IMAP Email Feed). |
|
minAge |
The minimum post age in seconds (defaults to 0). |
If a post is newer than the minAge, it will not be stored by the feed. |
|
name |
The name of the feed. |
String, must be unique. Required for creating (POST). |
|
pollingInterval |
The amount of time in seconds the system waits between attempts to read this feed. |
Integer |
|
pushFeedURL |
The URL to which you push the entities that will become social contacts. | |
|
refURL |
A copy of the URL requested. |
Response for GET. |
|
replyTemplateRefURL |
The URL of the reply template used to respond to social contacts obtained from this feed. |
String If this field is blank, no reply template is used. |
| status | The authorization status for feed. |
Values are:
|
|
summary |
Determines whether full object information or URLs only are returned for the list. |
Boolean. Defaults to false. When "true", only the URLs of the objects are returned. If summary=false, full object information, along with the URL reference, is returned. URL Parameter. Used for List API only. |
|
tags |
Contacts coming in from this feed will automatically be tagged with these default tags. |
String. A maximum of 10 tags are allowed. |
|
type |
The feed type. |
Required for POST Integer, types are:
|
|
url |
The location of the feed that you want to read. |
String |
This table summarizes the fields used by each feed type as R (required), O (optional), or NA (not applicable).
Note | This table does not include information about email feed parameters. For information about which email feed parameters are required or optional, see Email Feed API Parameters. |
|
Feed type/ Field name |
Push (7) |
Chat (8) |
Callback (10)/Task (12) |
|---|---|---|---|
|
type | R | R | R |
|
name | R | R | R |
|
description | O | O | O |
|
url | NA | NA | NA |
|
polling interval | NA | NA | NA |
|
minAge | NA | NA | NA |
|
authentication Username | NA | NA | NA |
|
authentication Password | NA | NA | NA |
|
keywords | NA | NA | NA |
|
authToken | NA | NA | NA |
|
chatJoin Timeout | NA | O | NA |
|
chat Inactivity Timeout | NA | O | NA |
|
reply Template RefURL | O | O | O |
|
tags | O | O | O |