Jump to: navigation, search
(Created target blank page For Version: HTCC:9.0.0DRAFT)
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Media Namespace=
 +
{{NoteFormat|The content on this page is no longer updated. To find the latest content, go to [https://all.docs.genesys.com/PEC-Developer/Current/SCAPI/MediaNamespace Media namespace].}}
 +
__TOC__
 +
==Methods==
 +
The Media namespace includes the following methods:
 +
* [[MediaNamespace#getMediaList|getMediaList]]
 +
* [[MediaNamespace#getMediaByName|getMediaByName]]
 +
* [[MediaNamespace#setState|setState]]
 +
 
 +
 
 +
===getMediaList===
 +
{|
 +
! Signature
 +
| <static> getMediaList() → {Array.<[[MediaNamespace#State|media.Media]]>}
 +
|-
 +
! Description
 +
| Get the list of media with attributes.
 +
|-
 +
! Returns
 +
| Array.<[[MediaNamespace#State|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 <tt>operationName</tt> from the agent states list. See [[MediaNamespace#State|State]].
 +
|}
 +
|}
 +
 
 +
==Type Definitions==
 +
The Media namespace includes the following object types:
 +
* [[MediaNamespace#Media|Media]]
 +
* [[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===
 +
{|
 +
! 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 [[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:9.0.0DRAFT]]

Latest revision as of 16:59, February 1, 2022

Media Namespace

Important
The content on this page is no longer updated. To find the latest content, go to 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 February 1, 2022, at 16:59.
Comments or questions about this documentation? Contact us for support!