| GET | /sessions |
|---|
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 SessionDialState
{
None = 'None',
Active = 'Active',
}
export enum SessionCallState
{
Disconnected = 'Disconnected',
Ringing = 'Ringing',
Connected = 'Connected',
Hold = 'Hold',
Passive = 'Passive',
}
export enum SessionQueueStates
{
None = 'None',
Queued = 'Queued',
Ringing = 'Ringing',
Connected = 'Connected',
Hold = 'Hold',
Disconnected = 'Disconnected',
}
export class CustomerBreadcrumb
{
public id?: string;
public name?: string;
public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}
export enum FlowChannels
{
Voice = 'Voice',
Chat = 'Chat',
Fax = 'Fax',
}
export enum SessionHoldReasons
{
None = 'None',
Transferring = 'Transferring',
}
export class SessionLogInfo
{
public date?: string;
public message?: string;
public constructor(init?: Partial<SessionLogInfo>) { (Object as any).assign(this, init); }
}
export enum SessionMemberCallState
{
None = 'None',
Ringing = 'Ringing',
Connected = 'Connected',
Hold = 'Hold',
}
export enum SessionMemberRoles
{
None = 'None',
Caller = 'Caller',
Agent = 'Agent',
Transfer = 'Transfer',
}
export class SessionMemberInfo
{
public identity?: string;
public endpointId?: string;
public displayName?: string;
public isOriginalMember?: boolean;
public avatarUrl?: string;
public applicationData?: { [index: string]: string; };
public callState?: SessionMemberCallState;
public role?: SessionMemberRoles;
public callSid?: string;
public muted?: boolean;
public constructor(init?: Partial<SessionMemberInfo>) { (Object as any).assign(this, init); }
}
export enum SessionDirections
{
Incoming = 'Incoming',
Outgoing = 'Outgoing',
}
export class SessionInfo extends EntityInfo
{
/**
* The state of the session
*/
// @ApiMember(Description="The state of the session")
public dialState?: SessionDialState;
/**
* The call state of the session
*/
// @ApiMember(Description="The call state of the session")
public callState?: SessionCallState;
/**
* The queue state of the session
*/
// @ApiMember(Description="The queue state of the session")
public queueState?: SessionQueueStates;
/**
* The ID of the account associated with the flow
*/
// @ApiMember(Description="The ID of the account associated with the flow")
public accountId?: string;
/**
* The name of the account associated with the session
*/
// @ApiMember(Description="The name of the account associated with the session")
public accountName?: string;
/**
* The ID of the customer this session is associated with
*/
// @ApiMember(Description="The ID of the customer this session is associated with")
public customerId?: string;
/**
* The customer breadcrumb this session is associated with
*/
// @ApiMember(Description="The customer breadcrumb this session is associated with")
public customerBreadcrumb?: CustomerBreadcrumb[];
/**
* The name of the customer this session is associated with
*/
// @ApiMember(Description="The name of the customer this session is associated with")
public customerName?: string;
/**
* The ID of the endpoint associated with this session
*/
// @ApiMember(Description="The ID of the endpoint associated with this session")
public endpointId?: string;
/**
* The name of the endpoint associated with this session
*/
// @ApiMember(Description="The name of the endpoint associated with this session")
public endpointName?: string;
/**
* The date the call completed
*/
// @ApiMember(Description="The date the call completed")
public dateCompleted?: string;
/**
* The destination of the session (e.g. what was entered into the Dial box)
*/
// @ApiMember(Description="The destination of the session (e.g. what was entered into the Dial box)")
public destination?: string;
/**
* The to address if any
*/
// @ApiMember(Description="The to address if any")
public toAddress?: string;
/**
* The from address if any
*/
// @ApiMember(Description="The from address if any")
public fromAddress?: string;
/**
* The from name if any
*/
// @ApiMember(Description="The from name if any")
public fromName?: string;
/**
* Answered by name (if any)
*/
// @ApiMember(Description="Answered by name (if any)")
public answeredByName?: string;
/**
* The ID of the queue member assigned to this call
*/
// @ApiMember(Description="The ID of the queue member assigned to this call")
public queueMemberId?: string;
/**
* The flow channel
*/
// @ApiMember(Description="The flow channel")
public channel?: FlowChannels;
/**
* Has the session ended
*/
// @ApiMember(Description="Has the session ended")
public ended?: boolean;
/**
* The outcome of the call
*/
// @ApiMember(Description="The outcome of the call")
public outcome?: string;
/**
* The twilio Call SID of this session
*/
// @ApiMember(Description="The twilio Call SID of this session")
public callSid?: string;
/**
* Any console data for this session
*/
// @ApiMember(Description="Any console data for this session")
public consoleData?: string;
/**
* The name of the hold queue for this call
*/
// @ApiMember(Description="The name of the hold queue for this call")
public holdQueueName?: string;
/**
* The user ID who put this call on hold
*/
// @ApiMember(Description="The user ID who put this call on hold")
public heldByUserId?: string;
/**
* The reason for the hold
*/
// @ApiMember(Description="The reason for the hold")
public holdReason?: SessionHoldReasons;
/**
* The SID of the conference if in a conference call
*/
// @ApiMember(Description="The SID of the conference if in a conference call")
public conferenceSid?: string;
/**
* The display name for this session
*/
// @ApiMember(Description="The display name for this session")
public displayName?: string;
/**
* The log entries for this session
*/
// @ApiMember(Description="The log entries for this session")
public log?: SessionLogInfo[];
/**
* The members of this session
*/
// @ApiMember(Description="The members of this session")
public members?: SessionMemberInfo[];
/**
* The callback number (typically used for SIP to User calls)
*/
// @ApiMember(Description="The callback number (typically used for SIP to User calls)")
public callbackNumber?: string;
/**
* The ID of the endpoint that answered
*/
// @ApiMember(Description="The ID of the endpoint that answered")
public answeredById?: string;
/**
* Is this session incoming or outgoing?
*/
// @ApiMember(Description="Is this session incoming or outgoing?")
public direction?: SessionDirections;
/**
* The phone number that this session is coming from (used with SMS chats)
*/
// @ApiMember(Description="The phone number that this session is coming from (used with SMS chats)")
public fromPhoneNumber?: string;
/**
* The Call SID of the most recently added conference participant
*/
// @ApiMember(Description="The Call SID of the most recently added conference participant")
public mostRecentParticipantCallSid?: string;
/**
* Was this session missed?
*/
// @ApiMember(Description="Was this session missed?")
public wasMissed?: boolean;
/**
* The ring queue that the call is currently in
*/
// @ApiMember(Description="The ring queue that the call is currently in")
public ringQueueId?: string;
public constructor(init?: Partial<SessionInfo>) { super(init); (Object as any).assign(this, init); }
}
/**
* Retrieve a list of sessions
*/
// @Api(Description="Retrieve a list of sessions")
export class ListSessions extends ListRequest<SessionInfo>
{
/**
* The account IDs for the sessions to retrieve
*/
// @ApiMember(Description="The account IDs for the sessions to retrieve")
public accountIds?: string[];
/**
* Whether to search live or archived sessions
*/
// @ApiMember(Description="Whether to search live or archived sessions")
public searchArchive?: boolean;
/**
* The start date to retrieve usage records for (YYYY-MM-DD)
*/
// @ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")
public startDate?: string;
/**
* The end date to retrieve usage records for (YYYY-MM-DD)
*/
// @ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)")
public endDate?: string;
/**
* The IDs of the customers whose sessions you want to retrieve
*/
// @ApiMember(Description="The IDs of the customers whose sessions you want to retrieve")
public customerIds?: string[];
/**
* The IDs of the endpoints whose sessions you want to retrieve
*/
// @ApiMember(Description="The IDs of the endpoints whose sessions you want to retrieve")
public endpointIds?: string[];
/**
* Filter by the from (this is a contains search)
*/
// @ApiMember(Description="Filter by the from (this is a contains search)")
public from?: string;
/**
* Filter by the to (this is a contains search)
*/
// @ApiMember(Description="Filter by the to (this is a contains search)")
public to?: string;
/**
* Filter by text in the log
*/
// @ApiMember(Description="Filter by text in the log")
public log?: string;
/**
* Filter by parent session ID
*/
// @ApiMember(Description="Filter by parent session ID")
public parentSessionId?: string;
public constructor(init?: Partial<ListSessions>) { 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 .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.
GET /sessions HTTP/1.1 Host: evovoice.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":[{"dialState":"None","callState":"Disconnected","queueState":"None","accountId":"String","accountName":"String","customerId":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"customerName":"String","endpointId":"String","endpointName":"String","dateCompleted":"String","destination":"String","toAddress":"String","fromAddress":"String","fromName":"String","answeredByName":"String","queueMemberId":"String","channel":"Voice","ended":false,"outcome":"String","callSid":"String","consoleData":"String","holdQueueName":"String","heldByUserId":"String","holdReason":"None","conferenceSid":"String","displayName":"String","log":[{"date":"String","message":"String"}],"members":[{"identity":"String","endpointId":"String","displayName":"String","isOriginalMember":false,"avatarUrl":"String","applicationData":{"String":"String"},"callState":"None","role":"None","callSid":"String","muted":false}],"callbackNumber":"String","answeredById":"String","direction":"Incoming","fromPhoneNumber":"String","mostRecentParticipantCallSid":"String","wasMissed":false,"ringQueueId":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"totalCount":0,"totalPages":0,"hasMorePages":false}