Jump to

• Request
• Response

Retrieve one config element: SD.codec-policy

get

https://cloud-native-SBC-IP/config/v1/sd/codec-policy/{ElementKey}

Retrieve one config element: SD.codec-policy

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: CodecPolicyConfig

Body ()

Root Schema : schema

Type: object

create and apply a codec policy to a realm and an agent

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• add-codecs-on-egress: array add-codecs-on-egress
  Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.
• allow-codecs: array allow-codecs
  Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.
• dtmf-in-audio: string
  Allowed Values: [ "disabled", "preferred", "dual" ]
• evrc-tty-baudot-transcode: boolean
  Enable transcode of EVRC TTY TDD to BAUDOT in EVRC-G.711 transcoded calls
• fax-single-m-line: string
  Allowed Values: [ "disabled", "image_first", "audio_first" ]
• force-ptime: boolean
  Force a specific ptime on the egress offer. Enable this to ensure the ptime specified in 'packetization-time' is used.
• name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the codec-policy
• order-codecs: array order-codecs
  Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.
• packetization-time: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  This specifies the packetization time (ptime) to use in outgoing SDP offers when 'force-ptime' is enabled. The valid ptime values for each codec are as follows: PCMU 10 20 30 40 50 60, PCMA 10 20 30 40 50 60, G729 10 20 30 40 50 60, G729A 10 20 30 40 50 60, iLBC 20 30 40 60, G726 10 20 30 40 50, G726-16 10 20 30 40 50, G726-24 10 20 30 40 50, G726-32 10 20 30 40 50, G726-40 10 20 30 40 50, G723 30 60 90, G722 20 40, AMR 20 40 60, AMR-WB 20 40 60, opus 10 20 40 60, EVS 20 40 60, EVS AMR-WB IO 20 40 60, SILK 20 40 60.
• reverse-fax-tone-detection-reinvite: boolean
  Enable this flag to force the Cloud Native SBC to send a re-invite to a realm other than the one on which fax tone detection is enabled.
• secure-dtmf-cancellation: boolean
  Removes inband DTMF tones and mutes audio completely to suppress any DTMF tone bleed-through that may accompany incoming telephone-events toward egress.
• tone-detect-renegotiate-timer: integer (int64)
  Minimum Value: 50

  Maximum Value: 32000

  A timer is set after a tone is detected. Upon the expiry of this timer, a re-invite will be sent if the SD has not received a re-invite from the terminating endpoint.
• tone-detection: array tone-detection
  Enable tone detect

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the codec-policy",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "allow-codecs":{
            "description":"Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "add-codecs-on-egress":{
            "description":"Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "order-codecs":{
            "description":"Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "packetization-time":{
            "description":"This specifies the packetization time (ptime) to use in outgoing SDP offers when 'force-ptime' is enabled. The valid ptime values for each codec are as follows: PCMU 10 20 30 40 50 60, PCMA 10 20 30 40 50 60, G729 10 20 30 40 50 60, G729A 10 20 30 40 50 60, iLBC 20 30 40 60, G726 10 20 30 40 50, G726-16 10 20 30 40 50, G726-24 10 20 30 40 50, G726-32 10 20 30 40 50, G726-40 10 20 30 40 50, G723 30 60 90, G722 20 40, AMR 20 40 60, AMR-WB 20 40 60, opus 10 20 40 60, EVS 20 40 60, EVS AMR-WB IO 20 40 60, SILK 20 40 60.",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "force-ptime":{
            "description":"Force a specific ptime on the egress offer. Enable this to ensure the ptime specified in 'packetization-time' is used.",
            "type":"boolean"
        },
        "secure-dtmf-cancellation":{
            "description":"Removes inband DTMF tones and mutes audio completely to suppress any DTMF tone bleed-through that may accompany incoming telephone-events toward egress.",
            "type":"boolean"
        },
        "dtmf-in-audio":{
            "$ref":"#/components/schemas/XcodeDigitModeEnum"
        },
        "tone-detection":{
            "description":"Enable tone detect",
            "items":{
                "$ref":"#/components/schemas/ToneDetectListConstraintEnum"
            },
            "type":"array"
        },
        "tone-detect-renegotiate-timer":{
            "description":"A timer is set after a tone is detected. Upon the expiry of this timer, a re-invite will be sent if the SD has not received a re-invite from the terminating endpoint.",
            "format":"int64",
            "maximum":32000,
            "minimum":50,
            "type":"integer"
        },
        "reverse-fax-tone-detection-reinvite":{
            "description":"Enable this flag to force the Cloud Native SBC to send a re-invite to a realm other than the one on which fax tone detection is enabled.",
            "type":"boolean"
        },
        "fax-single-m-line":{
            "$ref":"#/components/schemas/XcodeFaxSingleMLineEnum"
        },
        "evrc-tty-baudot-transcode":{
            "description":"Enable transcode of EVRC TTY TDD to BAUDOT in EVRC-G.711 transcoded calls",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"create and apply a codec policy to a realm and an agent",
    "type":"object"
}

Nested Schema : add-codecs-on-egress

Type: array

Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.

Show Source

• Array of: string

{
    "description":"Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : allow-codecs

Type: array

Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.

Show Source

• Array of: string

{
    "description":"Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : order-codecs

Type: array

Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.

Show Source

• Array of: string

{
    "description":"Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : tone-detection

Type: array

Enable tone detect

Show Source

• Array of: string
  Allowed Values: [ "fax-v21", "fax-cng" ]

{
    "description":"Enable tone detect",
    "items":{
        "$ref":"#/components/schemas/ToneDetectListConstraintEnum"
    },
    "type":"array"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top