Jump to: navigation, search
(→‎State)
Line 5: Line 5:
 
* [[MediaNamespace#getMediaList|getMediaList]]
 
* [[MediaNamespace#getMediaList|getMediaList]]
 
* [[MediaNamespace#setState|setState]]
 
* [[MediaNamespace#setState|setState]]
 +
  
 
===getMediaList===
 
===getMediaList===
Line 47: Line 48:
 
* [[MediaNamespace#Media|Media]]
 
* [[MediaNamespace#Media|Media]]
 
* [[MediaNamespace#State|State]]
 
* [[MediaNamespace#State|State]]
 +
* [[MediaNamespace#Device|Device]]
  
 
===Media===
 
===Media===
Line 113: Line 115:
 
|}
 
|}
 
''* States that are limited to an event and can't be applied by code''
 
''* States that are limited to an event and can't be applied by code''
 +
 +
===Device===
 +
{|
 +
! Description
 +
| Represents the JSON structure of a media.
 +
|-
 +
! Type
 +
| Object
 +
|-
 +
! Properties
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| number
 +
| string
 +
| The phone number configured for an agent - the physical DN.
 +
|-
 +
| dynamicPhoneNumber
 +
| string
 +
| The dynamic phone number configured for the agent for the session.
 +
|}
 +
|}
  
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 12:29, November 2, 2017

Media Namespace

Methods

The Media namespace includes the following methods:


getMediaList

Signature <static> getMediaList() → {Array.<media.Media>}
Description Get the media attributes.
Returns Array.<media.Media>

setState

Signature <static> setState(name, stateOperationName)
Description Sets the media state.
Parameters
Name Type Description
name string The media name.
stateOperationName string An operationName from the agent states list. See State.

Type Definitions

The Media namespace includes the following object types:

Media

Description Represents the JSON structure of a media.
Type Object
Properties
Name Type Description
name string The media name.
state media.State The media state object.

State

Description Represents the JSON structure of a media state.
Type Object
Properties
Name Type Description
type string The type of operation. Possible values are:
  • LOGOUT
  • READY
  • PARTIAL_READY *
  • NOT_READY
  • NOT_READY_ACTION_CODE
  • NOT_READY_AFTER_CALLWORK
  • NOT_READY_AFTER_CALLWORK_ACTION_CODE
  • DND_ON
  • OUT_OF_SERVICE *
  • LOGOUT_DND_ON *
  • UNKNOWN *
displayName string The display name of the state.
operationName string The operation name to use with agent.setState and media.setState.

* States that are limited to an event and can't be applied by code

Device

Description Represents the JSON structure of a media.
Type Object
Properties
Name Type Description
number string The phone number configured for an agent - the physical DN.
dynamicPhoneNumber string The dynamic phone number configured for the agent for the session.
Comments or questions about this documentation? Contact us for support!