Deleting Participants in Batches

Prerequisites

• The agent has signed in.
• The current agent is the conference chairperson.

Description

This interface is used by a chairperson to delete participants from a conference in batches.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/agentconf/{agentid}/batchremoveparticipant

In the URL, ip indicates the IP address of the agent gateway server, and port indicates the HTTPS port number of the agent gateway server.

Method Name in Logs

batchRemoveParticipant

Request Description

• Message header

  Table 2 Parameters in the request message header

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	Content-Type	string	Yes	Coding mode of the message body. The default value is application/json; charset=UTF-8.
  2	Guid	string	Yes	GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).

• Message body

  Table 3 Parameters in the message body

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	addresses	array	Yes	Information about participants to be deleted in batches. The maximum length of the array is 30. For details about the parameters of this object, see Table 4.

  Table 4 AgentConfAddressExParam object

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1.1	addressType	String	Yes	Address type. 6: phone number 9: agent ID
  1.2	address	String	Yes	Address ID. The value can contain a maximum of 24 characters.

Response Description

Triggered Event

• AgentConf_ParticipantChanged
• AgentConf_SelfLeaveResult

Error Code

• 000-002
• 100-006
• 100-007
• 101-001
• 101-002

Example

• Message header

  Content-Type:application/json; charset=UTF-8
  Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

• Request parameter

  {
      "addresses": [
          {
              "address": "2002",
              "addressType": "9"
          },
          {
              "address": "2001",
              "addressType": "9"
          }
      ]
  }

• Response parameter

  {
      "message": "",
      "retcode": "0",
      "result": {
          "noExistParticipants": []
      }
  }