Updated on 2023-12-19 GMT+08:00

Applying for Extending a Conference

Prerequisites

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

Description

This interface is used by a chairperson to extend a conference. The total conference duration cannot exceed 1440 minutes.

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

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

prolongTime

Request Description

  • Message header
    Table 2 Parameters in the message body

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    Content-Type

    String

    True

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    String

    True

    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

    prolongTime

    Integer

    Yes

    Duration by which a conference is extended.

    The unit is minute.

    The value ranges from 1 to 1440.

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

Map

For details, see Table 5.

Table 5 Actual extended duration

No.

Parameter

Value Type

Description

3.1

applyedTime

Integer

Actual extended duration.

The unit is minute.

The value ranges from 1 to 1440.

The value of applyedTime may be shorter than the value of {prolongTime}, because the sum of the value of {prolongTime} and the used conference time is longer than 1440 minutes.

Triggered Event

  • None

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
    {
        "prolongTime": 100
    }
  • Response parameter
    {
        "result": {
            "applyedTime": 50
        },
        "message": "success",
        "retcode": "0"
    }