Evo Voice

HoldSession

Hold the specified session

**Requires Authentication**
Required role:	User

The following routes are available for this service:
POST	/sessions/{sessionId}/hold

**HoldSession** Parameters:
Name	Parameter	Data Type	Required	Description
CallSid	body	string	No	The local call SID
SessionId	path	string	No	The ID of the session to hold
Reason	body	SessionHoldReasons	No	The reason you are holding this call

**SessionHoldReasons** Enum:
None
Transferring

**SessionInfo** Parameters:
Name	Parameter	Data Type	Required	Description
DialState	form	SessionDialState	No	The state of the session
CallState	form	SessionCallState	No	The call state of the session
QueueState	form	SessionQueueStates	No	The queue state of the session
AccountId	form	string	No	The ID of the account associated with the flow
AccountName	form	string	No	The name of the account associated with the session
CustomerId	form	string	No	The ID of the customer this session is associated with
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The customer breadcrumb this session is associated with
CustomerName	form	string	No	The name of the customer this session is associated with
EndpointId	form	string	No	The ID of the endpoint associated with this session
EndpointName	form	string	No	The name of the endpoint associated with this session
DateCompleted	form	string	No	The date the call completed
Destination	form	string	No	The destination of the session (e.g. what was entered into the Dial box)
ToAddress	form	string	No	The to address if any
FromAddress	form	string	No	The from address if any
FromName	form	string	No	The from name if any
AnsweredByName	form	string	No	Answered by name (if any)
QueueMemberId	form	string	No	The ID of the queue member assigned to this call
Channel	form	FlowChannels	No	The flow channel
Ended	form	bool	No	Has the session ended
Outcome	form	string	No	The outcome of the call
CallSid	form	string	No	The twilio Call SID of this session
ConsoleData	form	string	No	Any console data for this session
HoldQueueName	form	string	No	The name of the hold queue for this call
HeldByUserId	form	string	No	The user ID who put this call on hold
HoldReason	form	SessionHoldReasons	No	The reason for the hold
ConferenceSid	form	string	No	The SID of the conference if in a conference call
DisplayName	form	string	No	The display name for this session
Log	form	List<SessionLogInfo>	No	The log entries for this session
Members	form	List<SessionMemberInfo>	No	The members of this session
CallbackNumber	form	string	No	The callback number (typically used for SIP to User calls)
AnsweredById	form	string	No	The ID of the endpoint that answered
Direction	form	SessionDirections	No	Is this session incoming or outgoing?
FromPhoneNumber	form	string	No	The phone number that this session is coming from (used with SMS chats)
MostRecentParticipantCallSid	form	string	No	The Call SID of the most recently added conference participant
WasMissed	form	bool	No	Was this session missed?
RingQueueId	form	string	No	The ring queue that the call is currently in

**EntityInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of the object
DateCreated	form	string	No	The date the object was created
DateLastModified	form	string	No	The date the object was last modified
CreatedBy	form	string	No	The user that created this object
LastModifiedBy	form	string	No	The user that last modified this object

**SessionDialState** Enum:
None
Active

**SessionCallState** Enum:
Disconnected
Ringing
Connected
Hold
Passive

**SessionQueueStates** Enum:
None
Queued
Ringing
Connected
Hold
Disconnected

**CustomerBreadcrumb** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

**FlowChannels** Enum:
Voice
Chat
Fax

**SessionLogInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	string	No
Message	form	string	No

**SessionMemberInfo** Parameters:
Name	Parameter	Data Type	Required
Identity	form	string	No
EndpointId	form	string	No
DisplayName	form	string	No
IsOriginalMember	form	bool	No
AvatarUrl	form	string	No
ApplicationData	form	Dictionary<string, string>	No
CallState	form	SessionMemberCallState	No
Role	form	SessionMemberRoles	No
CallSid	form	string	No
Muted	form	bool	No

**SessionMemberCallState** Enum:
None
Ringing
Connected
Hold

**SessionMemberRoles** Enum:
None
Caller
Agent
Transfer

**SessionDirections** Enum:
Incoming
Outgoing

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/{sessionId}/hold HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HoldSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
  <CallSid>String</CallSid>
  <Reason>None</Reason>
  <SessionId>String</SessionId>
</HoldSession>

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>