Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Defines DS1 Channel Managed Object

REST API Methods for this Resource

Resource Schema

Runtime

Parameter Name Description Data Type Possible Values
rt_EnableStatusProvides administrative state of the channel.EnumPossible values:
  • 0 - esDISABLED
  • 1 - esENABLED
rt_NumPeerChannelsProvides number of peer channels currently this channel is connected to.int
rt_ChSpeedProvides speed of the channel.int
rt_ChAdminLastChangeProvides last time administrative state changed occured on the channel.long
rt_PeerChannels Provides list of peer channel IDs currently connected to this channel. This list comes as a comma separated peer channel IDs. string
rt_ChStatusProvides operational status of the channel.EnumPossible values:
  • 0 - csOUT_OF_SERVICE
  • 1 - csIDLE
  • 2 - csPENDING
  • 3 - csWAITING_FOR_ROUTE
  • 4 - csACTIONSET
  • 5 - csWAITING_FOR_DIGITS
  • 6 - csREMOTE_SETUP
  • 7 - csPEER_SETUP
  • 8 - csALERTING
  • 9 - csINBAND_INFO
  • 10 - csCONNECTED
  • 11 - csTONE_GENERATION
  • 12 - csRELEASING
  • 13 - csABORTING
  • 14 - csRESETTING
  • 15 - csUP
  • 16 - csDOWN
  • 17 - csCONNECTED_WithMediaBypass
  • 18 - csSOURCE_FOR_MOH
  • 19 - csD_CHANNEL_DISABLED
  • 20 - csD_CHANNEL
  • 21 - csPASSTHRU
  • 22 - csINBAD_EARLY_MEDIA
  • 23 - csALERTING_LOCAL_RINGBACK
  • 24 - csALERTING_REMOTE_RINGBACK
  • 25 - csCONNECTED_RTP_PROXY_MODE_AUDIO
  • 26 - csCONNECTED_RTP_PROXY_MODE_ALL
  • 27 - csCONNECTED_RTP_HYBRID_MODE_DSP_PROXY
  • 28 - csCONNECTED_RTP_PROXY_MODE_VIDEO
  • 29 - csCONNECTED_RTP_DIRECT_MODE_AUDIO
  • 30 - csCONNECTED_RTP_DIRECT_MODE_ALL
  • 31 - csCONNECTED_RTP_DIRECT_MODE_VIDEO
rt_ChConfigDirectionProvides currently configured direction of the channel.EnumPossible values:
  • 0 - cdINBOUND
  • 1 - cdOUTBOUND
  • 2 - cdBIDIRECTIONAL
  • 3 - cdNONE
rt_ChCallDirectionProvides direction of the current active call on this channel.EnumPossible values:
  • 0 - cdINBOUND
  • 1 - cdOUTBOUND
  • 2 - cdBIDIRECTIONAL
  • 3 - cdNONE
rt_CallTypeProvides type of current active call on this channel.EnumPossible values:
  • 0 - ctUNSET
  • 1 - ctVOICE
  • 2 - ctT38FAX
  • 3 - ctSTU
  • 4 - ctMODEM
  • 5 - ctUNCOMPRESSED_PCM
  • 6 - ctSECURE_MEDIA_IB_ONLY
  • 7 - ctSECURE_MEDIA_OB_ONLY
  • 8 - ctSECURE_MEDIA_IB_AND_OB
  • 9 - ctSECURE_MEDIA_PASSTHROUGH
  • 10 - ctDATA
  • 11 - ctFAX_PASSTHROUGH
  • 12 - ctMODEM_PASSTHROUGH
rt_CallCSNProvdies the call serial number (CSN) of the active call on this channel.int
rt_OOSFlagsProvides a reason code indicating why the channel is out of servicelong
rt_MisCfgReasonProvides a misconfiguration reason for the channelstring
rt_SGIndexProvides signaling group ID associated to the channel.int
rt_ChRTConfigProvides current operating mode for the channel. If the mode is not set (value is 0), then there are no call details available on this channel.EnumPossible values:
  • 0 - comNOTSET
  • 1 - comISDN_D
  • 2 - comISDN_B
  • 3 - comCAS_FXS
  • 4 - comCAS_FXO
  • 5 - comCAS_DIGITAL
  • 6 - comCAS_SIGNALING