Jump to: navigation, search
(HTCC-28189)
Line 25: Line 25:
 
| RemoveParticipantFromConference
 
| RemoveParticipantFromConference
 
|-
 
|-
| userUri
+
|targetUri
| user uri to remove
+
| User URI to remove. Mandatory, if '''targetPath''' is not specified.
 +
|-
 +
|targetPath
 +
| User path to remove. Mandatory, if '''targetUri''' is not specified.
 +
|-
 +
|text
 +
| Optional. Text to send to customer.
 +
|-
 +
|messageType
 +
| Optional, must be provided together with '''text''' parameter. Defines the message type. Default value: '''Text'''
 +
|-
 +
|treatAs
 +
| Optional, must be provided together with '''text''' parameter. Specifies how message should be treated: '''Normal''' or '''System'''. Default value: '''Normal'''
 +
|-
 
|}
 
|}
 
 
== Sample ==
 
== Sample ==
 
===Request===
 
===Request===
Line 48: Line 60:
 
'''Agent1 First Notification'''
 
'''Agent1 First Notification'''
 
<pre>
 
<pre>
{
+
  {
    'messages': [
+
      'chat': {
        {
+
          'userData': {
            'index': 6,
+
              'IdentifyCreateContact': '3',
            'from': {
+
              'FirstName': 'test_consult_client',
                'nickname': 'test_consult',
+
              'LastName': 'Lastname',
                'type': 'Agent',
+
              'RTargetObjectSelected': 'Chatdistributionforprocessing',
                'uri': 'http: //10.10.15.212:9090/api/v2/users/914165a5841348aa94ccfccd56917443',
+
              'RVQID': '',
                'visibility': 'All',
+
              'ChatServerAppName': 'ChatServer',
                'participantId': '00AF52FCF0C0002F'
+
              'PegAGChatdistributionforprocessing': 1,
            },
+
              'ChatServerHost': 'htcc-gf81',
            'text': 'REMOVE_PARTICIPANT_FROM_CONFERENCEc30d06daa1ea43b8be79f9b071f30d70',
+
              'RTargetObjSelDBID': '157',
            'visibility': 'Agents',
+
              'CBR-IT-path_DBIDs': '',
            'timestamp': '2014-02-1308:20:59.000-0800',
+
              'ChatServerPort': '7030',
            'type': 'Notice',
+
              'CBR-Interaction_cost': '',
            'timestampSeconds': 1392308459000L
+
              'CBR-contract_DBIDs': '',
        }
+
              'ContactId': '00010a9FSGFP000M',
    ],
+
              'RTargetAgentSelected': 'htcc1',
    'notificationType': 'NewMessages',
+
              'RTargetTypeSelected': '2',
    'messageType': 'MessageLogUpdated',
+
              'RTargetAgentGroup': 'Chatdistributionforprocessing',
    'chatUri': 'http: //10.10.15.212:9090/api/v2/chats/00010a9FSGFP001F'
+
              '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/chats/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': 'ChatStateChangeMessage'
 +
  }
 
</pre>
 
</pre>
 
'''Agent1 Second Notification'''
 
'''Agent1 Second Notification'''
 
<pre>
 
<pre>
{
+
  {
    'chat': {
+
      'messages': [
        'userData': {
+
          {
            'IdentifyCreateContact': '3',
+
              'index': 7,
            'FirstName': 'test_consult_client',
+
              'from': {
            'LastName': 'Lastname',
+
                  'nickname': 'chat_consult',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
+
                  'type': 'Agent',
            'RVQID': '',
+
                  'uri': 'http://10.10.15.212:9090/api/v2/users/c30d06daa1ea43b8be79f9b071f30d70',
            'ChatServerAppName': 'ChatServer',
+
                  'visibility': 'All',
            'PegAGChatdistributionforprocessing': 1,
+
                  'participantId': '00AF52FCF0C10030'
            'ChatServerHost': 'htcc-gf81',
+
              },
            'RTargetObjSelDBID': '157',
+
              'timestamp': '2014-02-1308: 20: 59.000-0800',
            'CBR-IT-path_DBIDs': '',
+
              'visibility': 'All',
            'ChatServerPort': '7030',
+
              'type': 'ParticipantLeft',
            'CBR-Interaction_cost': '',
+
              'timestampSeconds': 1392308459000L
            'CBR-contract_DBIDs': '',
+
          }
            'ContactId': '00010a9FSGFP000M',
+
      ],
            'RTargetAgentSelected': 'htcc1',
+
      'notificationType': 'NewMessages',
            'RTargetTypeSelected': '2',
+
      'messageType': 'MessageLogUpdated',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
+
      'chatUri': 'http://10.10.15.212:9090/api/v2/chats/00010a9FSGFP001F'
            '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/chats/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': 'ChatStateChangeMessage'
 
}
 
</pre>
 
'''Agent1 Third Notification'''
 
<pre>
 
{
 
    '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',
 
    'chatUri': 'http://10.10.15.212:9090/api/v2/chats/00010a9FSGFP001F'
 
}
 
 
</pre>
 
</pre>
 +
 
'''Agent2 First Notification'''
 
'''Agent2 First Notification'''
 
<pre>
 
<pre>
{
+
  {
    'chat': {
+
      'chat': {
        'userData': {
+
          'userData': {
            'IdentifyCreateContact': '3',
+
              'IdentifyCreateContact': '3',
            'FirstName': 'test_consult_client',
+
              'FirstName': 'test_consult_client',
            'LastName': 'Lastname',
+
              'LastName': 'Lastname',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
+
              'RTargetObjectSelected': 'Chatdistributionforprocessing',
            'RVQID': '',
+
              'RVQID': '',
            'ChatServerAppName': 'ChatServer',
+
              'ChatServerAppName': 'ChatServer',
            'PegAGChatdistributionforprocessing': 1,
+
              'PegAGChatdistributionforprocessing': 1,
            'ChatServerHost': 'htcc-gf81',
+
              'ChatServerHost': 'htcc-gf81',
            'RTargetObjSelDBID': '157',
+
              'RTargetObjSelDBID': '157',
            'CBR-IT-path_DBIDs': '',
+
              'CBR-IT-path_DBIDs': '',
            'ChatServerPort': '7030',
+
              'ChatServerPort': '7030',
            'CBR-Interaction_cost': '',
+
              'CBR-Interaction_cost': '',
            'CBR-contract_DBIDs': '',
+
              'CBR-contract_DBIDs': '',
            'ContactId': '00010a9FSGFP000M',
+
              'ContactId': '00010a9FSGFP000M',
            'RTargetAgentSelected': 'htcc1',
+
              'RTargetAgentSelected': 'htcc1',
            'RTargetTypeSelected': '2',
+
              'RTargetTypeSelected': '2',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
+
              'RTargetAgentGroup': 'Chatdistributionforprocessing',
            'RTargetRuleSelected': '',
+
              'RTargetRuleSelected': '',
            'RTargetPlaceSelected': 'htcc1',
+
              'RTargetPlaceSelected': 'htcc1',
            'CBR-actual_volume': '',
+
              'CBR-actual_volume': '',
            'RTenant': 'Environment',
+
              'RTenant': 'Environment',
            'ChatServerDBID': '175',
+
              'ChatServerDBID': '175',
            'RRequestedSkills': None,
+
              'RRequestedSkills': None,
            'ChatServerModeHA': 'true',
+
              'ChatServerModeHA': 'true',
            'RRequestedSkillCombination': '',
+
              'RRequestedSkillCombination': '',
            'RVQDBID': '',
+
              'RVQDBID': '',
            'RStrategyDBID': '894',
+
              'RStrategyDBID': '894',
            'CustomerSegment': 'default',
+
              'CustomerSegment': 'default',
            'ServiceType': 'default',
+
              'ServiceType': 'default',
            'ServiceObjective': 0,
+
              'ServiceObjective': 0,
            'RTargetRequested': 'Chatdistributionforprocessing',
+
              'RTargetRequested': 'Chatdistributionforprocessing',
            'EmailAddress': 'Email@abc.com',
+
              'EmailAddress': 'Email@abc.com',
            'RStrategyName': 'Chatinboundstrategy',
+
              'RStrategyName': 'Chatinboundstrategy',
            'Subject': 'Customersupport'
+
              'Subject': 'Customersupport'
        },
+
          },
        'state': 'LeftChat',
+
          'state': 'LeftChat',
        'capabilities': [
+
          'capabilities': [
            'SetInFocus',
+
              'SetInFocus',
            'Complete',
+
              'Complete',
            'SetDisposition',
+
              'SetDisposition',
            'AttachUserData',
+
              'AttachUserData',
            'DeleteUserData',
+
              'DeleteUserData',
            'UpdateUserData'
+
              'UpdateUserData'
        ],
+
          ],
        'uri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F',
+
          'uri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F',
        'participants': [
+
          'participants': [
            {
+
              {
                'nickname': 'test_consult',
+
                  'nickname': 'test_consult',
                'type': 'Agent',
+
                  'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
+
                  'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
+
                  'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
+
                  'participantId': '00AF52FCF0C0002F'
            },
+
              },
            {
+
              {
                'nickname': 'test_consult_clientL',
+
                  'nickname': 'test_consult_clientL',
                'type': 'Customer',
+
                  'type': 'Customer',
                'participantId': '00AF52FCF09E002D',
+
                  'participantId': '00AF52FCF09E002D',
                'visibility': 'All'
+
                  'visibility': 'All'
            }
+
              }
        ],
+
          ],
        'id': '00010a9FSGFP001F'
+
          'id': '00010a9FSGFP001F'
    },
+
      },
    'notificationType': 'ParticipantsUpdated',
+
      'notificationType': 'ParticipantsUpdated',
    'messageType': 'ChatStateChangeMessage'
+
      'messageType': 'ChatStateChangeMessage'
}
+
  }
 
</pre>
 
</pre>
 
'''Agent2 Second Notification'''
 
'''Agent2 Second Notification'''
 
<pre>
 
<pre>
{
+
  {
    'messages': [
+
      'messages': [
        {
+
          {
            'index': 7,
+
              'index': 7,
            'from': {
+
              'from': {
                'nickname': 'chat_consult',
+
                  'nickname': 'chat_consult',
                'type': 'Agent',
+
                  'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/c30d06daa1ea43b8be79f9b071f30d70',
+
                  'uri': 'http: //10.10.15.212: 9090/api/v2/users/c30d06daa1ea43b8be79f9b071f30d70',
                'visibility': 'All',
+
                  'visibility': 'All',
                'participantId': '00AF52FCF0C10030'
+
                  'participantId': '00AF52FCF0C10030'
            },
+
              },
            'timestamp': '2014-02-1308: 20: 59.000-0800',
+
              'timestamp': '2014-02-1308: 20: 59.000-0800',
            'visibility': 'All',
+
              'visibility': 'All',
            'type': 'ParticipantLeft',
+
              'type': 'ParticipantLeft',
            'timestampSeconds': 1392308459000L
+
              'timestampSeconds': 1392308459000L
        }
+
          }
    ],
+
      ],
    'notificationType': 'NewMessages',
+
      'notificationType': 'NewMessages',
    'messageType': 'MessageLogUpdated',
+
      'messageType': 'MessageLogUpdated',
    'chatUri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F'
+
      'chatUri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F'
}
+
  }
 
</pre>
 
</pre>
 
'''Agent2 Third Notification'''
 
'''Agent2 Third Notification'''
 
<pre>
 
<pre>
{
+
  {
    'chat': {
+
      'chat': {
        'userData': {
+
          'userData': {
            'IdentifyCreateContact': '3',
+
              'IdentifyCreateContact': '3',
            'FirstName': 'test_consult_client',
+
              'FirstName': 'test_consult_client',
            'LastName': 'Lastname',
+
              'LastName': 'Lastname',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
+
              'RTargetObjectSelected': 'Chatdistributionforprocessing',
            'RVQID': '',
+
              'RVQID': '',
            'ChatServerAppName': 'ChatServer',
+
              'ChatServerAppName': 'ChatServer',
            'PegAGChatdistributionforprocessing': 1,
+
              'PegAGChatdistributionforprocessing': 1,
            'ChatServerHost': 'htcc-gf81',
+
              'ChatServerHost': 'htcc-gf81',
            'RTargetObjSelDBID': '157',
+
              'RTargetObjSelDBID': '157',
            'CBR-IT-path_DBIDs': '',
+
              'CBR-IT-path_DBIDs': '',
            'ChatServerPort': '7030',
+
              'ChatServerPort': '7030',
            'CBR-Interaction_cost': '',
+
              'CBR-Interaction_cost': '',
            'CBR-contract_DBIDs': '',
+
              'CBR-contract_DBIDs': '',
            'ContactId': '00010a9FSGFP000M',
+
              'ContactId': '00010a9FSGFP000M',
            'RTargetAgentSelected': 'htcc1',
+
              'RTargetAgentSelected': 'htcc1',
            'RTargetTypeSelected': '2',
+
              'RTargetTypeSelected': '2',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
+
              'RTargetAgentGroup': 'Chatdistributionforprocessing',
            'RTargetRuleSelected': '',
+
              'RTargetRuleSelected': '',
            'RTargetPlaceSelected': 'htcc1',
+
              'RTargetPlaceSelected': 'htcc1',
            'CBR-actual_volume': '',
+
              'CBR-actual_volume': '',
            'RTenant': 'Environment',
+
              'RTenant': 'Environment',
            'ChatServerDBID': '175',
+
              'ChatServerDBID': '175',
            'RRequestedSkills': None,
+
              'RRequestedSkills': None,
            'ChatServerModeHA': 'true',
+
              'ChatServerModeHA': 'true',
            'RRequestedSkillCombination': '',
+
              'RRequestedSkillCombination': '',
            'RVQDBID': '',
+
              'RVQDBID': '',
            'RStrategyDBID': '894',
+
              'RStrategyDBID': '894',
            'CustomerSegment': 'default',
+
              'CustomerSegment': 'default',
            'ServiceType': 'default',
+
              'ServiceType': 'default',
            'ServiceObjective': 0,
+
              'ServiceObjective': 0,
            'RTargetRequested': 'Chatdistributionforprocessing',
+
              'RTargetRequested': 'Chatdistributionforprocessing',
            'EmailAddress': 'Email@abc.com',
+
              'EmailAddress': 'Email@abc.com',
            'RStrategyName': 'Chatinboundstrategy',
+
              'RStrategyName': 'Chatinboundstrategy',
            'Subject': 'Customersupport'
+
              'Subject': 'Customersupport'
        },
+
          },
        'state': 'LeftChat',
+
          'state': 'LeftChat',
        'capabilities': [
+
          'capabilities': [
            'SetInFocus',
+
              'SetInFocus',
            'Complete',
+
              'Complete',
            'SetDisposition',
+
              'SetDisposition',
            'AttachUserData',
+
              'AttachUserData',
            'DeleteUserData',
+
              'DeleteUserData',
            'UpdateUserData'
+
              'UpdateUserData'
        ],
+
          ],
        'uri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F',
+
          'uri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F',
        'participants': [
+
          'participants': [
            {
+
              {
                'nickname': 'test_consult',
+
                  'nickname': 'test_consult',
                'type': 'Agent',
+
                  'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
+
                  'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
+
                  'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
+
                  'participantId': '00AF52FCF0C0002F'
            },
+
              },
            {
+
              {
                'nickname': 'test_consult_clientL',
+
                  'nickname': 'test_consult_clientL',
                'type': 'Customer',
+
                  'type': 'Customer',
                'participantId': '00AF52FCF09E002D',
+
                  'participantId': '00AF52FCF09E002D',
                'visibility': 'All'
+
                  'visibility': 'All'
            }
+
              }
        ],
+
          ],
        'id': '00010a9FSGFP001F'
+
          'id': '00010a9FSGFP001F'
    },
+
      },
    'notificationType': 'StatusChange',
+
      'notificationType': 'StatusChange',
    'messageType': 'ChatStateChangeMessage'
+
      'messageType': 'ChatStateChangeMessage'
}
+
  }
 
</pre>
 
</pre>
 
'''Agent2 Fourth Notification'''
 
'''Agent2 Fourth Notification'''
 
<pre>
 
<pre>
{
+
  {
    'referenceId': 20,
+
      'referenceId': 20,
    'chat': {
+
      'chat': {
        'userData': {
+
          'userData': {
            'IdentifyCreateContact': '3',
+
              'IdentifyCreateContact': '3',
            'FirstName': 'test_consult_client',
+
              'FirstName': 'test_consult_client',
            'LastName': 'Lastname',
+
              'LastName': 'Lastname',
            'RTargetObjectSelected': 'Chatdistributionforprocessing',
+
              'RTargetObjectSelected': 'Chatdistributionforprocessing',
            'RVQID': '',
+
              'RVQID': '',
            'ChatServerAppName': 'ChatServer',
+
              'ChatServerAppName': 'ChatServer',
            'PegAGChatdistributionforprocessing': 1,
+
              'PegAGChatdistributionforprocessing': 1,
            'ChatServerHost': 'htcc-gf81',
+
              'ChatServerHost': 'htcc-gf81',
            'RTargetObjSelDBID': '157',
+
              'RTargetObjSelDBID': '157',
            'CBR-IT-path_DBIDs': '',
+
              'CBR-IT-path_DBIDs': '',
            'ChatServerPort': '7030',
+
              'ChatServerPort': '7030',
            'CBR-Interaction_cost': '',
+
              'CBR-Interaction_cost': '',
            'CBR-contract_DBIDs': '',
+
              'CBR-contract_DBIDs': '',
            'ContactId': '00010a9FSGFP000M',
+
              'ContactId': '00010a9FSGFP000M',
            'RTargetAgentSelected': 'htcc1',
+
              'RTargetAgentSelected': 'htcc1',
            'RTargetTypeSelected': '2',
+
              'RTargetTypeSelected': '2',
            'RTargetAgentGroup': 'Chatdistributionforprocessing',
+
              'RTargetAgentGroup': 'Chatdistributionforprocessing',
            'RTargetRuleSelected': '',
+
              'RTargetRuleSelected': '',
            'RTargetPlaceSelected': 'htcc1',
+
              'RTargetPlaceSelected': 'htcc1',
            'CBR-actual_volume': '',
+
              'CBR-actual_volume': '',
            'RTenant': 'Environment',
+
              'RTenant': 'Environment',
            'ChatServerDBID': '175',
+
              'ChatServerDBID': '175',
            'RRequestedSkills': None,
+
              'RRequestedSkills': None,
            'ChatServerModeHA': 'true',
+
              'ChatServerModeHA': 'true',
            'RRequestedSkillCombination': '',
+
              'RRequestedSkillCombination': '',
            'RVQDBID': '',
+
              'RVQDBID': '',
            'RStrategyDBID': '894',
+
              'RStrategyDBID': '894',
            'CustomerSegment': 'default',
+
              'CustomerSegment': 'default',
            'ServiceType': 'default',
+
              'ServiceType': 'default',
            'ServiceObjective': 0,
+
              'ServiceObjective': 0,
            'RTargetRequested': 'Chatdistributionforprocessing',
+
              'RTargetRequested': 'Chatdistributionforprocessing',
            'EmailAddress': 'Email@abc.com',
+
              'EmailAddress': 'Email@abc.com',
            'RStrategyName': 'Chatinboundstrategy',
+
              'RStrategyName': 'Chatinboundstrategy',
            'Subject': 'Customersupport'
+
              'Subject': 'Customersupport'
        },
+
          },
        'state': 'Completed',
+
          'state': 'Completed',
        'capabilities': [
+
          'capabilities': [
+
             
        ],
+
          ],
        'uri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F',
+
          'uri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F',
        'participants': [
+
          'participants': [
            {
+
              {
                'nickname': 'test_consult',
+
                  'nickname': 'test_consult',
                'type': 'Agent',
+
                  'type': 'Agent',
                'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
+
                  'uri': 'http: //10.10.15.212: 9090/api/v2/users/914165a5841348aa94ccfccd56917443',
                'visibility': 'All',
+
                  'visibility': 'All',
                'participantId': '00AF52FCF0C0002F'
+
                  'participantId': '00AF52FCF0C0002F'
            },
+
              },
            {
+
              {
                'nickname': 'test_consult_clientL',
+
                  'nickname': 'test_consult_clientL',
                'type': 'Customer',
+
                  'type': 'Customer',
                'participantId': '00AF52FCF09E002D',
+
                  'participantId': '00AF52FCF09E002D',
                'visibility': 'All'
+
                  'visibility': 'All'
            }
+
              }
        ],
+
          ],
        'id': '00010a9FSGFP001F'
+
          'id': '00010a9FSGFP001F'
    },
+
      },
    'notificationType': 'StatusChange',
+
      'notificationType': 'StatusChange',
    'messageType': 'ChatStateChangeMessage'
+
      'messageType': 'ChatStateChangeMessage'
}
+
  }
 
</pre>
 
</pre>
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 13:28, October 3, 2017

RemoveParticipantFromConference

This operation is part of the Chat 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/chats/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName RemoveParticipantFromConference
targetUri User URI to remove. Mandatory, if targetPath is not specified.
targetPath User path to remove. Mandatory, if targetUri is not specified.
text Optional. Text to send to customer.
messageType Optional, must be provided together with text parameter. Defines the message type. Default value: Text
treatAs Optional, must be provided together with text parameter. Specifies how message should be treated: Normal or System. Default value: Normal

Sample

Request

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

Response

{
  "statusCode": 0
}

Notification

Successful

Agent1 First Notification

  {
      'chat': {
          '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/chats/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': 'ChatStateChangeMessage'
  }

Agent1 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',
      'chatUri': 'http://10.10.15.212:9090/api/v2/chats/00010a9FSGFP001F'
  }

Agent2 First Notification

  {
      'chat': {
          '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/chats/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': 'ChatStateChangeMessage'
  }

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',
      'chatUri': 'http: //10.10.15.212: 9090/api/v2/chats/00010a9FSGFP001F'
  }

Agent2 Third Notification

  {
      'chat': {
          '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/chats/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': 'ChatStateChangeMessage'
  }

Agent2 Fourth Notification

  {
      'referenceId': 20,
      'chat': {
          '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/chats/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': 'ChatStateChangeMessage'
  }
Comments or questions about this documentation? Contact us for support!