Required role: | User |
POST | /sessions |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* Create a new session
*/
@Api(Description="Create a new session")
open class NewSession : IPost
{
/**
* A display name for this session
*/
@ApiMember(Description="A display name for this session")
var displayName:String? = null
/**
* The type of session
*/
@ApiMember(Description="The type of session")
var channel:FlowChannels? = null
/**
* The session direction (defaults to Outgoing)
*/
@ApiMember(Description="The session direction (defaults to Outgoing)")
var direction:SessionDirections? = null
/**
* The current session call state (defaults to Connected)
*/
@ApiMember(Description="The current session call state (defaults to Connected)")
var callState:SessionCallState? = null
/**
* The From address for the session (defaults to user's email)
*/
@ApiMember(Description="The From address for the session (defaults to user's email)")
var fromAddress:String? = null
/**
* The From name for the session
*/
@ApiMember(Description="The From name for the session")
var fromName:String? = null
/**
* The To address for the session
*/
@ApiMember(Description="The To address for the session")
var toAddress:String? = null
/**
* Parent session (e.g. for billing purposes)
*/
@ApiMember(Description="Parent session (e.g. for billing purposes)")
var parentSessionId:String? = null
/**
* Specify a customer to associate with this session
*/
@ApiMember(Description="Specify a customer to associate with this session")
var customerId:String? = null
/**
* 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)")
var withAddress:String? = null
/**
* Use the specified caller ID (if dialing out)
*/
@ApiMember(Description="Use the specified caller ID (if dialing out)")
var fromPhoneNumber:String? = null
/**
* The dialed destination value
*/
@ApiMember(Description="The dialed destination value")
var destination:String? = null
/**
* User email addresses to add as members
*/
@ApiMember(Description="User email addresses to add as members")
var memberEmailAddresses:ArrayList<String> = ArrayList<String>()
/**
* Start the session's flow?
*/
@ApiMember(Description="Start the session's flow?")
var startSession:Boolean? = null
}
enum class FlowChannels
{
Voice,
Chat,
Fax,
}
enum class SessionDirections
{
Incoming,
Outgoing,
}
enum class SessionCallState
{
Disconnected,
Ringing,
Connected,
Hold,
Passive,
}
open class SessionInfo : EntityInfo()
{
/**
* The state of the session
*/
@ApiMember(Description="The state of the session")
var dialState:SessionDialState? = null
/**
* The call state of the session
*/
@ApiMember(Description="The call state of the session")
var callState:SessionCallState? = null
/**
* The queue state of the session
*/
@ApiMember(Description="The queue state of the session")
var queueState:SessionQueueStates? = null
/**
* The ID of the account associated with the flow
*/
@ApiMember(Description="The ID of the account associated with the flow")
var accountId:String? = null
/**
* The name of the account associated with the session
*/
@ApiMember(Description="The name of the account associated with the session")
var accountName:String? = null
/**
* The ID of the customer this session is associated with
*/
@ApiMember(Description="The ID of the customer this session is associated with")
var customerId:String? = null
/**
* The customer breadcrumb this session is associated with
*/
@ApiMember(Description="The customer breadcrumb this session is associated with")
var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()
/**
* The name of the customer this session is associated with
*/
@ApiMember(Description="The name of the customer this session is associated with")
var customerName:String? = null
/**
* The ID of the endpoint associated with this session
*/
@ApiMember(Description="The ID of the endpoint associated with this session")
var endpointId:String? = null
/**
* The name of the endpoint associated with this session
*/
@ApiMember(Description="The name of the endpoint associated with this session")
var endpointName:String? = null
/**
* The date the call completed
*/
@ApiMember(Description="The date the call completed")
var dateCompleted:String? = null
/**
* 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)")
var destination:String? = null
/**
* The to address if any
*/
@ApiMember(Description="The to address if any")
var toAddress:String? = null
/**
* The from address if any
*/
@ApiMember(Description="The from address if any")
var fromAddress:String? = null
/**
* The from name if any
*/
@ApiMember(Description="The from name if any")
var fromName:String? = null
/**
* Answered by name (if any)
*/
@ApiMember(Description="Answered by name (if any)")
var answeredByName:String? = null
/**
* The ID of the queue member assigned to this call
*/
@ApiMember(Description="The ID of the queue member assigned to this call")
var queueMemberId:String? = null
/**
* The flow channel
*/
@ApiMember(Description="The flow channel")
var channel:FlowChannels? = null
/**
* Has the session ended
*/
@ApiMember(Description="Has the session ended")
var ended:Boolean? = null
/**
* The outcome of the call
*/
@ApiMember(Description="The outcome of the call")
var outcome:String? = null
/**
* The twilio Call SID of this session
*/
@ApiMember(Description="The twilio Call SID of this session")
var callSid:String? = null
/**
* Any console data for this session
*/
@ApiMember(Description="Any console data for this session")
var consoleData:String? = null
/**
* The name of the hold queue for this call
*/
@ApiMember(Description="The name of the hold queue for this call")
var holdQueueName:String? = null
/**
* The user ID who put this call on hold
*/
@ApiMember(Description="The user ID who put this call on hold")
var heldByUserId:String? = null
/**
* The reason for the hold
*/
@ApiMember(Description="The reason for the hold")
var holdReason:SessionHoldReasons? = null
/**
* The SID of the conference if in a conference call
*/
@ApiMember(Description="The SID of the conference if in a conference call")
var conferenceSid:String? = null
/**
* The display name for this session
*/
@ApiMember(Description="The display name for this session")
var displayName:String? = null
/**
* The log entries for this session
*/
@ApiMember(Description="The log entries for this session")
var log:ArrayList<SessionLogInfo> = ArrayList<SessionLogInfo>()
/**
* The members of this session
*/
@ApiMember(Description="The members of this session")
var members:ArrayList<SessionMemberInfo> = ArrayList<SessionMemberInfo>()
/**
* The callback number (typically used for SIP to User calls)
*/
@ApiMember(Description="The callback number (typically used for SIP to User calls)")
var callbackNumber:String? = null
/**
* The ID of the endpoint that answered
*/
@ApiMember(Description="The ID of the endpoint that answered")
var answeredById:String? = null
/**
* Is this session incoming or outgoing?
*/
@ApiMember(Description="Is this session incoming or outgoing?")
var direction:SessionDirections? = null
/**
* 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)")
var fromPhoneNumber:String? = null
/**
* The Call SID of the most recently added conference participant
*/
@ApiMember(Description="The Call SID of the most recently added conference participant")
var mostRecentParticipantCallSid:String? = null
/**
* Was this session missed?
*/
@ApiMember(Description="Was this session missed?")
var wasMissed:Boolean? = null
/**
* The ring queue that the call is currently in
*/
@ApiMember(Description="The ring queue that the call is currently in")
var ringQueueId:String? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
var lastModifiedBy:String? = null
}
enum class SessionDialState
{
None,
Active,
}
enum class SessionQueueStates
{
None,
Queued,
Ringing,
Connected,
Hold,
Disconnected,
}
open class CustomerBreadcrumb
{
var id:String? = null
var name:String? = null
}
enum class SessionHoldReasons
{
None,
Transferring,
}
open class SessionLogInfo
{
var date:String? = null
var message:String? = null
}
open class SessionMemberInfo
{
var identity:String? = null
var endpointId:String? = null
var displayName:String? = null
var isOriginalMember:Boolean? = null
var avatarUrl:String? = null
var applicationData:HashMap<String,String> = HashMap<String,String>()
var callState:SessionMemberCallState? = null
var role:SessionMemberRoles? = null
var callSid:String? = null
var muted:Boolean? = null
}
enum class SessionMemberCallState
{
None,
Ringing,
Connected,
Hold,
}
enum class SessionMemberRoles
{
None,
Caller,
Agent,
Transfer,
}
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 }