REST API Method: POST /rest/r2signalingprofile/{identifier}
Modifies a CAS R2 Signaling Profile given a specific ID.
Note
The CAS R2 Signaling Profile identifier can only be within the range 15001-20000 (inclusive)
URL:
https://134.56.227.163/rest/r2signalingprofile/{identifier}
HTTP Method
POST
Requires Authentication:
true
Parameters
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| Description | No | No | string | none | 64 - Max Length | A description of the profile. |
| Orientation | Yes | Yes | Enum | 0 | Possible values:
| 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. |
| InvertABCDBits | Yes | Yes | Enum | 0 | Possible values:
| Used to specify whether any of the A, B, C, or D bits are inverted. |
| InvertedABCDBits | Yes | Yes | int | 0 | Possible values:
| 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. |
| CDBits | Yes | Yes | int | 0 | Possible values:
| 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. |
| RequestANI | Yes | Yes | Enum | 0 | Possible values:
| 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. |
| DNISDigits2RequestANI | Yes | Yes | int | 0 | Possible values:
| 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. |
| VariableANILength | Yes | Yes | Enum | 1 | Possible values:
| 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. |
| ANILength | Yes | Yes | int | 1 | Possible values:
| 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. |
| UseGroupCTones | Yes | Yes | Enum | 0 | Possible values:
| Used to specify whether we use Group-C Tones for Calling Party Number (ANI) or not. |
| IncomingTone | Yes | Yes | Enum | 1 | Possible values:
| 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. |
| RequestANIDigit | Yes | Yes | Enum | 0 | Possible values:
| 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". |
| GroupATone4RequestANIDigit | Yes | Yes | int | 5 | Possible values:
| 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. |
| RequestCategoryDigit | Yes | Yes | Enum | 0 | Possible values:
| 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". |
| GroupATone4RequestCategoryDigit | Yes | Yes | int | 5 | Possible values:
| 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. |
| AnswerDigit | Yes | Yes | Enum | 0 | Possible values:
| Used to indicate whether the group A tone is used to "answer" incoming calls. Not currently supported. |
| GroupATone4AnswerDigit | Yes | Yes | int | 3 | Possible values:
| 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. |
| Send1stDigit | Yes | Yes | Enum | 0 | Possible values:
| 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. |
| GroupATone4Send1stDigit | Yes | Yes | int | 2 | Possible values:
| 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. |
| VariableDNISLength | Yes | Yes | Enum | 1 | Possible values:
| 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. |
| DNISLength | Yes | Yes | int | 7 | Possible values:
| 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. |
| SendEndOfDigit | Yes | No | Enum | 1 | Possible values:
| 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. |
| GroupBIdleSent | Yes | Yes | Enum | 0 | Possible values:
| 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. |
| GroupBTone4IdleSent | Yes | Yes | int | 6 | Possible values:
| 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. |
| GroupBBusySent | Yes | Yes | Enum | 0 | Possible values:
| 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. |
| GroupBTone4BusySent | Yes | Yes | int | 3 | Possible values:
| 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. |
| GroupBTone4CongSent | Yes | Yes | int | 4 | Possible values:
| 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. |
| GroupBTone4UnallocNumSent | Yes | Yes | int | 5 | Possible values:
| 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. |
| ReleaseGuardTime | Yes | Yes | int | 0 | Possible values:
| 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. |
| MeterCode | Yes | Yes | Enum | 0 | Possible values:
| 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). |
| OutgoingTone | Yes | Yes | Enum | 1 | Possible values:
| Used to set whether the R2 Outgoing Tone is MF (default) or DTMF. |
| SeizureAcknowledgmentTime | Yes | Yes | int | 200 | Possible values:
| 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. |
| A3Category | Yes | Yes | Enum | 0 | Possible values:
| Used to specify whether the Group II forward tone is sent on receiving A-3 backward tone. Not currently supported. |
| Group2Tone4A3Category | Yes | Yes | int | 1 | Possible values:
| 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. |
| A6Category | Yes | Yes | Enum | 0 | Possible values:
| 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". |
| Group1Tone4A6Category | Yes | Yes | int | 1 | Possible values:
| 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. |
| Group1AniRestricted | Yes | Yes | int | 0 | Possible values:
| Used to specify the Group-I forward tone sent to indicate that the Calling Party Number (ANI) is restricted/private. |
| Group2AniRestricted | Yes | Yes | int | 0 | Possible values:
| Used to specify the Group-II forward tone sent to indicate that the Calling Party Number (ANI) is restricted/private. |
| GroupB1IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB2IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB3IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB4IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB5IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB6IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB7IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB8IdleReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB1BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB2BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB3BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB4BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB5BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB6BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB7BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| GroupB8BusyReceivedBit | Yes | Yes | int | 0 | Possible values:
| 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". |
| InterDigitTimeout | Yes | No | int | 20000 | Possible values:
| Used to set the timeout time between dialed numbers. The value specifies the timeout period in milliseconds. |
Helpful Tip
The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource
Usage Example: (about cURL | requires a session token)
Put code example here
Response:
Put Code response here
Overview
Content Tools