$schema: http://support.riverbed.com/apis/service_def/2.2
description: NPM APIs for VoIP Module.
id: http://support.riverbed.com/apis/npm.voip_module/1.0
name: npm.voip_module
provider: riverbed
resources:
  quality_threshold:
    additionalProperties: false
    description: UCA Quality Threshold.
    links:
      delete: {description: Deletes a UCA Quality Threshold., method: DELETE}
      get:
        description: Returns a UCA Quality Threshold.
        method: GET
        response: {$ref: '#/resources/quality_threshold'}
      self: {path: '$/quality_thresholds/items/{codec}'}
      set:
        description: Updates a UCA Quality Threshold.
        method: PUT
        request: {$ref: '#/resources/quality_threshold'}
        response: {$ref: '#/resources/quality_threshold'}
    properties:
      codec: {$ref: '#/types/codec_name_enum'}
      enabled: {description: Enable/disable the rule., type: boolean}
      fair_mos_threshold:
        description: MOS value fair threshold.
        tags: {cpptype: double}
        type: number
      poor_mos_threshold:
        description: MOS value poor threshold.
        tags: {cpptype: double}
        type: number
      worst_mos_threshold:
        description: MOS value worst threshold.
        tags: {cpptype: double}
        type: number
    required: [codec, enabled, worst_mos_threshold, poor_mos_threshold, fair_mos_threshold]
    type: object
  quality_thresholds:
    additionalProperties: false
    description: UCA Quality thresholds.
    links:
      bulk_create:
        description: Adds a list of UCA Quality thresholds.
        method: POST
        path: $/quality_thresholds/bulk_create
        request: {$ref: '#/resources/quality_thresholds'}
        response: {$ref: '#/resources/quality_thresholds'}
      bulk_delete:
        description: Deletes a list of UCA Quality thresholds.
        method: POST
        path: $/quality_thresholds/bulk_delete
        request: {$ref: '#/types/bulk_deleter'}
        response: {$ref: '#/types/bulk_deleter'}
      create:
        description: Adds a new UCA Quality Threshold.
        method: POST
        request: {$ref: '#/resources/quality_threshold'}
        response: {$ref: '#/resources/quality_threshold'}
      get:
        description: Returns the list of UCA Quality thresholds.
        method: GET
        response: {$ref: '#/resources/quality_thresholds'}
      self: {path: $/quality_thresholds}
    properties:
      items:
        items: {$ref: '#/resources/quality_threshold'}
        type: array
    type: object
  voip_module:
    additionalProperties: false
    description: UCA Module configuration.
    links:
      get:
        description: Returns the UCA Module configuration.
        method: GET
        response: {$ref: '#/resources/voip_module'}
      self: {path: $/voip_module}
      set:
        description: Updates the UCA Module configuration.
        method: PUT
        request: {$ref: '#/resources/voip_module'}
        response: {$ref: '#/resources/voip_module'}
    properties:
      enabled: {description: Enable/disable UCA Module., type: boolean}
      infer_call_from_rtp: {description: Enable/disable inferred call for media streams
          in case signaling is not available., type: boolean}
      ssl_enabled: {description: Enable/disable Signaling over SSL., type: boolean}
    required: [enabled]
    type: object
title: NPM VoIP Module APIs
types:
  bulk_deleter:
    additionalProperties: false
    description: Bulk Deleter configuration.
    properties:
      delete_all: {description: Delete all objects in the given configuration., type: boolean}
      delete_ids:
        items: {$ref: '#/types/codec_name_enum'}
        type: array
    type: object
  codec_name_enum:
    description: unique codec name.
    enum: [DEFAULT, AudioAC3, AudioAMRWBPlus, AudioAudioVorbis, AudioMPEG2AAC, AudioMPEG4AAC,
      AudioMPEG4HEAAC, AudioMPEG4HEAACv2, AudioMPEG4LCAAC, AudioMPEG4LDAAC, AudioMPEGL1,
      AudioMPEGL2, AudioMPEGL3, AudioSDPPktLoopback, AudioUser1, AudioUser2, AudioUser3,
      AudioUser4, AudioWMAP, InbandCNG, InbandDTMF, InbandOther, VideoAV1, VideoAVSAVSPlus,
      VideoH261, VideoH263, VideoH263Plus, VideoH264, VideoH264SVC, VideoH265, VideoH266,
      VideoJPEG, VideoMPEG1, VideoMPEG2, VideoMPEG4, VideoRawUncompressedActiveVideo,
      VideoSDPPktLoopback, VideoUser1, VideoUser2, VideoUser3, VideoUser4, VideoVC1,
      VideoVP6, VideoVP8, VideoVP9, VoiceAMBE2plus, VoiceAMBE2plus_2k4, VoiceAMBE2plus_3k2,
      VoiceAMBE2plus_4k, VoiceAMBE2plus_4k8, VoiceAMR, VoiceAMRNB10k2, VoiceAMRNB12k2,
      VoiceAMRNB4k75, VoiceAMRNB5k15, VoiceAMRNB5k9, VoiceAMRNB6k7, VoiceAMRNB7k4,
      VoiceAMRNB7k95, VoiceAMRWBP, VoiceBV, VoiceBV16, VoiceBV32, VoiceDefault, VoiceDefaultNarrowband,
      VoiceDefaultWideband, VoiceEVS, VoiceEVRC, VoiceEVRCA_4k, VoiceEVRCA_5k14, VoiceEVRCA_6k28,
      VoiceEVRCA_7k41, VoiceEVRCA_8k55, VoiceEVRCB, VoiceEVRCB_4k, VoiceEVRCB_5k08,
      VoiceEVRCB_5k45, VoiceEVRCB_5k82, VoiceEVRCB_6k18, VoiceEVRCB_6k64, VoiceEVRCB_7k57,
      VoiceEVRCB_8k3, VoiceEVRCNBWB_4k, VoiceEVRCNBWB_5k08, VoiceEVRCNBWB_5k45, VoiceEVRCNBWB_5k82,
      VoiceEVRCNBWB_6k18, VoiceEVRCNBWB_6k64, VoiceEVRCNBWB_7k5, VoiceEVRCNBWB_8k3,
      VoiceEVRCNW, VoiceEVRCWB, VoiceEVRCWB_4k, VoiceEVRCWB_7k5, VoiceEVRCWB_8k3,
      VoiceEvsFB, VoiceEvsFBFEC, VoiceEvsNB, VoiceEvsNBFEC, VoiceEvsSWB, VoiceEvsSWBFEC,
      VoiceEvsWB, VoiceEvsWBFEC, VoiceG711_64kaWB, VoiceG711A, VoiceG711A56k, VoiceG711APLC,
      VoiceG711APLC56k, VoiceG711u, VoiceG711u56k, VoiceG711uPLC, VoiceG711uPLC56k,
      VoiceG711uWB, VoiceG719, VoiceG719_112k, VoiceG719_128k, VoiceG719_32k, VoiceG719_36k,
      VoiceG719_40k, VoiceG719_48k, VoiceG719_64k, VoiceG719_88k, VoiceG719_96k, VoiceG722,
      VoiceG722_48k, VoiceG722_56k, VoiceG722_64k, VoiceG7221_16k, VoiceG7221_24k,
      VoiceG7221_32k, VoiceG7221c_24k, VoiceG7221c_32k, VoiceG7221c_48k, VoiceG7221cLPR_24k,
      VoiceG7221cLPR_32k, VoiceG7221cLPR_48k, VoiceG7222, VoiceG7222_12k65, VoiceG7222_14k25,
      VoiceG7222_15k85, VoiceG7222_18k25, VoiceG7222_19k85, VoiceG7222_23k05, VoiceG7222_23k85,
      VoiceG7222_6k6, VoiceG7222_8k85, VoiceG7231, VoiceG723153K, VoiceG723163K, VoiceG7231C,
      VoiceG726, VoiceG72616K, VoiceG72624K, VoiceG72632K, VoiceG72640K, VoiceG728,
      VoiceG729, VoiceG729A, VoiceG729E11k8, VoiceG729E8k0, VoiceG729_8k, VoiceGIPSE711A,
      VoiceGIPSE711u, VoiceGIPSG729, VoiceGIPSiLBC, VoiceGIPSiPCMwb, VoiceGIPSiSAC,
      VoiceGSM, VoiceGSMEFR, VoiceGSMFR, VoiceGSMHR, VoiceILBC, VoiceILBC13k3, VoiceILBC15k2,
      VoiceIS54, VoiceL16, VoiceL16_128k, VoiceL16_256k, VoiceL16_384k, VoiceL16_512k,
      VoiceL16_768k, VoiceL16FB, VoiceL16FB_256k, VoiceL16FB_384k, VoiceL16FB_512k,
      VoiceL16FB_705k6, VoiceL16FB_768k, VoiceL16FBPLC, VoiceL16FBPLC_256k, VoiceL16FBPLC_384k,
      VoiceL16FBPLC_512k, VoiceL16FBPLC_705k6, VoiceL16FBPLC_768k, VoiceL16NB, VoiceL16NB_256k,
      VoiceL16NB_384k, VoiceL16NB_512k, VoiceL16NB_768k, VoiceL16NBPLC, VoiceL16NBPLC_256k,
      VoiceL16NBPLC_384k, VoiceL16NBPLC_512k, VoiceL16NBPLC_768k, VoiceL16SWB, VoiceL16SWB_256k,
      VoiceL16SWB_384k, VoiceL16SWB_512k, VoiceL16SWB_768k, VoiceL16SWBPLC, VoiceL16SWBPLC_256k,
      VoiceL16SWBPLC_384k, VoiceL16SWBPLC_512k, VoiceL16SWBPLC_768k, VoiceL16WB, VoiceL16WB_256k,
      VoiceL16WB_384k, VoiceL16WB_512k, VoiceL16WB_768k, VoiceL16WBPLC, VoiceL16WBPLC_256k,
      VoiceL16WBPLC_384k, VoiceL16WBPLC_512k, VoiceL16WBPLC_768k, VoiceL24, VoiceL24_1058k5,
      VoiceL24_1152k, VoiceL24_2304k, VoiceL24_4608k, VoiceL32, VoiceL32_1058k5, VoiceL32_4608k,
      VoiceMSRTAudio, VoiceMSRTAudioNB, VoiceMSRTAudioNBRED, VoiceMSRTAudioWB, VoiceMSRTAudioWBRED,
      VoiceOpus, VoiceOpusCeltFB, VoiceOpusCeltNB, VoiceOpusCeltSWB, VoiceOpusCeltWB,
      VoiceOpusHybridFB, VoiceOpusHybridFBFEC, VoiceOpusHybridSWB, VoiceOpusHybridSWBFEC,
      VoiceOpusSilkMB, VoiceOpusSilkMBFEC, VoiceOpusSilkNB, VoiceOpusSilkNBFEC, VoiceOpusSilkWB,
      VoiceOpusSilkWBFEC, VoicePDC, VoicePDC6k7, VoiceQCELP, VoiceQCELP13, VoiceQCELP8,
      VoiceSDPPktLoopback, VoiceSILK, VoiceSilkMB, VoiceSilkMBFEC, VoiceSilkNB, VoiceSilkNBFEC,
      VoiceSilkSWB, VoiceSilkSWBFEC, VoiceSilkWB, VoiceSilkWBFEC, VoiceSiren, VoiceSiren22,
      VoiceSiren22_32k, VoiceSiren22_48k, VoiceSiren22_64k, VoiceSiren22LPR_32k, VoiceSiren22LPR_48k,
      VoiceSiren22LPR_64k, VoiceSMV, VoiceSMV_3k95, VoiceSMV_4k, VoiceSMV_4k5, VoiceSMV_5k82,
      VoiceSMV_7k95, VoiceSpeex, VoiceSpeex11k, VoiceSpeex12k8, VoiceSpeex15k, VoiceSpeex16k8,
      VoiceSpeex18k2, VoiceSpeex20k6, VoiceSpeex23k8, VoiceSpeex24k6, VoiceSpeex27k8,
      VoiceSpeex2k15, VoiceSpeex34k2, VoiceSpeex3k95, VoiceSpeex42k2, VoiceSpeex5k95,
      VoiceSpeex8k, VoiceSpeexUWB_11k6, VoiceSpeexUWB_14k6, VoiceSpeexUWB_18k6, VoiceSpeexUWB_22k4,
      VoiceSpeexUWB_25k6, VoiceSpeexUWB_29k6, VoiceSpeexUWB_36k, VoiceSpeexUWB_44k,
      VoiceSpeexUWB_5k75, VoiceSpeexUWB_7k55, VoiceSpeexUWB_9k55, VoiceSpeexWB_7k75,
      VoiceSpeexWB_9k8, VoiceSX, VoiceSX_7k3, VoiceSX_9k9, VoiceSX7300, VoiceSX9600,
      VoiceUser1, VoiceUser2, VoiceUser3, VoiceUser4, VoiceWBLinearPCM, VoiceWBLinearPCM_PLC]
    type: string
version: '1.0'