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

Modifying Participant Attributes

Prerequisites

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

Description

This interface is used by a chairperson to modify participant channel attributes. Only chairpersons have the permission to modify such attributes.

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

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

changeParticipantMode

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

    attribute

    int

    Yes

    Participant attribute. The options are as follows:

    1: The participant can only listen but cannot speak.

    2: The participant can only speak but cannot listen.

    3: The participant can listen and speak.

    4: The participant cannot listen or speak.

    2

    addressType

    String

    Yes

    Address type.

    6: phone number

    9: agent ID

    3

    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

If the participant attribute value is set to 1 or 3, the following event is received:

  • AgentConf_ParticipantChanged

If the participant attribute value is set to 2 or 4, no event is received.

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
    {
        "attribute": 3,
        "address": "88887744",
        "addressType": "6"
    }
  • Response parameter
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }