You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 9
Next »
Defines a Message Translation Entry resource to describe a given [Message Translation Table.REST API Methods for this Resource
Resource Schema
Configuration
Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
---|
ConfigIEState | No | Yes | Enum | 1 | Possible values: - 0 - esDISABLED
- 1 - esENABLED
| Specifies the Administrative State of the resource. |
---|
Description | No | No | string | none | 64 - Max Length | Short description of the translation. |
---|
InMsgType | Yes | Yes | Enum | 0 | Possible values: - 0 - imtProgress
- 1 - imtAlert
- 2 - imtConnect
- 3 - imtProceeding
|
Specifies the incoming message type to be matched and translated.
- Connect
- For this option, the Incoming Message, IE Type must be Facility, and the Outgoing Message, IE must be Untranslated or Not Present.
- Proceeding, Progress, Alert
- For these options Incoming Message, IE Type must be Progress Indicator only.
|
---|
InIEType | Yes | Yes | Enum | 0 | Possible values: - 0 - iitPI
- 1 - iitDontCare
- 2 - iitFacility
|
Specifies the Information Element (IE) type to be matched and translated.
- Progress Indicator
- This option specifies that a progress indicator is present.
- Don't Care - This option specifies that a Progress Indicator is present or not is not a concern.
- Facility
- This option disables all the following Progress Indicator related matching rules.
|
---|
InPIPresent | Yes | Yes | Enum | 1 | Possible values: |
Specifies if the Progress Indicator (PI) is present in the message.
- Yes
- Progress Indicator is present in the message.
- No
- Progress Indicator must not be present in the message.
|
---|
InPISelection | Yes | Yes | Enum | 1 | Possible values: - 0 - pstAny
- 1 - pstFiltered
|
Specified if messages are filtered by Progress Indicator (PI) values.
- Any
- This option does not filter messages by their Progress Indicator value, so any PI value is matched.
- Selected
- This option filters messages by specific Progress Indicator values, selected in the following Progress Indicators field.
|
---|
InPiValue | Yes | Yes | int | 2 | Possible values: |
Bitmask of one or more progress indicator values in the incoming message to match:
- 0
- If the PI is NOT present. InPIPresent is set to No.
- 1
- Not end to end ISDN
- 2
- Destination not ISDN
- 4
- Origination is not ISDN
- 8
- Call return to ISDN
- 16
- Interworking Encountered
- 32
- Inband information
- 64
- Delay Encountered
Example: If InPiValue is 7 the system will match message with 3 different PI:
Not end to end ISDN (1) or Destination is not ISDN (2) or Origination is not ISDN (4)
|
---|
EarlyMediaStatus | Yes | Yes | Enum | 0 | Possible values: - 0 - emsAny
- 1 - emsNegotiated
- 2 - emsNotNegotiated
|
Specifies how to handle early media status.
- Any
- Specifies that early media status is not considered.
- Negotiated
- Specifies that early media status is negotiated.
- Not Negotiated
- Specifies that early media status is not negotiated.
|
---|
OutMsgType | Yes | Yes | Enum | 0 | Possible values: - 0 - omtProgress
- 1 - omtAlert
- 2 - omtConnect
- 3 - omtProceeding
| Specifies the type of the outgoing translated message. |
---|
OutIEType | Yes | Yes | Enum | 4 | Possible values: - 0 - oitUntranslated
- 1 - oitNotPresent
- 2 - oitPresent
- 3 - oitNotEndtoEndISDN
- 4 - oitDestinationNotISDN
- 5 - oitOriginNotISDN
- 6 - oitReturnToISDN
- 7 - oitInterworkingEncountered
- 8 - oitInbandInfo
- 9 - oitDelayEncountered
|
Outgoing translated Information Element (IE). The outgoing IE type is the same as the incoming IE Type.
- Present
- This option means present with any value and is generally used for SIP with SDP.
If Facility is selected for Incoming Message, IE Type, the Outgoing, IE can only be Untranslated or Not Present.
|
---|
SendMessage | Yes | Yes | Enum | 0 | Possible values: - 0 - smtYes
- 1 - smtNo
- 2 - smtNoOnSubsequent
- 3 - smtNoOnCutThrough
|
Specifies when an outgoing message is sent.
- Yes
- Send message
- No
- Ignore message (no message is sent)
- No on Subsequent
- Ignore message if same message has already been sent
- No on Cut Through
- Ignore message if early media being played
|
---|
MediaCutthroughType | Yes | Yes | Enum | 0 | Possible values: - 0 - mctYesOnEarlyMedia
- 1 - mctYes
- 2 - mctNo
| Specifies the use of cut through media. When SBC receives PROCEEDING message it cuts through media by default regardless of PI presence. |
---|