Process object specification
This is the specification of the object model
This is the specification of the Process model in JSON schema format
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Oliver API process JSON schema v1.1",
"type": "object",
"required": [
"pid",
"status",
"mode"
],
"properties": {
"pid": {
"type": "integer",
"description": "Unique ID for the processing job"
},
"cid": {
"type": "integer",
"description": "Unique ID for client associated with the process"
},
"name": {
"type": "string",
"description": "Label of the processing job (Client defined)"
},
"status": {
"type": "integer",
"description": "Shows the processing state of the job. Status is 0: pending, 1: processing, 2: completed, -1:failed, -2 aborted"
},
"statusmsg": {
"type": "string",
"description": "Human readable description of status"
},
"duration": {
"type": "number",
"description": "duration of the audio signal (in sec)"
},
"datetime": {
"type": "string",
"description": "date and time the request for processing was inserted into the system"
},
"uri": {
"type": "string",
"description": "where to find original audio data in file store"
},
"internal": {
"type": "string",
"description": "for internal system use"
},
"customerId": {
"type": "string",
"description": "Customer ID"
},
"customerInd": {
"type": "string",
"description": "Customer Industry"
},
"agentId": {
"type": "string",
"description": "Agent ID"
},
"agentTeam": {
"type": "string",
"description": "Agent's team ID"
},
"campaignId": {
"type": "string",
"description": "Campaign ID"
},
"calltype": {
"type": "string",
"description": "the type of call LA, AM"
},
"calltime": {
"type": "string",
"description": "call time"
},
"timezone": {
"type": "integer",
"description": "Timezone of call"
},
"calldirection": {
"type": "integer",
"description": "Who initiated the call"
},
"channels": {
"type": "integer",
"description": "Number of channels for audio signal"
},
"ANI": {
"type": "string",
"description": "ANI information"
},
"tag": {
"type": "array",
"description": "Client defined tagging of processing job",
"items": {
"type": "string"
}
},
"ports": {
"description": "For Websocket job use",
"type": "array",
"items": {
"type": "integer"
}
},
"mode": {
"description": "The processing job mode of operation 1=URI, 2=Audio file or 3=TCP",
"type": "integer"
},
"storedata": {
"description": "Boolean value to show if this process saves audio data in the storage. 0=no and 1=yes. Look the uri property for the location of the file in the cloud.",
"type": "integer"
},
"source": {
"description": "The source uri of the media file",
"type": "string"
}
}
}
Updated less than a minute ago
What’s Next