1. API Guide
  2. ISR Provisioning API
  3. Provisioning API Examples
  4. Codec Profile

Codec Profile

GET

REST URL - https://<IP>:<port>/provapi/codecProfile

SUPPORTED METHOD -  GET

HEADER - Authorization
Sample Request Body - Not required
Sample Response Body 
[ { "codecProfileId": 0, "preferences": 0, "codecMaps": [ { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0}, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 } ], "name": "string", "description": "string" }]
Example 
[ { "codecProfileId": 1, "preferences": 50, "codecMaps": [ { "codecMapId": 1, "codecProfileId": 1, "recordingFormatId": 6, "transmissionCodecId": 1 }, { "codecMapId": 2, "codecProfileId": 1, "recordingFormatId": 19, "transmissionCodecId": 2 }, { "codecMapId": 3, "codecProfileId": 1, "recordingFormatId": 7, "transmissionCodecId": 3 }, { "codecMapId": 4, "codecProfileId": 1, "recordingFormatId": 12, "transmissionCodecId": 4 }, { "codecMapId": 21, "codecProfileId": 1, "recordingFormatId": 13, "transmissionCodecId": 5 } ], "name": "Default", "description": "The default profile" }, { "codecProfileId": 2, "preferences": 0, "codecMaps": [ { "codecMapId": 5, "codecProfileId": 2, "recordingFormatId": 20, "transmissionCodecId": 1 }, { "codecMapId": 6, "codecProfileId": 2, "recordingFormatId": 20, "transmissionCodecId": 2 }, { "codecMapId": 7, "codecProfileId": 2, "recordingFormatId": 20, "transmissionCodecId": 3 }, { "codecMapId": 8, "codecProfileId": 2, "recordingFormatId": 20, "transmissionCodecId": 4 }, { "codecMapId": 22, "codecProfileId": 2, "recordingFormatId": 2, "transmissionCodecId": 5 } ], "name": "Smallest", "description": "The smallest file size" }, { "codecProfileId": 3, "preferences": 30, "codecMaps": [ { "codecMapId": 9, "codecProfileId": 3, "recordingFormatId": 16, "transmissionCodecId": 1 }, { "codecMapId": 10, "codecProfileId": 3, "recordingFormatId": 19, "transmissionCodecId": 2 }, { "codecMapId": 11, "codecProfileId": 3, "recordingFormatId": 7, "transmissionCodecId": 3 }, { "codecMapId": 12, "codecProfileId": 3, "recordingFormatId": 22, "transmissionCodecId": 4 }, { "codecMapId": 23, "codecProfileId": 3, "recordingFormatId": 7, "transmissionCodecId": 5 } ], "name": "Small", "description": "A blend of small files and good quality" }, { "codecProfileId": 4, "preferences": 100, "codecMaps": [ { "codecMapId": 13, "codecProfileId": 4, "recordingFormatId": 16, "transmissionCodecId": 1 }, { "codecMapId": 14, "codecProfileId": 4, "recordingFormatId": 19, "transmissionCodecId": 2 }, { "codecMapId": 15, "codecProfileId": 4, "recordingFormatId": 13, "transmissionCodecId": 3 }, { "codecMapId": 16, "codecProfileId": 4, "recordingFormatId": 16, "transmissionCodecId": 4 }, { "codecMapId": 24, "codecProfileId": 4, "recordingFormatId": 13, "transmissionCodecId": 5 } ], "name": "Best Quality", "description": "The best quality recordings" }, { "codecProfileId": 5, "preferences": 50, "codecMaps": [ { "codecMapId": 17, "codecProfileId": 5, "recordingFormatId": 13, "transmissionCodecId": 1 }, { "codecMapId": 18, "codecProfileId": 5, "recordingFormatId": 13, "transmissionCodecId": 2 }, { "codecMapId": 19, "codecProfileId": 5, "recordingFormatId": 13, "transmissionCodecId": 3 }, { "codecMapId": 20, "codecProfileId": 5, "recordingFormatId": 13, "transmissionCodecId": 4 }, { "codecMapId": 25, "codecProfileId": 5, "recordingFormatId": 13, "transmissionCodecId": 5 } ], "name": "Firefox Compatible", "description": "This Codec Profile is for use to support recording playback in modern versions of the Firefox Web Browser." }, { "codecProfileId": 7, "preferences": 50, "codecMaps": [ { "codecMapId": 31, "codecProfileId": 7, "recordingFormatId": 2, "transmissionCodecId": 1 }, { "codecMapId": 32, "codecProfileId": 7, "recordingFormatId": 2, "transmissionCodecId": 2 }, { "codecMapId": 33, "codecProfileId": 7, "recordingFormatId": 2, "transmissionCodecId": 3 }, { "codecMapId": 34, "codecProfileId": 7, "recordingFormatId": 2, "transmissionCodecId": 4 }, { "codecMapId": 35, "codecProfileId": 7, "recordingFormatId": 2, "transmissionCodecId": 5 } ], "name": "new format", "description": "re" } ]

POST

REST URL - https://<IP>:<port>/provapi/codecProfile

SUPPORTED METHOD -  POST

HEADER - Authorization
Sample Request Body 
{
"description": "string",
"name": "string"
}
Sample Response Body 
{ "codecProfileId": 0, "description": "string", "name": "string", "preferences": 0 }
Sample Input Body 
{
"description": "New codec",
"name": "Codec Description"
}
Sample Output Response 
{ "codecProfileId": 15, "name": "Codec Description", "description": "New codec", "preferences": 50 }

PUT

REST URL - https://<IP>:<port>/provapi/codecProfile/{codecProfileID}

SUPPORTED METHOD -  PUT

HEADER - Authorization

PATH PARAMETER - codecProfileID
Sample Request Body 
{
"description": "string",
"name": "string",
"preferences": 0
}
Sample Response Body 
{ "codecProfileId": 0, "description": "string", "name": "string", "preferences": 0 }
Sample Input Body 
{
"description": "Updated desc",
"name": "New codec",
"preferences": 100
}
Sample Output Response 
{
"description": "Updated desc",
"name": "New codec",
"preferences": 100
}

DELETE

REST URL - https://<IP>:<port>/provapi/codecProfile/{codecProfileID}

SUPPORTED METHOD -  DELETE

HEADER - Authorization

PATH PARAMETER - codecProfileID
Sample Request Body - Not required
Sample Response Body 
Codec Profile with ID <codecProfileID> has been deleted
Example 
Codec Profile with ID 3 has been deleted

PUT

REST URL - https://<IP>:<port>/provapi/codecProfile/codecMapEntry/{codecMapID}/recordingFormat/{recordingFormatID}

SUPPORTED METHOD -  PUT

HEADER - Authorization

PATH PARAMETER - codecMapID, recordingFormatID
Sample Request Body - Not required
Sample Response Body 
{ "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0}
Sample Input URL 
https://10.128.248.23:9443/provapi/codecProfile/codecMapEntry/23/recordingFormat/11
Sample Output Response 
{ "codecMapId": 23, "codecProfileId": 3, "recordingFormatId": 11, "transmissionCodecId": 5 }

GET

REST URL - https://<IP>:<port>/provapi/codecProfile/codecProfileName/{codecProfileName}

SUPPORTED METHOD -  GET

HEADER - Authorization
Sample Request Body - Not required
Sample Response Body 
{ "codecProfileId": 0, "preferences": 0, "codecMaps": [ { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0}, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 } ], "name": "string", "description": "string" }
Sample Input URL 
https://10.128.248.23:9443/provapi/codecProfile/codecProfileName/Default
Sample Output Response 
{ "codecProfileId": 1, "preferences": 50, "codecMaps": [ { "codecMapId": 1, "codecProfileId": 1, "recordingFormatId": 6, "transmissionCodecId": 1 }, { "codecMapId": 2, "codecProfileId": 1, "recordingFormatId": 19, "transmissionCodecId": 2 }, { "codecMapId": 3, "codecProfileId": 1, "recordingFormatId": 7, "transmissionCodecId": 3 }, { "codecMapId": 4, "codecProfileId": 1, "recordingFormatId": 12, "transmissionCodecId": 4 }, { "codecMapId": 21, "codecProfileId": 1, "recordingFormatId": 13, "transmissionCodecId": 5 } ], "name": "Default", "description": "The default profile" }

GET

REST URL - https://<IP>:<port>/provapi/codecProfile/recordingFormat

SUPPORTED METHOD -  GET

HEADER - Authorization
Sample Request Body - Not required
Sample Response Body 
[ { "recordingFormatId": 0, "name": "string" }]
Example 
[ { "recordingFormatId": 1, "name": "RDPP changed" }, { "recordingFormatId": 2, "name": "RAW ulaw" }, { "recordingFormatId": 3, "name": "RAW alaw" }, { "recordingFormatId": 4, "name": "RAW PCM" }, { "recordingFormatId": 5, "name": "WAVE PCM (8bit 8Khz) mono" }, { "recordingFormatId": 6, "name": "WAVE PCM (8bit 8Khz) stereo" }, { "recordingFormatId": 7, "name": "WAVE PCM (8bit 8Khz)" }, { "recordingFormatId": 8, "name": "WAVE PCM (16bit 8Khz) mono" }, { "recordingFormatId": 9, "name": "WAVE PCM (16bit 8Khz) stereo" }, { "recordingFormatId": 10, "name": "WAVE PCM (16bit 8Khz)" }, { "recordingFormatId": 11, "name": "WAVE PCM (16bit 16Khz) mono" }, { "recordingFormatId": 12, "name": "WAVE PCM (16bit 16Khz) stereo" }, { "recordingFormatId": 13, "name": "WAVE PCM (16bit 16Khz)" }, { "recordingFormatId": 14, "name": "WAVE ulaw (8bit 8Khz) mono" }, { "recordingFormatId": 15, "name": "WAVE ulaw (8bit 8Khz) stereo" }, { "recordingFormatId": 16, "name": "WAVE ulaw (8bit 8Khz)" }, { "recordingFormatId": 17, "name": "WAVE alaw (8bit 8Khz) mono" }, { "recordingFormatId": 18, "name": "WAVE alaw (8bit 8Khz) stereo" }, { "recordingFormatId": 19, "name": "WAVE alaw (8bit 8Khz)" }, { "recordingFormatId": 20, "name": "WAVE ADPCM (4bit 8Khz) mono" }, { "recordingFormatId": 21, "name": "WAVE ADPCM (4bit 8Khz) stereo" }, { "recordingFormatId": 22, "name": "WAVE ADPCM (4bit 8Khz)" } ]

GET

REST URL - https://<IP>:<port>/provapi/codecProfile/transmissionCodec

SUPPORTED METHOD -  GET

HEADER - Authorization
Sample Request Body - Not required
Sample Response Body 
[ { "transmissionCodecId": 0, "name": "string" }]
Example 
[ { "transmissionCodecId": 1, "name": "g.711 mulaw" }, { "transmissionCodecId": 2, "name": "g.711 alaw" }, { "transmissionCodecId": 3, "name": "g.722" }, { "transmissionCodecId": 4, "name": "g.729" }, { "transmissionCodecId": 5, "name": "AMR-WB/16000/1" } ]

GET

REST URL - https://<IP>:<port>/provapi/codecProfile/{codecProfileID}

SUPPORTED METHOD -  GET

HEADER - Authorization

PATH PARAMETER - codecProfileID
Sample Request Body - Not required
Sample Response Body 
{ "codecProfileId": 0, "preferences": 0, "codecMaps": [ { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0}, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 }, { "codecMapId": 0, "codecProfileId": 0, "recordingFormatId": 0, "transmissionCodecId": 0 } ], "name": "string", "description": "string" }
Example 
{ "codecProfileId": 1, "preferences": 50, "codecMaps": [ { "codecMapId": 1, "codecProfileId": 1, "recordingFormatId": 6, "transmissionCodecId": 1 }, { "codecMapId": 2, "codecProfileId": 1, "recordingFormatId": 19, "transmissionCodecId": 2 }, { "codecMapId": 3, "codecProfileId": 1, "recordingFormatId": 7, "transmissionCodecId": 3 }, { "codecMapId": 4, "codecProfileId": 1, "recordingFormatId": 12, "transmissionCodecId": 4 }, { "codecMapId": 21, "codecProfileId": 1, "recordingFormatId": 13, "transmissionCodecId": 5 } ], "name": "Default", "description": "The default profile" }