Skip to end of metadata
Go to start of metadata

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

Defines a CAS R2 Signaling Profile to be used in a CAS Signaling Group

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max Length A description of the profile.
OrientationYesYesEnum0Possible values:
  • 0 - eCas_User
  • 1 - eCas_Network
Set the CAS signaling orientation. It would be set to User if connected to a PSTN; It would be set to Network if connected to a PBX.
InvertABCDBitsYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether any of the A, B, C, or D bits are inverted.
InvertedABCDBitsYesYesint0Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to specify the inverted A, B, C, or D bits, configured as a bit mask. The line signals are inverted according to this parameter before being transmitted. Received line signals are inverted before being interpreted. The value specified is the decimal representation of a 4 bit binary bit mask. For example: to invert the 'B' bit, binary 0100 would be used and entered as 4.
CDBitsYesYesint0Possible values:
  • 0 - Minimum
  • 3 - Maximum
Used to specify the setting of the C and D bits transmitted, configured as a bit mask. The value specified is the decimal representation of a 2 bit binary bit mask. For example: to set the 'C' bit to one, binary 10 would be used and entered as 2.
RequestANIYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether Automatic Number Identification (ANI) should be requested. When ANI is requested, the calling party category followed by the actual ANI is sent. This parameter is the same as the "Request Calling Party Number" field of the CAS R2 Signaling Profile in the Sonus SBC 1000/2000 WEBUI.
DNISDigits2RequestANIYesYesint0Possible values:
  • -1 - Minimum
  • 10 - Maximum
Used to specify the number of DNIS Digits Received to request Automatic Number Identification (ANI). The value specified is a number of digits from 1 to 10 or -1 for all, should be 0 if RequestANI is false. This parameter is the same as the "Digits Received Before Request" field in the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
VariableANILengthYesYesEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the length of Automatic Number Identification (ANI) to be requested or sent is variable or fixed. This parameter is valid only when RequestANI is set to "true". When variable length ANI is used, Group I-15 signal is used to indicate the end of ANI digits. This parameter is the same as the "Calling Party Number Length" field in the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
ANILengthYesYesint1Possible values:
  • 0 - Minimum
  • 20 - Maximum
Used to specify the fixed length of Automatic Number Identification (ANI) to be requested or sent. The value specified is a number of digits from 1 to 20, or 0 if VariableANILength is "true". This parameter is the same as the "Calling Party Digits" field in the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
UseGroupCTonesYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether we use Group-C Tones for Calling Party Number (ANI) or not.
IncomingToneYesYesEnum1Possible values:
  • 0 - eCas_DTMF
  • 1 - eCas_MF
Used to set whether the R2 Incoming Tone is MF (default) or DTMF. This parameter is the same as the "Signal Type" field of the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
RequestANIDigitYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the backward group A tone is used to request the Automatic Number Identification (ANI) digits. This parameter is valid only when RequestANI is set to "true".
GroupATone4RequestANIDigitYesYesint5Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to specify the backward group A tone used to request the Automatic Number Identification (ANI) digits. The value specifies the tone to use, from 1 to 15, should be 0 if RequestANI is false. This parameter is the same as the "Send Calling Party's Number" field of the CAS R2 Signaling Profile Backward Register Signals in the Sonus SBC 1000/2000 WEBUI.
RequestCategoryDigitYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the backward group A tone is used to request the calling party category before the Automatic Number Identification (ANI) digits. This parameter is valid only when RequestANI is set to "true".
GroupATone4RequestCategoryDigitYesYesint5Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to specify the backward group A tone used to request the calling party category before the Automatic Number Identification (ANI) digits. The value specifies the tone to use, from 1 to 15. This parameter is valid only when RequestCategoryDigit is set to "true" and should be set to 0 otherwise. This parameter is the same as the "Send Calling Party's Category" field of the CAS R2 Signaling Profile Backward Register Signals in the Sonus SBC 1000/2000 WEBUI.
AnswerDigitYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to indicate whether the group A tone is used to "answer" incoming calls. Not currently supported.
GroupATone4AnswerDigitYesYesint3Possible values:
  • 0 - Minimum
  • 6 - Maximum
Used to indicate the group A tone used to "answer" incoming calls. The value specifies the tone to use, either 3 or 6. This parameter is the same as the "Address Complete" field of the CAS R2 Signaling Profile Backward Register Signals in the Sonus SBC 1000/2000 WEBUI.
Send1stDigitYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to indicate whether group A backward tone is used as "send first digit" signal. When an outgoing R2 register receives a "send first digit" signal, the DNIS is retransmitted from the first digit.
GroupATone4Send1stDigitYesYesint2Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to indicate the group A backward tone used as "send first digit" signal. The value specified is the tone to use from 0 to 15. This parameter is the same as the "Send First Address Digit" field of the CAS R2 Signaling Profile Backward Register Signals in the Sonus SBC 1000/2000 WEBUI.
VariableDNISLengthYesYesEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the length of DNIS (Dialed Number Identification Service) expected is variable or fixed. If variable length DNIS is used, Group I-15 digit is used to indicate the end of DNIS. This parameter is the same as the "Called Party Number Length" field in the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
DNISLengthYesYesint7Possible values:
  • 0 - Minimum
  • 20 - Maximum
Used to specify the fixed length of DNIS expected. The value specifies the length of the DNIS. This parameter is valid only when VariableDNISLength is set to "false". This parameter is the same as the "Called Party Digits" field in the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
SendEndOfDigitYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify if end of digit should be send after the called number(DNIS), Group I-15 digit is used to indicate the end of DNIS.
GroupBIdleSentYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the group B backward tone is sent by the incoming R2 register to indicate idle condition of the destination party. Not currently supported.
GroupBTone4IdleSentYesYesint6Possible values:
  • 0 - Minimum
  • 8 - Maximum
Used to specify the group B backward tone to be sent by the incoming R2 register to indicate idle condition of the destination party. The value specifies the tone to use. This parameter is the same as the "Subscriber Line Free Sent" field in the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
GroupBBusySentYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the group B backward tone is sent by the incoming R2 register to indicate busy condition of the destination party. Not currently supported.
GroupBTone4BusySentYesYesint3Possible values:
  • 0 - Minimum
  • 8 - Maximum
Used to specify the group B backward tone to be sent by the incoming R2 register to indicate busy condition of the destination party. The value specifies the tone to use. This parameter is the same as the "Subscriber Line Busy Sent" field in the CAS R2 Signaling Profile of the Sonus SBC 1000/2000 WEBUI.
GroupBTone4CongSentYesYesint4Possible values:
  • 0 - Minimum
  • 8 - Maximum
Used to specify the group B backward tone to be sent by the incoming R2 register to indicate congestion condition. The value specifies the tone to use. This parameter is the same as the "Congestion Sent" field in the CAS R2 Signaling Profile of the UX WEBUI.
GroupBTone4UnallocNumSentYesYesint5Possible values:
  • 0 - Minimum
  • 8 - Maximum
Used to specify the group B backward tone to be sent by the incoming R2 register to indicate unallocated number. The value specifies the tone to use. This parameter is the same as the "Unallocated Number Sent" field in the CAS R2 Signaling Profile of the UX WEBUI.
ReleaseGuardTimeYesYesint0Possible values:
  • 0 - Minimum
  • 2000 - Maximum
Used to specify the release guard time, which is the time an incoming R2 register waits when a clear forward line signal is received before sending an idle line signal. The value is specified in milliseconds. 0 indicating the idle signal is to be returned immediately.
MeterCodeYesYesEnum0Possible values:
  • 0 - eCas_NoMetering
  • 1 - eCas_MeteringEnabled
Used to set the whether or not to send metering signal (Metering signals are pulse type signals transmitted backwards during the call from call charging point to subscriber's call meter in the originating exchange).
OutgoingToneYesYesEnum1Possible values:
  • 0 - eCas_DTMF
  • 1 - eCas_MF
Used to set whether the R2 Outgoing Tone is MF (default) or DTMF.
SeizureAcknowledgmentTimeYesYesint200Possible values:
  • 0 - Minimum
  • 10000 - Maximum
Used to specify the seizure acknowledgment time, which is the maximum time an outgoing R2 register waits after sending a seizure signal for the seizure acknowledgment signal. The value is specified in milliseconds. 0 indicates no time out is to be used.
A3CategoryYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the Group II forward tone is sent on receiving A-3 backward tone. Not currently supported.
Group2Tone4A3CategoryYesYesint1Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to specify the Group II forward signal to be sent on receiving Address Complete backward signal. This tone indicates the category of the calling party. The value specifies the tone to use.
A6CategoryYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to specify whether the group I forward tone is sent on receiving calling party category request before the ANI digit request. This parameter is valid only when RequestANI is set to "true".
Group1Tone4A6CategoryYesYesint1Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to specify the group I forward tone to be sent on receiving calling party category request before the ANI digit request. The value specifies the tone to use.
Group1AniRestrictedYesYesint0Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to specify the Group-I forward tone sent to indicate that the Calling Party Number (ANI) is restricted/private.
Group2AniRestrictedYesYesint0Possible values:
  • 0 - Minimum
  • 15 - Maximum
Used to specify the Group-II forward tone sent to indicate that the Calling Party Number (ANI) is restricted/private.
GroupB1IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-1 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB2IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-2 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB3IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-3 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB4IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-4 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB5IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-5 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB6IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-6 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB7IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-7 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB8IdleReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-8 backward tone received by the outgoing R2 register for an idle condition of the destination party. Set to 0 for "false" or 1 for "true".
GroupB1BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-1 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
GroupB2BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-2 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
GroupB3BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-3 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
GroupB4BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-4 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
GroupB5BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-5 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
GroupB6BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-6 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
GroupB7BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-7 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
GroupB8BusyReceivedBitYesYesint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Used to set the group B-8 backward tone received by the outgoing R2 register for a busy condition of a destination party. Set to 0 for "false" or 1 for "true".
InterDigitTimeoutYesNoint20000Possible values:
  • 250 - Minimum
  • 30000 - Maximum
Used to set the timeout time between dialed numbers. The value specifies the timeout period in milliseconds.
  • No labels