Evo Voice

<back to all web services

NewSession

Create a new session

Requires Authentication
Required role:User
The following routes are available for this service:
POST/sessions
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Sessions;
using Voice.Api.Flows;
using Voice.Api;
using Voice.Api.Customers;

namespace Voice.Api
{
    public partial class EntityInfo
    {
        ///<summary>
        ///The ID of the object
        ///</summary>
        [ApiMember(Description="The ID of the object")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The date the object was created
        ///</summary>
        [ApiMember(Description="The date the object was created")]
        public virtual string DateCreated { get; set; }

        ///<summary>
        ///The date the object was last modified
        ///</summary>
        [ApiMember(Description="The date the object was last modified")]
        public virtual string DateLastModified { get; set; }

        ///<summary>
        ///The user that created this object
        ///</summary>
        [ApiMember(Description="The user that created this object")]
        public virtual string CreatedBy { get; set; }

        ///<summary>
        ///The user that last modified this object
        ///</summary>
        [ApiMember(Description="The user that last modified this object")]
        public virtual string LastModifiedBy { get; set; }
    }

}

namespace Voice.Api.Customers
{
    public partial class CustomerBreadcrumb
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
    }

}

namespace Voice.Api.Flows
{
    public enum FlowChannels
    {
        Voice,
        Chat,
        Fax,
    }

}

namespace Voice.Api.Sessions
{
    ///<summary>
    ///Create a new session
    ///</summary>
    [Api(Description="Create a new session")]
    public partial class NewSession
        : IPost
    {
        public NewSession()
        {
            MemberEmailAddresses = new List<string>{};
        }

        ///<summary>
        ///A display name for this session
        ///</summary>
        [ApiMember(Description="A display name for this session")]
        public virtual string DisplayName { get; set; }

        ///<summary>
        ///The type of session
        ///</summary>
        [ApiMember(Description="The type of session")]
        public virtual FlowChannels Channel { get; set; }

        ///<summary>
        ///The session direction (defaults to Outgoing)
        ///</summary>
        [ApiMember(Description="The session direction (defaults to Outgoing)")]
        public virtual SessionDirections? Direction { get; set; }

        ///<summary>
        ///The current session call state (defaults to Connected)
        ///</summary>
        [ApiMember(Description="The current session call state (defaults to Connected)")]
        public virtual SessionCallState? CallState { get; set; }

        ///<summary>
        ///The From address for the session (defaults to user's email)
        ///</summary>
        [ApiMember(Description="The From address for the session (defaults to user's email)")]
        public virtual string FromAddress { get; set; }

        ///<summary>
        ///The From name for the session
        ///</summary>
        [ApiMember(Description="The From name for the session")]
        public virtual string FromName { get; set; }

        ///<summary>
        ///The To address for the session
        ///</summary>
        [ApiMember(Description="The To address for the session")]
        public virtual string ToAddress { get; set; }

        ///<summary>
        ///Parent session (e.g. for billing purposes)
        ///</summary>
        [ApiMember(Description="Parent session (e.g. for billing purposes)")]
        public virtual string ParentSessionId { get; set; }

        ///<summary>
        ///Specify a customer to associate with this session
        ///</summary>
        [ApiMember(Description="Specify a customer to associate with this session")]
        public virtual string CustomerId { get; set; }

        ///<summary>
        ///Start a chat session with a specified user/team (e.g. user:userid or team:teamid)
        ///</summary>
        [ApiMember(Description="Start a chat session with a specified user/team (e.g. user:userid or team:teamid)")]
        public virtual string WithAddress { get; set; }

        ///<summary>
        ///Use the specified caller ID (if dialing out)
        ///</summary>
        [ApiMember(Description="Use the specified caller ID (if dialing out)")]
        public virtual string FromPhoneNumber { get; set; }

        ///<summary>
        ///The dialed destination value
        ///</summary>
        [ApiMember(Description="The dialed destination value")]
        public virtual string Destination { get; set; }

        ///<summary>
        ///User email addresses to add as members
        ///</summary>
        [ApiMember(Description="User email addresses to add as members")]
        public virtual List<string> MemberEmailAddresses { get; set; }

        ///<summary>
        ///Start the session's flow?
        ///</summary>
        [ApiMember(Description="Start the session's flow?")]
        public virtual bool StartSession { get; set; }
    }

    public enum SessionCallState
    {
        Disconnected,
        Ringing,
        Connected,
        Hold,
        Passive,
    }

    public enum SessionDialState
    {
        None,
        Active,
    }

    public enum SessionDirections
    {
        Incoming,
        Outgoing,
    }

    public enum SessionHoldReasons
    {
        None,
        Transferring,
    }

    public partial class SessionInfo
        : EntityInfo
    {
        public SessionInfo()
        {
            CustomerBreadcrumb = new List<CustomerBreadcrumb>{};
            Log = new List<SessionLogInfo>{};
            Members = new List<SessionMemberInfo>{};
        }

        ///<summary>
        ///The state of the session
        ///</summary>
        [ApiMember(Description="The state of the session")]
        public virtual SessionDialState DialState { get; set; }

        ///<summary>
        ///The call state of the session
        ///</summary>
        [ApiMember(Description="The call state of the session")]
        public virtual SessionCallState CallState { get; set; }

        ///<summary>
        ///The queue state of the session
        ///</summary>
        [ApiMember(Description="The queue state of the session")]
        public virtual SessionQueueStates QueueState { get; set; }

        ///<summary>
        ///The ID of the account associated with the flow
        ///</summary>
        [ApiMember(Description="The ID of the account associated with the flow")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The name of the account associated with the session
        ///</summary>
        [ApiMember(Description="The name of the account associated with the session")]
        public virtual string AccountName { get; set; }

        ///<summary>
        ///The ID of the customer this session is associated with
        ///</summary>
        [ApiMember(Description="The ID of the customer this session is associated with")]
        public virtual string CustomerId { get; set; }

        ///<summary>
        ///The customer breadcrumb this session is associated with
        ///</summary>
        [ApiMember(Description="The customer breadcrumb this session is associated with")]
        public virtual List<CustomerBreadcrumb> CustomerBreadcrumb { get; set; }

        ///<summary>
        ///The name of the customer this session is associated with
        ///</summary>
        [ApiMember(Description="The name of the customer this session is associated with")]
        public virtual string CustomerName { get; set; }

        ///<summary>
        ///The ID of the endpoint associated with this session
        ///</summary>
        [ApiMember(Description="The ID of the endpoint associated with this session")]
        public virtual string EndpointId { get; set; }

        ///<summary>
        ///The name of the endpoint associated with this session
        ///</summary>
        [ApiMember(Description="The name of the endpoint associated with this session")]
        public virtual string EndpointName { get; set; }

        ///<summary>
        ///The date the call completed
        ///</summary>
        [ApiMember(Description="The date the call completed")]
        public virtual string DateCompleted { get; set; }

        ///<summary>
        ///The destination of the session (e.g. what was entered into the Dial box)
        ///</summary>
        [ApiMember(Description="The destination of the session (e.g. what was entered into the Dial box)")]
        public virtual string Destination { get; set; }

        ///<summary>
        ///The to address if any
        ///</summary>
        [ApiMember(Description="The to address if any")]
        public virtual string ToAddress { get; set; }

        ///<summary>
        ///The from address if any
        ///</summary>
        [ApiMember(Description="The from address if any")]
        public virtual string FromAddress { get; set; }

        ///<summary>
        ///The from name if any
        ///</summary>
        [ApiMember(Description="The from name if any")]
        public virtual string FromName { get; set; }

        ///<summary>
        ///Answered by name (if any)
        ///</summary>
        [ApiMember(Description="Answered by name (if any)")]
        public virtual string AnsweredByName { get; set; }

        ///<summary>
        ///The ID of the queue member assigned to this call
        ///</summary>
        [ApiMember(Description="The ID of the queue member assigned to this call")]
        public virtual string QueueMemberId { get; set; }

        ///<summary>
        ///The flow channel
        ///</summary>
        [ApiMember(Description="The flow channel")]
        public virtual FlowChannels Channel { get; set; }

        ///<summary>
        ///Has the session ended
        ///</summary>
        [ApiMember(Description="Has the session ended")]
        public virtual bool Ended { get; set; }

        ///<summary>
        ///The outcome of the call
        ///</summary>
        [ApiMember(Description="The outcome of the call")]
        public virtual string Outcome { get; set; }

        ///<summary>
        ///The twilio Call SID of this session
        ///</summary>
        [ApiMember(Description="The twilio Call SID of this session")]
        public virtual string CallSid { get; set; }

        ///<summary>
        ///Any console data for this session
        ///</summary>
        [ApiMember(Description="Any console data for this session")]
        public virtual string ConsoleData { get; set; }

        ///<summary>
        ///The name of the hold queue for this call
        ///</summary>
        [ApiMember(Description="The name of the hold queue for this call")]
        public virtual string HoldQueueName { get; set; }

        ///<summary>
        ///The user ID who put this call on hold
        ///</summary>
        [ApiMember(Description="The user ID who put this call on hold")]
        public virtual string HeldByUserId { get; set; }

        ///<summary>
        ///The reason for the hold
        ///</summary>
        [ApiMember(Description="The reason for the hold")]
        public virtual SessionHoldReasons HoldReason { get; set; }

        ///<summary>
        ///The SID of the conference if in a conference call
        ///</summary>
        [ApiMember(Description="The SID of the conference if in a conference call")]
        public virtual string ConferenceSid { get; set; }

        ///<summary>
        ///The display name for this session
        ///</summary>
        [ApiMember(Description="The display name for this session")]
        public virtual string DisplayName { get; set; }

        ///<summary>
        ///The log entries for this session
        ///</summary>
        [ApiMember(Description="The log entries for this session")]
        public virtual List<SessionLogInfo> Log { get; set; }

        ///<summary>
        ///The members of this session
        ///</summary>
        [ApiMember(Description="The members of this session")]
        public virtual List<SessionMemberInfo> Members { get; set; }

        ///<summary>
        ///The callback number (typically used for SIP to User calls)
        ///</summary>
        [ApiMember(Description="The callback number (typically used for SIP to User calls)")]
        public virtual string CallbackNumber { get; set; }

        ///<summary>
        ///The ID of the endpoint that answered
        ///</summary>
        [ApiMember(Description="The ID of the endpoint that answered")]
        public virtual string AnsweredById { get; set; }

        ///<summary>
        ///Is this session incoming or outgoing?
        ///</summary>
        [ApiMember(Description="Is this session incoming or outgoing?")]
        public virtual SessionDirections Direction { get; set; }

        ///<summary>
        ///The phone number that this session is coming from (used with SMS chats)
        ///</summary>
        [ApiMember(Description="The phone number that this session is coming from (used with SMS chats)")]
        public virtual string FromPhoneNumber { get; set; }

        ///<summary>
        ///The Call SID of the most recently added conference participant
        ///</summary>
        [ApiMember(Description="The Call SID of the most recently added conference participant")]
        public virtual string MostRecentParticipantCallSid { get; set; }

        ///<summary>
        ///Was this session missed?
        ///</summary>
        [ApiMember(Description="Was this session missed?")]
        public virtual bool WasMissed { get; set; }

        ///<summary>
        ///The ring queue that the call is currently in
        ///</summary>
        [ApiMember(Description="The ring queue that the call is currently in")]
        public virtual string RingQueueId { get; set; }
    }

    public partial class SessionLogInfo
    {
        public virtual string Date { get; set; }
        public virtual string Message { get; set; }
    }

    public enum SessionMemberCallState
    {
        None,
        Ringing,
        Connected,
        Hold,
    }

    public partial class SessionMemberInfo
    {
        public SessionMemberInfo()
        {
            ApplicationData = new Dictionary<string, string>{};
        }

        public virtual string Identity { get; set; }
        public virtual string EndpointId { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual bool IsOriginalMember { get; set; }
        public virtual string AvatarUrl { get; set; }
        public virtual Dictionary<string, string> ApplicationData { get; set; }
        public virtual SessionMemberCallState CallState { get; set; }
        public virtual SessionMemberRoles Role { get; set; }
        public virtual string CallSid { get; set; }
        public virtual bool Muted { get; set; }
    }

    public enum SessionMemberRoles
    {
        None,
        Caller,
        Agent,
        Transfer,
    }

    public enum SessionQueueStates
    {
        None,
        Queued,
        Ringing,
        Connected,
        Hold,
        Disconnected,
    }

}

C# NewSession DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<NewSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
  <CallState>Disconnected</CallState>
  <Channel>Voice</Channel>
  <CustomerId>String</CustomerId>
  <Destination>String</Destination>
  <Direction>Incoming</Direction>
  <DisplayName>String</DisplayName>
  <FromAddress>String</FromAddress>
  <FromName>String</FromName>
  <FromPhoneNumber>String</FromPhoneNumber>
  <MemberEmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </MemberEmailAddresses>
  <ParentSessionId>String</ParentSessionId>
  <StartSession>false</StartSession>
  <ToAddress>String</ToAddress>
  <WithAddress>String</WithAddress>
</NewSession>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SessionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AccountId>String</AccountId>
  <AccountName>String</AccountName>
  <AnsweredById>String</AnsweredById>
  <AnsweredByName>String</AnsweredByName>
  <CallSid>String</CallSid>
  <CallState>Disconnected</CallState>
  <CallbackNumber>String</CallbackNumber>
  <Channel>Voice</Channel>
  <ConferenceSid>String</ConferenceSid>
  <ConsoleData>String</ConsoleData>
  <CustomerBreadcrumb xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
    <d2p1:CustomerBreadcrumb>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:CustomerBreadcrumb>
  </CustomerBreadcrumb>
  <CustomerId>String</CustomerId>
  <CustomerName>String</CustomerName>
  <DateCompleted>String</DateCompleted>
  <Destination>String</Destination>
  <DialState>None</DialState>
  <Direction>Incoming</Direction>
  <DisplayName>String</DisplayName>
  <Ended>false</Ended>
  <EndpointId>String</EndpointId>
  <EndpointName>String</EndpointName>
  <FromAddress>String</FromAddress>
  <FromName>String</FromName>
  <FromPhoneNumber>String</FromPhoneNumber>
  <HeldByUserId>String</HeldByUserId>
  <HoldQueueName>String</HoldQueueName>
  <HoldReason>None</HoldReason>
  <Log>
    <SessionLogInfo>
      <Date>String</Date>
      <Message>String</Message>
    </SessionLogInfo>
  </Log>
  <Members>
    <SessionMemberInfo>
      <ApplicationData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </ApplicationData>
      <AvatarUrl>String</AvatarUrl>
      <CallSid>String</CallSid>
      <CallState>None</CallState>
      <DisplayName>String</DisplayName>
      <EndpointId>String</EndpointId>
      <Identity>String</Identity>
      <IsOriginalMember>false</IsOriginalMember>
      <Muted>false</Muted>
      <Role>None</Role>
    </SessionMemberInfo>
  </Members>
  <MostRecentParticipantCallSid>String</MostRecentParticipantCallSid>
  <Outcome>String</Outcome>
  <QueueMemberId>String</QueueMemberId>
  <QueueState>None</QueueState>
  <RingQueueId>String</RingQueueId>
  <ToAddress>String</ToAddress>
  <WasMissed>false</WasMissed>
</SessionInfo>