POST | /app/file |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export class EntityInfo
{
/**
* The ID of the object
*/
// @ApiMember(Description="The ID of the object")
public id?: string;
/**
* The date the object was created
*/
// @ApiMember(Description="The date the object was created")
public dateCreated?: string;
/**
* The date the object was last modified
*/
// @ApiMember(Description="The date the object was last modified")
public dateLastModified?: string;
/**
* The user that created this object
*/
// @ApiMember(Description="The user that created this object")
public createdBy?: string;
/**
* The user that last modified this object
*/
// @ApiMember(Description="The user that last modified this object")
public lastModifiedBy?: string;
public constructor(init?: Partial<EntityInfo>) { (Object as any).assign(this, init); }
}
export enum FileTypes
{
Upload = 'Upload',
VoiceMessage = 'VoiceMessage',
CallRecording = 'CallRecording',
Fax = 'Fax',
Attachment = 'Attachment',
FaxOutgoing = 'FaxOutgoing',
}
export class CustomerBreadcrumb
{
public id?: string;
public name?: string;
public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}
export class FileInfo extends EntityInfo
{
/**
* The type of file this is
*/
// @ApiMember(Description="The type of file this is")
public type?: FileTypes;
/**
* The account ID this file is associated with
*/
// @ApiMember(Description="The account ID this file is associated with")
public accountId?: string;
/**
* The name of the account this file is associated with
*/
// @ApiMember(Description="The name of the account this file is associated with")
public accountName?: string;
/**
* The ID of the customer this file is associated with
*/
// @ApiMember(Description="The ID of the customer this file is associated with")
public customerId?: string;
/**
* The name of the customer this file is associated with
*/
// @ApiMember(Description="The name of the customer this file is associated with")
public customerName?: string;
/**
* The breadcrumb to the customer for this file
*/
// @ApiMember(Description="The breadcrumb to the customer for this file")
public customerBreadcrumb?: CustomerBreadcrumb[];
/**
* The ID of the user this file is assocaited with
*/
// @ApiMember(Description="The ID of the user this file is assocaited with")
public userId?: string;
/**
* The name of the user this file is associated with
*/
// @ApiMember(Description="The name of the user this file is associated with")
public userName?: string;
/**
* The original file name for the file
*/
// @ApiMember(Description="The original file name for the file")
public fileName?: string;
/**
* The URI of the file
*/
// @ApiMember(Description="The URI of the file")
public uri?: string;
/**
* The Content type of the file
*/
// @ApiMember(Description="The Content type of the file")
public contentType?: string;
/**
* The size of the file
*/
// @ApiMember(Description="The size of the file")
public contentLength?: number;
/**
* The Twilio ID of the recording
*/
// @ApiMember(Description="The Twilio ID of the recording")
public recordingSid?: string;
/**
* The duration of the recording in seconds
*/
// @ApiMember(Description="The duration of the recording in seconds")
public recordingDuration?: number;
/**
* Who is the recording from?
*/
// @ApiMember(Description="Who is the recording from?")
public recordingFrom?: string;
/**
* Transcription (if available)
*/
// @ApiMember(Description="Transcription (if available)")
public transcription?: string;
/**
* From Address (e.g. caller ID) for incoming calls
*/
// @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
public fromAddress?: string;
/**
* To Address (e.g. dialed number) for outgoing calls
*/
// @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
public toAddress?: string;
public constructor(init?: Partial<FileInfo>) { super(init); (Object as any).assign(this, init); }
}
/**
* Creates a new file. You can either upload directly or via form files multipart
*/
// @Api(Description="Creates a new file. You can either upload directly or via form files multipart")
export class AppUploadFile
{
public fileName?: string;
public accountId?: string;
public customerId?: string;
public constructor(init?: Partial<AppUploadFile>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /app/file HTTP/1.1
Host: evovoice.io
Accept: application/json
Content-Type: application/json
Content-Length: length
{"fileName":"String","accountId":"String","customerId":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"type":"Upload","accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"userId":"String","userName":"String","fileName":"String","uri":"String","contentType":"String","contentLength":0,"recordingSid":"String","recordingDuration":0,"recordingFrom":"String","transcription":"String","fromAddress":"String","toAddress":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}