| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /files |
|---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum SortOrders
{
Ascend = 'Ascend',
Descend = 'Descend',
}
export class ListRequest<T> implements IGet
{
/**
* The page of data to retrieve
*/
// @ApiMember(Description="The page of data to retrieve")
public page?: number;
/**
* If you want all objects to be returned. This should be used with care
*/
// @ApiMember(Description="If you want all objects to be returned. This should be used with care")
public all?: boolean;
/**
* The number per page to retrieve
*/
// @ApiMember(Description="The number per page to retrieve")
public countPerPage?: number;
/**
* Specific IDs
*/
// @ApiMember(Description="Specific IDs")
public specificIds?: string[];
/**
* Specify a sort field
*/
// @ApiMember(Description="Specify a sort field")
public sortField?: string;
/**
* Specify a sort order
*/
// @ApiMember(Description="Specify a sort order")
public sortOrder?: SortOrders;
/**
* Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
*/
// @ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
public simplifiedPaging?: boolean;
public constructor(init?: Partial<ListRequest<T>>) { (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); }
}
/**
* Query for files
*/
// @Api(Description="Query for files")
export class ListFiles extends ListRequest<FileInfo>
{
/**
* Filter by account id
*/
// @ApiMember(Description="Filter by account id")
public accountIds?: string[];
/**
* Filter by customer id
*/
// @ApiMember(Description="Filter by customer id")
public customerIds?: string[];
/**
* Filter by specific session
*/
// @ApiMember(Description="Filter by specific session")
public sessionId?: string;
/**
* Filter by file name (contains filter)
*/
// @ApiMember(Description="Filter by file name (contains filter)")
public fileName?: string;
/**
* Filter by content type (contains filter)
*/
// @ApiMember(Description="Filter by content type (contains filter)")
public contentType?: string;
/**
* Filter by type
*/
// @ApiMember(Description="Filter by type")
public type?: FileTypes;
/**
* Filter by date created (start of range)
*/
// @ApiMember(Description="Filter by date created (start of range)")
public dateCreatedStart?: string;
/**
* Filter by date created (end of range)
*/
// @ApiMember(Description="Filter by date created (end of range)")
public dateCreatedEnd?: string;
/**
* Filter by agent ID
*/
// @ApiMember(Description="Filter by agent ID")
public userId?: string;
/**
* Search transcription
*/
// @ApiMember(Description="Search transcription")
public transcriptionContains?: string;
public constructor(init?: Partial<ListFiles>) { super(init); (Object as any).assign(this, init); }
}
export class BillingItem
{
public baseCost?: number;
public rawUnitMultiplier?: number;
public unitCost?: number;
public allowance?: number;
public constructor(init?: Partial<BillingItem>) { (Object as any).assign(this, init); }
}
export class BillingSettings
{
public base?: BillingItem;
public localNumbers?: BillingItem;
public tollFreeNumbers?: BillingItem;
public inboundVoiceCalls?: BillingItem;
public outboundVoiceCalls?: BillingItem;
public inboundFaxes?: BillingItem;
public outboundFaxes?: BillingItem;
public inboundSmsMessages?: BillingItem;
public outboundSmsMessages?: BillingItem;
public constructor(init?: Partial<BillingSettings>) { (Object as any).assign(this, init); }
}
export class AccountInfo extends EntityInfo
{
/**
* The name of this account
*/
// @ApiMember(Description="The name of this account")
public name?: string;
/**
* The ID of this account's parent
*/
// @ApiMember(Description="The ID of this account's parent")
public parentAccountId?: string;
/**
* The twilio account SID
*/
// @ApiMember(Description="The twilio account SID")
public twilioAccountSid?: string;
/**
* The ancestors of this account. Useful for breadcrumbs
*/
// @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
public ancestorIds?: string[];
/**
* The max number of phone numbers this account can have
*/
// @ApiMember(Description="The max number of phone numbers this account can have")
public maxPhoneNumbers?: number;
/**
* This account is BYOA
*/
// @ApiMember(Description="This account is BYOA")
public isBYOA?: boolean;
/**
* TrustHub Profile Sid
*/
// @ApiMember(Description="TrustHub Profile Sid")
public trustHubProfileSid?: string;
/**
* The ID of the logo file
*/
// @ApiMember(Description="The ID of the logo file")
public logoId?: string;
/**
* The URI of the logo file
*/
// @ApiMember(Description="The URI of the logo file")
public logoUri?: string;
/**
* The billing settings for this account
*/
// @ApiMember(Description="The billing settings for this account")
public billingSettings?: BillingSettings;
public constructor(init?: Partial<AccountInfo>) { super(init); (Object as any).assign(this, init); }
}
export class ListResponse<AccountInfo>
{
/**
* The items
*/
// @ApiMember(Description="The items")
public items?: AccountInfo[];
/**
* The total number of items
*/
// @ApiMember(Description="The total number of items")
public totalCount?: number;
/**
* The total number of pages
*/
// @ApiMember(Description="The total number of pages")
public totalPages?: number;
/**
* Are there more pages of items? Used with simplified paging
*/
// @ApiMember(Description="Are there more pages of items? Used with simplified paging")
public hasMorePages?: boolean;
public constructor(init?: Partial<ListResponse<AccountInfo>>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /files HTTP/1.1 Host: evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
items:
[
{
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
}
],
totalCount: 0,
totalPages: 0,
hasMorePages: False
}