| Required role: | User |
| DELETE | /sessions/{sessionId}/members/{memberId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SessionId | path | string | No | The ID of the session |
| MemberToRemove | query | string | No | The member to add. This can be a cell phone number, user ID (email) |
| 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 |
| 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 |
| None | |
| Active |
| Disconnected | |
| Ringing | |
| Connected | |
| Hold | |
| Passive |
| None | |
| Queued | |
| Ringing | |
| Connected | |
| Hold | |
| Disconnected |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No |
| Voice | |
| Chat | |
| Fax |
| None | |
| Transferring |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | string | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| None | |
| Ringing | |
| Connected | |
| Hold |
| None | |
| Caller | |
| Agent | |
| Transfer |
| Incoming | |
| Outgoing |
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.
DELETE /sessions/{sessionId}/members/{memberId} HTTP/1.1
Host: evovoice.io
Accept: text/jsv
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
}