System Recordings module GraphQL APIs
- Nathaniel Halbrooks
This wiki is to capture the System Recordings module provided GraphQL APIs.
Add System Recording
Add new system recording to the system.
API : addRecording
API Parameters:
Name | Required | Type | Default | Description |
|---|---|---|---|---|
name | Mandatory | string |
| Name of the recording |
description | Optional | string |
| Description of the recording |
fcode | Optional | id | 0 | Feature code |
fcode_pass | Optional | string |
| Feature code password |
language | Optional | string |
| Language of recording |
playback | Mandatory | list of strings |
| List of existing playback files in the system |
codecs | Optional | list of strings |
| List of allowed formats to which playback files to be converted |
Query Parameters
status
message
id |
API Request
API Request:
mutation {
addRecording(input:{
name: "rec2"
description: "rec2"
fcode: 0
fcode_pass: ""
language: "en"
playback: [
"1-yes-2-no"
]
codecs: [
"wav"
"sln"
]
})
{
status
message
id
}
} |
API Response
API Response:
{
"data": {
"addRecording": {
"status": true,
"message": "Recording added succefully",
"id": "2"
}
}
} |
Update System Recording
Update an existing system recording in the system.
API : updateRecording
API Parameters:
Name | Required | Type | Default | Description |
|---|---|---|---|---|
id | Mandatory | id |
| Id of the Recording |
name | Mandatory | string |
| Name of the recording |
description | Optional | string |
| Description of the recording |
fcode | Optional | id | 0 | Feature code |
fcode_pass | Optional | string |
| Feature code password |
language | Optional | string |
| Language of recording |
playback | Mandatory | list of strings |
| List of existing playback files in the system |
codecs | Optional | list of strings |
| List of allowed formats to which playback files to be converted |
Query Parameters
API Request
API Response
Fetch System Recordings
Fetch all system recordings exists in the system.
API : fetchAllRecordings
Query Parameters
API Request
API Response
Delete System Recording
Delete an existing system recording from the system.
API : deleteRecording
API Parameters:
Name | Required | Type | Description |
|---|---|---|---|
id | Mandatory | id | Id of the Recording |
Query Parameters
API Request
API Response
Fetch System Recording uploaded files
Fetch an system recording media files from the system.
API : fetchRecordingFiles
API Parameters:
Name | Required | Type | Description |
|---|---|---|---|
search | Mandatory | string | search string to fetch files with matching name |
Query Parameters
API Request
API Response