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

Unholding a Participant in a Conference

Prerequisites

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

Description

This interface is used by a chairperson to unhold a participant in a conference. Only chairpersons have the permission to unhold a participant.

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

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

unholdParticipant

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

    addressType

    String

    Yes

    Address type.

    6: phone number

    9: agent ID

    2

    address

    String

    Yes

    Address ID, that is, phone number or agent ID.

    The maximum length is 24 bytes.

Response Description

Table 4 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
    {
        "address": "2002",
        "addressType": "9"
    }
  • Response parameter
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }