API Reference
API Reference

Move Insights Upload Files

POST/api/v1/insights/folders/{folder_id}/move-files

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

folder_id integer path required

Request body

application/json

body InsightsFolderFileMove required
2 fields
destination_folder_idintegerrequired

System-assign folder ID

file_id_listinteger[]required

List of system-assigned IDs for the files to be moved

Item schema
itemsintegerrequired
Request example
{
  "destination_folder_id": 0,
  "file_id_list": [
    0
  ]
}

Responses

200Successful Response

application/json

response InsightsUploadFile[] required
Item schema
itemsInsightsUploadFilerequired

Response model for an insight upload file.

13 fields
idintegerrequired

System-assigned ID for the upload file

folder_idintegerrequired

System-assigned ID for the folder to which the file belongs

filenamestringrequired

Name of the uploaded file

object_keystringrequired

Object-store key of the uploaded file

call_idstring | nulloptional

Unique identifier for the call associated with the uploaded file

agent_numberstring | nulloptional

Agent number associated with the uploaded file

customer_numberstring | nulloptional

Customer number associated with the uploaded file

durationnumber | nulloptional

Length in seconds of the uploaded recording

start_timestring (date-time) | nulloptional

Start time of the uploaded file

end_timestring (date-time) | nulloptional

End time of the uploaded file

error_messagestring | nulloptional

Error message associated with the uploaded file

metadataobject | nulloptional

Meta-data associated with the uploaded file

1 options
{key}string | integer | numberoptional
3 options
Option 1stringoptional
Option 2integeroptional
Option 3numberoptional
created_atstring (date-time)optional

Timestamp at which insight upload file was created

Response example
[
  {
    "id": 0,
    "folder_id": 0,
    "filename": "string",
    "object_key": "string",
    "call_id": "string",
    "agent_number": "string",
    "customer_number": "string",
    "duration": "string",
    "start_time": "string",
    "end_time": "string",
    "error_message": "string",
    "metadata": "string",
    "created_at": "string"
  }
]
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}