Updated on 2023-09-27 GMT+08:00

Inviting 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 invite multiple participants to join a conference.

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}/batchaddparticipant

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.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

Method Name in Logs

batchAddParticipant

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 invited to join a conference in batches.

    The maximum length of the array is 120.

    For details about the parameters of this object, see Table 4.

    2

    beepTone

    boolean

    No

    Whether to play a welcome announcement to a user when the user joins a conference.

    The default value is false.

    3

    playMode

    int

    No

    Mode for playing an announcement.

    The value 2 indicates that a specified announcement file is played.

    The default value is 2.

    4

    voicePath

    String

    No

    Absolute file path. The value is in the format of Drive letter/conf/VDN ID/Announcement file name, for example, y:/conf/120/1136287.V3.

    When BeepTone is set to true, this parameter must be set and playMode must be set to 2. When BeepTone is set to false, this parameter is invalid.

    The value can contain a maximum of 127 characters.

    5

    caller

    String

    No

    Calling number. If there are restrictions on numbers in the VDN, the value must be within the restriction range.

    The value can contain a maximum of 24 characters.

    Table 4 Parameters of the participant 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.

    1.3

    deviceCallType

    int

    No

    User-defined device call type. For details, see Table 3.

    If this parameter is left empty or set to null, the default value 0 is used.

    The value ranges from 0 to 255.

    1.4

    deviceType

    int

    No

    User-defined device type. For details, see Table 2.

    If this parameter is left empty or set to null, the default value 0 is used.

    The value ranges from 0 to 255.

Response Description

Table 5 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

0: success

Other values: failure

3

result

object

Reserved field.

Triggered Event

  • AgentConf_ParticipantChanged

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",
                "deviceCallType": 1,
                "deviceType": 66
            }
        ],
        "beepTone": false,
        "playMode": 2,
        "voicePath": "y:/conf/120/1136287.V3",
        "caller": "1111"
    }
  • Response parameter
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }