Jump to: navigation, search

RemoveParticipantFromConference

This operation is part of the SMS Session API section of the Web Services API.

Overview

This allows an agent to remove another agent from a conference or consultation.

Only an agent who is visible to all can do this.

Request URL /api/v2/me/smssessions/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName RemoveParticipantFromConference
targetUri user uri to remove

Sample

Request

POST api/v2/me/smssessions/00010a9FSGFP001F
{
  "operationName": "RemoveParticipantFromConference",
  "targetUri": "http://10.10.15.212:9090/api/v2/users/c30d06daa1ea43b8be79f9b071f30d70"
}

Response

{
  "statusCode": 0
}

Notification

Successful

Agent1 First Notification 

{
    'messages': [
        {
            'index': 6,
            'from': {
                'nickname': 'test_consult',
                'type': 'Agent',
                'uri': 'http: //10.10.15.212:9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
            },
            'text': 'REMOVE_PARTICIPANT_FROM_CONFERENCEc30d06daa1ea43b8be79f9b071f30d70',
            'visibility': 'Agents',
            'timestamp': '2014-02-1308:20:59.000-0800',
            'type': 'Notice',
            'timestampSeconds': 1392308459000L
        }
    ],
    'notificationType': 'NewMessages',
    'messageType': 'MessageLogUpdated',
    'smssessionUri': 'http: //10.10.15.212:9090/api/v2/smssessions/00010a9FSGFP001F'
}

Agent1 Second Notification 

{
    'smssession': {
        'userData': {
            'IdentifyCreateContact': '3',
            'FirstName': 'test_consult_client',
            'LastName': 'Lastname',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
            'RVQID': '',
            'ChatServerAppName': 'ChatServer',
            'PegAGChatdistributionforprocessing': 1,
            'ChatServerHost': 'htcc-gf81',
            'RTargetObjSelDBID': '157',
            'CBR-IT-path_DBIDs': '',
            'ChatServerPort': '7030',
            'CBR-Interaction_cost': '',
            'CBR-contract_DBIDs': '',
            'ContactId': '00010a9FSGFP000M',
            'RTargetAgentSelected': 'htcc1',
            'RTargetTypeSelected': '2',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
            'RTargetRuleSelected': '',
            'RTargetPlaceSelected': 'htcc1',
            'CBR-actual_volume': '',
            'RTenant': 'Environment',
            'ChatServerDBID': '175',
            'RRequestedSkills': None,
            'ChatServerModeHA': 'true',
            'RRequestedSkillCombination': '',
            'RVQDBID': '',
            'RStrategyDBID': '894',
            'CustomerSegment': 'default',
            'ServiceType': 'default',
            'ServiceObjective': 0,
            'RTargetRequested': 'Chatdistributionforprocessing',
            'EmailAddress': 'Email@abc.com',
            'RStrategyName': 'Chatinboundstrategy',
            'Subject': 'Customersupport'
        },
        'state': 'Chatting',
        'capabilities': [
            'Transfer',
            'Leave',
            'Invite',
            'Consult',
            'SetInFocus',
            'SetDisposition',
            'AttachUserData',
            'DeleteUserData',
            'UpdateUserData',
            'Complete',
            'SendMessage',
            'SendStartTypingNotification',
            'SendStopTypingNotification'
        ],
        'uri': 'http: //10.10.15.212:9090/api/v2/smssessions/00010a9FSGFP001F',
        'participants': [
            {
                'nickname': 'test_consult',
                'type': 'Agent',
                'uri': 'http: //10.10.15.212:9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
            },
            {
                'nickname': 'test_consult_clientL',
                'type': 'Customer',
                'participantId': '00AF52FCF09E002D',
                'visibility': 'All'
            }
        ],
        'id': '00010a9FSGFP001F'
    },
    'notificationType': 'ParticipantsUpdated',
    'messageType': 'SMSsessionStateChangeMessage'
}

Agent1 Third Notification 

{
    'messages': [
        {
            'index': 7,
            'from': {
                'nickname': 'chat_consult',
                'type': 'Agent',
                'uri': 'http://10.10.15.212:9090/api/v2/users/c30d06daa1ea43b8be79f9b071f30d70',
                'visibility': 'All',
                'participantId': '00AF52FCF0C10030'
            },
            'timestamp': '2014-02-1308: 20: 59.000-0800',
            'visibility': 'All',
            'type': 'ParticipantLeft',
            'timestampSeconds': 1392308459000L
        }
    ],
    'notificationType': 'NewMessages',
    'messageType': 'MessageLogUpdated',
    'smssessionUri': 'http://10.10.15.212:9090/api/v2/smssessions/00010a9FSGFP001F'
}

Agent2 First Notification 

{
    'smssession': {
        'userData': {
            'IdentifyCreateContact': '3',
            'FirstName': 'test_consult_client',
            'LastName': 'Lastname',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
            'RVQID': '',
            'ChatServerAppName': 'ChatServer',
            'PegAGChatdistributionforprocessing': 1,
            'ChatServerHost': 'htcc-gf81',
            'RTargetObjSelDBID': '157',
            'CBR-IT-path_DBIDs': '',
            'ChatServerPort': '7030',
            'CBR-Interaction_cost': '',
            'CBR-contract_DBIDs': '',
            'ContactId': '00010a9FSGFP000M',
            'RTargetAgentSelected': 'htcc1',
            'RTargetTypeSelected': '2',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
            'RTargetRuleSelected': '',
            'RTargetPlaceSelected': 'htcc1',
            'CBR-actual_volume': '',
            'RTenant': 'Environment',
            'ChatServerDBID': '175',
            'RRequestedSkills': None,
            'ChatServerModeHA': 'true',
            'RRequestedSkillCombination': '',
            'RVQDBID': '',
            'RStrategyDBID': '894',
            'CustomerSegment': 'default',
            'ServiceType': 'default',
            'ServiceObjective': 0,
            'RTargetRequested': 'Chatdistributionforprocessing',
            'EmailAddress': 'Email@abc.com',
            'RStrategyName': 'Chatinboundstrategy',
            'Subject': 'Customersupport'
        },
        'state': 'LeftChat',
        'capabilities': [
            'SetInFocus',
            'Complete',
            'SetDisposition',
            'AttachUserData',
            'DeleteUserData',
            'UpdateUserData'
        ],
        'uri': 'http: //10.10.15.212: 9090/api/v2/smssessions/00010a9FSGFP001F',
        'participants': [
            {
                'nickname': 'test_consult',
                'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
            },
            {
                'nickname': 'test_consult_clientL',
                'type': 'Customer',
                'participantId': '00AF52FCF09E002D',
                'visibility': 'All'
            }
        ],
        'id': '00010a9FSGFP001F'
    },
    'notificationType': 'ParticipantsUpdated',
    'messageType': 'SMSsessionStateChangeMessage'
}

Agent2 Second Notification 

{
    'messages': [
        {
            'index': 7,
            'from': {
                'nickname': 'chat_consult',
                'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/c30d06daa1ea43b8be79f9b071f30d70',
                'visibility': 'All',
                'participantId': '00AF52FCF0C10030'
            },
            'timestamp': '2014-02-1308: 20: 59.000-0800',
            'visibility': 'All',
            'type': 'ParticipantLeft',
            'timestampSeconds': 1392308459000L
        }
    ],
    'notificationType': 'NewMessages',
    'messageType': 'MessageLogUpdated',
    'smssessionUri': 'http: //10.10.15.212: 9090/api/v2/smssessions/00010a9FSGFP001F'
}

Agent2 Third Notification 

{
    'smssession': {
        'userData': {
            'IdentifyCreateContact': '3',
            'FirstName': 'test_consult_client',
            'LastName': 'Lastname',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
            'RVQID': '',
            'ChatServerAppName': 'ChatServer',
            'PegAGChatdistributionforprocessing': 1,
            'ChatServerHost': 'htcc-gf81',
            'RTargetObjSelDBID': '157',
            'CBR-IT-path_DBIDs': '',
            'ChatServerPort': '7030',
            'CBR-Interaction_cost': '',
            'CBR-contract_DBIDs': '',
            'ContactId': '00010a9FSGFP000M',
            'RTargetAgentSelected': 'htcc1',
            'RTargetTypeSelected': '2',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
            'RTargetRuleSelected': '',
            'RTargetPlaceSelected': 'htcc1',
            'CBR-actual_volume': '',
            'RTenant': 'Environment',
            'ChatServerDBID': '175',
            'RRequestedSkills': None,
            'ChatServerModeHA': 'true',
            'RRequestedSkillCombination': '',
            'RVQDBID': '',
            'RStrategyDBID': '894',
            'CustomerSegment': 'default',
            'ServiceType': 'default',
            'ServiceObjective': 0,
            'RTargetRequested': 'Chatdistributionforprocessing',
            'EmailAddress': 'Email@abc.com',
            'RStrategyName': 'Chatinboundstrategy',
            'Subject': 'Customersupport'
        },
        'state': 'LeftChat',
        'capabilities': [
            'SetInFocus',
            'Complete',
            'SetDisposition',
            'AttachUserData',
            'DeleteUserData',
            'UpdateUserData'
        ],
        'uri': 'http: //10.10.15.212: 9090/api/v2/smssessions/00010a9FSGFP001F',
        'participants': [
            {
                'nickname': 'test_consult',
                'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
            },
            {
                'nickname': 'test_consult_clientL',
                'type': 'Customer',
                'participantId': '00AF52FCF09E002D',
                'visibility': 'All'
            }
        ],
        'id': '00010a9FSGFP001F'
    },
    'notificationType': 'StatusChange',
    'messageType': 'SMSsessionStateChangeMessage'
}

Agent2 Fourth Notification 

{
    'referenceId': 20,
    'smssession': {
        'userData': {
            'IdentifyCreateContact': '3',
            'FirstName': 'test_consult_client',
            'LastName': 'Lastname',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
            'RVQID': '',
            'ChatServerAppName': 'ChatServer',
            'PegAGChatdistributionforprocessing': 1,
            'ChatServerHost': 'htcc-gf81',
            'RTargetObjSelDBID': '157',
            'CBR-IT-path_DBIDs': '',
            'ChatServerPort': '7030',
            'CBR-Interaction_cost': '',
            'CBR-contract_DBIDs': '',
            'ContactId': '00010a9FSGFP000M',
            'RTargetAgentSelected': 'htcc1',
            'RTargetTypeSelected': '2',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
            'RTargetRuleSelected': '',
            'RTargetPlaceSelected': 'htcc1',
            'CBR-actual_volume': '',
            'RTenant': 'Environment',
            'ChatServerDBID': '175',
            'RRequestedSkills': None,
            'ChatServerModeHA': 'true',
            'RRequestedSkillCombination': '',
            'RVQDBID': '',
            'RStrategyDBID': '894',
            'CustomerSegment': 'default',
            'ServiceType': 'default',
            'ServiceObjective': 0,
            'RTargetRequested': 'Chatdistributionforprocessing',
            'EmailAddress': 'Email@abc.com',
            'RStrategyName': 'Chatinboundstrategy',
            'Subject': 'Customersupport'
        },
        'state': 'Completed',
        'capabilities': [
 
        ],
        'uri': 'http: //10.10.15.212: 9090/api/v2/smssessions/00010a9FSGFP001F',
        'participants': [
            {
                'nickname': 'test_consult',
                'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
            },
            {
                'nickname': 'test_consult_clientL',
                'type': 'Customer',
                'participantId': '00AF52FCF09E002D',
                'visibility': 'All'
            }
        ],
        'id': '00010a9FSGFP001F'
    },
    'notificationType': 'StatusChange',
    'messageType': 'SMSsessionStateChangeMessage'
}
This page was last edited on November 4, 2016, at 17:54.
Comments or questions about this documentation? Contact us for support!