Required role: | User |
POST | /sessions |
---|
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 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); }
}
/**
* Create a new session
*/
// @Api(Description="Create a new session")
export class NewSession implements IPost
{
/**
* A display name for this session
*/
// @ApiMember(Description="A display name for this session")
public displayName?: string;
/**
* The type of session
*/
// @ApiMember(Description="The type of session")
public channel?: FlowChannels;
/**
* The session direction (defaults to Outgoing)
*/
// @ApiMember(Description="The session direction (defaults to Outgoing)")
public direction?: SessionDirections;
/**
* The current session call state (defaults to Connected)
*/
// @ApiMember(Description="The current session call state (defaults to Connected)")
public callState?: SessionCallState;
/**
* The From address for the session (defaults to user's email)
*/
// @ApiMember(Description="The From address for the session (defaults to user's email)")
public fromAddress?: string;
/**
* The From name for the session
*/
// @ApiMember(Description="The From name for the session")
public fromName?: string;
/**
* The To address for the session
*/
// @ApiMember(Description="The To address for the session")
public toAddress?: string;
/**
* Parent session (e.g. for billing purposes)
*/
// @ApiMember(Description="Parent session (e.g. for billing purposes)")
public parentSessionId?: string;
/**
* Specify a customer to associate with this session
*/
// @ApiMember(Description="Specify a customer to associate with this session")
public customerId?: string;
/**
* Start a chat session with a specified user/team (e.g. user:userid or team:teamid)
*/
// @ApiMember(Description="Start a chat session with a specified user/team (e.g. user:userid or team:teamid)")
public withAddress?: string;
/**
* Use the specified caller ID (if dialing out)
*/
// @ApiMember(Description="Use the specified caller ID (if dialing out)")
public fromPhoneNumber?: string;
/**
* The dialed destination value
*/
// @ApiMember(Description="The dialed destination value")
public destination?: string;
/**
* User email addresses to add as members
*/
// @ApiMember(Description="User email addresses to add as members")
public memberEmailAddresses?: string[];
/**
* Start the session's flow?
*/
// @ApiMember(Description="Start the session's flow?")
public startSession?: boolean;
public constructor(init?: Partial<NewSession>) { (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.
POST /sessions HTTP/1.1
Host: evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
displayName: String,
channel: Voice,
direction: Incoming,
callState: Disconnected,
fromAddress: String,
fromName: String,
toAddress: String,
parentSessionId: String,
customerId: String,
withAddress: String,
fromPhoneNumber: String,
destination: String,
memberEmailAddresses:
[
String
],
startSession: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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 }