You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

About this Resource

Modified: for 3.1.0

Defines SIP Call Info Managed Object

REST API Methods for this Resource

Resource Schema

Runtime

Parameter Name Description Data Type Possible Values
rt_ChannelType Provides type of the channel. EnumPossible values:
  • 0 - ctISDN
  • 1 - ctSIP
  • 2 - ctCAS
rt_ConferenceID Provides conference ID for this call. int
rt_CallForked Indicates if this call has been forked to multiple outbound destinations. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_CallRerouted Indicates if this call has been rerouted to a subsequent destination than the original destination. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_CallTranscoded Indicates if this call has been transcoded. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_CallAudioFaxMode Indicates the Audio/Fax stream media mode in the call. EnumPossible values:
  • 0 - mmodet_RtpDisabled
  • 1 - mmodet_RtpDSP
  • 2 - mmodet_RtpProxy
  • 3 - mmodet_RtpBypass
  • 4 - mmodet_RtpUnknown
rt_CallVideoApplcnMode Indicates the Video/Application stream media mode in the call. EnumPossible values:
  • 0 - mmodet_RtpDisabled
  • 1 - mmodet_RtpDSP
  • 2 - mmodet_RtpProxy
  • 3 - mmodet_RtpBypass
  • 4 - mmodet_RtpUnknown
rt_CurrentTime Provides the time that this information was retrieved. long
rt_AlertTime Provides the time that this call entered the alerting state. long
rt_ConnectTime Provides the time that this call entered the connected state. long
rt_InboundInfo Provides inbound channel information in pipe ("|") separated string format on this call in the following order.
  • ChannelType (int)
    • 0 = ISDN
    • 1 = SIP
    • 2 = CAS
  • Channel Identifier (string)
  • SG ID (string)
  • CallingNumber (string)
  • CallingNumberPlan (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = ISDN
    • 2 = Data
    • 3 = Telex
    • 4 = National
    • 5 = Private
    • 6 = Telephony
  • CallingNumberType (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = Subscriber
    • 2 = National
    • 3 = Network Specific
    • 4 = Abbreviated
    • 5 = International
    • 6 = H323/SIP
    • 7 = Subscriber Non Unique
    • 8 = National Non Unique
    • 9 = International Non Unique
    • 10 = TestLine/TestCode
    • 11 = National Reserved
  • CallingNumberPresentationIndicator (int)
    • -1 = AnyUntranslated
    • 0 = Presentation Allowed
    • 1 = Presentation Restricted
    • 2 = Number not Available Due to Interworking
    • 3 = Reserved
  • CallingNumberScreeningIndicator (int)
    • -1 = AnyUntranslated
    • 0 = User-Provided, not Screened
    • 1 = User-Provided, Verified and Passed
    • 2 = User-Provided, Verified and Failed
    • 3 = Network Provided
  • CallingName (string)
  • CalledNumber (string)
  • CalledNumberPlan (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = ISDN
    • 2 = Data
    • 3 = Telex
    • 4 = National
    • 5 = Private
    • 6 = Telephony
  • CalledNumberType (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = Subscriber
    • 2 = National
    • 3 = Network Specific
    • 4 = Abbreviated
    • 5 = International
    • 6 = Subscriber Operator Requested
    • 7 = National Operator Requested
    • 8 = International Operator Requested
    • 9 = Not Present - Operator Requested
    • 10 = Not Present - Cut Through Call to Carrier
    • 11 = 950 Call
    • 12 = TestLine/TestCode
    • 13 = H323/SIP
  • OutGoingNumber (string)
  • OutGoingNumberPlan (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = ISDN
    • 2 = Data
    • 3 = Telex
    • 4 = National
    • 5 = Private
    • 6 = Telephony
  • OutGoingNumberType (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = Subscriber
    • 2 = National
    • 3 = Network Specific
    • 4 = Abbreviated
    • 5 = International
    • 6 = Subscriber Operator Requested
    • 7 = National Operator Requested
    • 8 = International Operator Requested
    • 9 = Not Present - Operator Requested
    • 10 = Not Present - Cut Through Call to Carrier
    • 11 = 950 Call
    • 12 = TestLine/TestCode
    • 13 = H323/SIP
Additionally contains the following information if the channel is TDM:
  • TransferMode (int)
    • 0 = Circuit
    • 1 = Packet
  • TransferRate (int)
    • 0 = Packet
    • 1 = 64 kbps
    • 2 = 128 kbps
    • 3 = 384 kbps
    • 4 = 1472 kbps
    • 5 = 1536 kbps
    • 6 = 1920 kbps
    • 7 = Multirate
  • UserRate (int)
    • 0 = Unknown
    • 1 = I.460 specified by bits-7/6 of octet 5b, intermediate rate
    • 2 = V.110/X.30 indicated by E-bits or negotiated in-band
    • 3 = V.120 unspecified or negotiated in-band
    • 4 = 0.6 kbps
    • 5 = 1.2 kbps
    • 6 = 2.4 kbps
    • 7 = 3.6 kbps
    • 8 = 4.8 kbps
    • 9 = 7.2 kbps
    • 10 = 8 kbps
    • 11 = 9.6 kbps
    • 12 = 14.4 kbps
    • 13 = 16 kbps
    • 14 = 19.2 kbps
    • 15 = 32 kbps
    • 16 = 38.4 kbps
    • 17 = 48 kbps
    • 18 = 56 kbps
    • 19 = 57.6 kbps
    • 20 = 64 kbps
    • 21 = 28.8 kbps
    • 22 = 24 kbps
    • 23 = 0.1345 kbps
    • 24 = 0.1 kbps
    • 25 = 0.075/1.2 kbps
    • 26 = 1.2/0.075 kbps
    • 27 = 0.050 kbps
    • 28 = 0.075 kbps
    • 29 = 0.110 kbps
    • 30 = 0.150 kbps
    • 31 = 0.200 kbps
    • 32 = 0.300 kbps
    • 33 = 12 kbps
Additionally contains the following information if the channel is IP:
  • MediaType (int)
    • 0 = None
    • 1 = Unknown
    • 2 = G.711A
    • 3 = G.711u
    • 4 = G.723
    • 5 = G.726
    • 6 = G.729A
    • 7 = T.38 Fax
    • 8 = CN
    • 9 = Event Signal
    • 10 = RTP Redundancy
    • 11 = Transparent
    • 12 = Fax Relay
    • 13 = Fax Relay Alaw
    • 14 = Fax Relay Ulaw
    • 15 = Modem Relay
    • 16 = Modem Relay Alaw
    • 17 = Modem Relay Ulaw
  • SRTP (bool)
    • 0 = False
    • 1 = True
  • SRTPCryptoSuite (int)
    • 0 = AES_CM 128/SHA1 32
    • 1 = AES_CM 128/SHA1 80
string
rt_OutboundInfo Provides outbound channel information in pipe ("|") separated string format on this call in the following order.
  • ChannelType (int)
    • 0 = ISDN
    • 1 = SIP
    • 2 = CAS
  • Channel Identifier (string)
  • SG ID (string)
  • CallingNumber (string)
  • CallingNumberPlan (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = ISDN
    • 2 = Data
    • 3 = Telex
    • 4 = National
    • 5 = Private
    • 6 = Telephony
  • CallingNumberType (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = Subscriber
    • 2 = National
    • 3 = Network Specific
    • 4 = Abbreviated
    • 5 = International
    • 6 = H323/SIP
    • 7 = Subscriber Non Unique
    • 8 = National Non Unique
    • 9 = International Non Unique
    • 10 = TestLine/TestCode
    • 11 = National Reserved
  • CallingNumberPresentationIndicator (int)
    • -1 = AnyUntranslated
    • 0 = Presentation Allowed
    • 1 = Presentation Restricted
    • 2 = Number not Available Due to Interworking
    • 3 = Reserved
  • CallingNumberScreeningIndicator (int)
    • -1 = AnyUntranslated
    • 0 = User-Provided, not Screened
    • 1 = User-Provided, Verified and Passed
    • 2 = User-Provided, Verified and Failed
    • 3 = Network Provided
  • CallingName (string)
  • CalledNumber (string)
  • CalledNumberPlan (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = ISDN
    • 2 = Data
    • 3 = Telex
    • 4 = National
    • 5 = Private
    • 6 = Telephony
  • CalledNumberType (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = Subscriber
    • 2 = National
    • 3 = Network Specific
    • 4 = Abbreviated
    • 5 = International
    • 6 = Subscriber Operator Requested
    • 7 = National Operator Requested
    • 8 = International Operator Requested
    • 9 = Not Present - Operator Requested
    • 10 = Not Present - Cut Through Call to Carrier
    • 11 = 950 Call
    • 12 = TestLine/TestCode
    • 13 = H323/SIP
  • OutGoingNumber (string)
  • OutGoingNumberPlan (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = ISDN
    • 2 = Data
    • 3 = Telex
    • 4 = National
    • 5 = Private
    • 6 = Telephony
  • OutGoingNumberType (int)
    • -1 = AnyUntranslated
    • 0 = Unknown
    • 1 = Subscriber
    • 2 = National
    • 3 = Network Specific
    • 4 = Abbreviated
    • 5 = International
    • 6 = Subscriber Operator Requested
    • 7 = National Operator Requested
    • 8 = International Operator Requested
    • 9 = Not Present - Operator Requested
    • 10 = Not Present - Cut Through Call to Carrier
    • 11 = 950 Call
    • 12 = TestLine/TestCode
    • 13 = H323/SIP
Additionally contains the following information if the channel is TDM:
  • TransferMode (int)
    • 0 = Circuit
    • 1 = Packet
  • TransferRate (int)
    • 0 = Packet
    • 1 = 64 kbps
    • 2 = 128 kbps
    • 3 = 384 kbps
    • 4 = 1472 kbps
    • 5 = 1536 kbps
    • 6 = 1920 kbps
    • 7 = Multirate
  • UserRate (int)
    • 0 = Unknown
    • 1 = I.460 specified by bits-7/6 of octet 5b, intermediate rate
    • 2 = V.110/X.30 indicated by E-bits or negotiated in-band
    • 3 = V.120 unspecified or negotiated in-band
    • 4 = 0.6 kbps
    • 5 = 1.2 kbps
    • 6 = 2.4 kbps
    • 7 = 3.6 kbps
    • 8 = 4.8 kbps
    • 9 = 7.2 kbps
    • 10 = 8 kbps
    • 11 = 9.6 kbps
    • 12 = 14.4 kbps
    • 13 = 16 kbps
    • 14 = 19.2 kbps
    • 15 = 32 kbps
    • 16 = 38.4 kbps
    • 17 = 48 kbps
    • 18 = 56 kbps
    • 19 = 57.6 kbps
    • 20 = 64 kbps
    • 21 = 28.8 kbps
    • 22 = 24 kbps
    • 23 = 0.1345 kbps
    • 24 = 0.1 kbps
    • 25 = 0.075/1.2 kbps
    • 26 = 1.2/0.075 kbps
    • 27 = 0.050 kbps
    • 28 = 0.075 kbps
    • 29 = 0.110 kbps
    • 30 = 0.150 kbps
    • 31 = 0.200 kbps
    • 32 = 0.300 kbps
    • 33 = 12 kbps
Additionally contains the following information if the channel is IP:
  • MediaType (int)
    • 0 = None
    • 1 = Unknown
    • 2 = G.711A
    • 3 = G.711u
    • 4 = G.723
    • 5 = G.726
    • 6 = G.729A
    • 7 = T.38 Fax
    • 8 = CN
    • 9 = Event Signal
    • 10 = RTP Redundancy
    • 11 = Transparent
    • 12 = Fax Relay
    • 13 = Fax Relay Alaw
    • 14 = Fax Relay Ulaw
    • 15 = Modem Relay
    • 16 = Modem Relay Alaw
    • 17 = Modem Relay Ulaw
  • SRTP (bool)
    • 0 = False
    • 1 = True
  • SRTPCryptoSuite (int)
    • 0 = AES_CM 128/SHA1 32
    • 1 = AES_CM 128/SHA1 80

If call is forked, there may be multiple outbound channel information (up to 32) depending on the query time separated by semicolon (";").

 string
  • No labels