Jump to: navigation, search
 
(10 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
The Media namespace includes the following methods:
 
The Media namespace includes the following methods:
 
* [[MediaNamespace#getMediaList|getMediaList]]
 
* [[MediaNamespace#getMediaList|getMediaList]]
 +
* [[MediaNamespace#getMediaByName|getMediaByName]]
 
* [[MediaNamespace#setState|setState]]
 
* [[MediaNamespace#setState|setState]]
 +
  
 
===getMediaList===
 
===getMediaList===
 
{|
 
{|
 
! Signature
 
! Signature
−
| <static> getMediaList() → {Array.<object>}
+
| <static> getMediaList() → {Array.<[[MediaNamespace#State|media.Media]]>}
 
|-
 
|-
 
! Description
 
! Description
−
| Get the media attributes.
+
| Get the list of media with attributes.
 
|-
 
|-
 
! Returns
 
! Returns
−
| list[] (Type: Array.<object>) &mdash; an array of all the media with the following attributes:
+
| Array.<[[MediaNamespace#State|media.Media]]>
−
* list[].media (Type: string) &mdash; The media name.
 
−
* list[].state (Type: [[MediaNamespace#State|media.State]]) &mdash; The media state object.
 
 
|}
 
|}
  
 +
===getMediaByName===
 +
{|
 +
!Signature
 +
|<static> getMediaByName(''name'')
 +
|-
 +
!Description
 +
|Get the media attributes.
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|name
 +
|string
 +
|The media name.
 +
|}
 +
|}
 
===setState===
 
===setState===
 
{|
 
{|
Line 41: Line 61:
 
| stateOperationName
 
| stateOperationName
 
| string
 
| string
−
| An operation name from the agent states list.
+
| An <tt>operationName</tt> from the agent states list. See [[MediaNamespace#State|State]].
 
|}
 
|}
 
|}
 
|}
Line 47: Line 67:
 
==Type Definitions==
 
==Type Definitions==
 
The Media namespace includes the following object types:  
 
The Media namespace includes the following object types:  
 +
* [[MediaNamespace#Media|Media]]
 
* [[MediaNamespace#State|State]]
 
* [[MediaNamespace#State|State]]
 +
* [[MediaNamespace#Device|Device]]
 +
 +
===Media===
 +
{|
 +
! Description
 +
| Represents the JSON structure of a media.
 +
|-
 +
! Type
 +
| Object
 +
|-
 +
! Properties
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| name
 +
| string
 +
| The media name.
 +
|-
 +
| state
 +
| [[MediaNamespace#State|media.State]]
 +
| The media state object.
 +
|}
 +
|}
  
 
===State===
 
===State===
Line 66: Line 113:
 
| type
 
| type
 
| string
 
| string
−
| The type of the 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, and UNKNOWN.
+
| 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
 
| displayName
Line 74: Line 132:
 
| operationName
 
| operationName
 
| string
 
| string
−
| The operation name to use with [[AgentNamespace#setState|agent.setState]] and [[MediaNamespace#setState|setState]].
+
| The operation name to use with [[AgentNamespace#setState|agent.setState]] and [[MediaNamespace#setState|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.
 +
'''Note''': This property is applicable only for voice data.
 +
|-
 +
| dynamicPhoneNumber
 +
| string
 +
| The dynamic phone number configured for the agent for the session.
 +
'''Note''': This property is applicable only for voice data. This property is applicable only when there is an alternate phone number and applicable for  the current session only.
 +
|}
 +
|}
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Latest revision as of 17:43, August 5, 2020

Media Namespace

Methods

The Media namespace includes the following methods:


getMediaList

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

getMediaByName

Signature <static> getMediaByName(name)
Description Get the media attributes.
Parameters
Name Type Description
name string The media name.

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.

Note: This property is applicable only for voice data.

dynamicPhoneNumber string The dynamic phone number configured for the agent for the session.

Note: This property is applicable only for voice data. This property is applicable only when there is an alternate phone number and applicable for the current session only.

This page was last edited on August 5, 2020, at 17:43.
Comments or questions about this documentation? Contact us for support!