Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Channel resource

This resource is part of the Channels API section of the Web Services API.

Overview

The channel resource includes the channel and the user state for that channel. Channels are returned from GET requests to /api/v2/me/channels?fields=*.

Sample Data

{  
   "channels":[  
      {  
         "channel":"chat",
         "userState":{  
            "id":"9430250E-0A1B-421F-B372-F29E69366DED",
            "displayName":"Ready",
            "state":"Ready"
         }
      },
      {  
         "channel":"email",
         "userState":{  
            "id":"900D55CC-2BB0-431F-8BF9-D3525B383BE6",
            "displayName":"Not Ready",
            "state":"NotReady"
         }
      },
      {
         "channel": "voice",
         "phoneNumber": "3001",
         "switchName": "SIP_Switch",
         "userActivity": "Idle",
         "userState": { 
            "id": "9430250E-0A1B-421F-B372-F29E69366DED", 
            "displayName": "Ready", 
            "state": "Ready" 
       }
   ]
}

Resource Details

Field Description
channel The name of the channel. For example, email or chat.
userState The user's current state for the channel. This includes the userState's ID, display name, and the state.
switchName The name of the switch owning the phone number. Note that switchName will be added to voice and instant-message channels only.
This page was last edited on November 4, 2016, at 17:54.

Feedback

Comment on this article:

blog comments powered by Disqus