Articles in this section

Create RSS / XML feeds of your conversations (List: Feed)

Avatar
Permanently deleted user
Updated
Follow

Description

Important change: The allowed range for retrieving data has been changed from 30 days to 2 days for performance reasons. If you need to export a large range of days, please split your export in parts or contact us to provide a larger data set.

 

This API Object can be used in order to receive an RSS 2.0 feed with chat specific data. All data is given within the authenticated user's account scope. If user is a CCC agent, it will return data from all accounts within the user's groups.

Returns

An RSS 2.0 formatted file.

Call Method

The feed list should be called as followes: https://client.cobrowser.net/api/feed.php?user=username&apiKey=apiKey&c=command [[Optional: &listoption=listvalue]] [[Optional: &commandoption=commanvalue]]

Authentication

Use your username and apiKey for authentication as described in Call Method.

  • In order to use the API, your account must be setup with an API Key. Please use this form to request one.
  • API calls are only accepted using https (SSL) connections.

Available List Options

- none

Available Commands

The following commands are available for this API Object.

Command Description & Fields Command Options
transcripts Returns an RSS Formatted list of all chat transcripts, but also has to the following meta data:
  • dc:browseId (internal browse id of the transcript)
  • dc:visitorId (internal visitor id of the transcript)
  • dc:accountId (internal id of the account)
  • dc:accountName (name of the account)
  • dc:successCode (the success code set at the end of the conversation)
  • dc:accountCCCGroups (list of CCC Groups associated with the transcript's account). This is only available for CCC Operators.
    • dc:accountCCCGroups:accountCCCGroup:id (internal id of the CCC Group)
    • dc:accountCCCGroups:accountCCCGroup:name (name of the CCC Group)
  • dc:agents (list of agents present in the conversation)
    • dc:agent:username (account username of the participating agent)
    • dc:agent:email (email of the participating agent)
    • dc:agent:ccc_username (ccc account username of the participating ccc agent)
    • dc:agent:ccc_email (email of the participating ccc agent)

Notes:
- The combination of accountId and browseId makes the transcript unique

Optional start (in number of days ago). Default: 0 days (today)
Optional stop (in number of days ago). Default: 0 days (today)
Optional filters (as an array). Default: no filters

Filters:
- filters[twoparties]=1: only return transcripts where both agent and visitor have sent messages.

- filters[siblingsonly]=1: only returns transcripts with agents from the same (ccc)account. This is usefull when there are (multiple) ccc accounts. This automatically filters out all conversations without agent replies.

- filters[browse_id]=browse_id: get a specific chat conversation by its iternal browse_id. This will ignore the start and stop parameters

- filters[account_id]=account_id: only retrieve transcripts for the specified accountId

 
Notes: 
- Range between start and stop has a maximum value of 2 days.
- Shows full days (from 12 AM to 12 AM)
- Start value represents 0 AM (start of day)
- Stop value represents 23:59:59 PM (end of day)

Examples:
- start = 0 (today)
- start = 1, stop = 1 (yesterday)
- start = 1, stop = 0 (today and yesterday)

Comments

0 comments

Article is closed for comments.