Querying Conference Information in Batches
Prerequisites
- The agent has signed in.
Description
This interface is used to query conference information in batches.
- An inspector can query information about all conferences in the VDN to which the inspector belongs in batches.
- A common agent can query only the information about the conference to which the common agent belongs.
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}/queryconfinfos
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.
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
queryConfInfos
Request Description
- Message header
Table 2 Parameters in the message body No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
modifyType
int
Yes
Type of a change request.
0: increase
1: decrease
2
modifyNum
int
Yes
Number to be changed.
The value ranges from 2 to 118.
- Message body
Table 3 Parameters in the message body No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
confIds
array
Yes
Conference ID array.
The maximum length of the array is 20.
Response Description
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 |
array |
For details, see Table 5. |
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
3.1 |
confId |
long |
Conference ID. |
3.2 |
confState |
int |
Conference status. The options are as follows: 0: normal conference call 1: conference announcement playing |
3.3 |
startTime |
long |
Conference start time. The value is a timestamp, in milliseconds. |
3.4 |
applyConfTime |
int |
Applied conference duration, in minutes. |
3.5 |
confHaveBeenTime |
int |
Time elapsed since a conference starts, in minutes. |
3.6 |
addresses |
array |
Participant list. For details, see Table 6. |
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
3.6.1 |
addressType |
String |
3: address type. 6: phone number 9: agent ID |
3.6.2 |
address |
String |
Address ID. |
3.6.3 |
deviceCallType |
int |
User-defined device call type. For details, see Table 3. |
3.6.4 |
deviceType |
int |
User-defined device type. For details, see Table 2. |
3.6.5 |
channelAttrib |
int |
Conference attribute. 1: listening only 2: speaking only 3: listening and speaking |
3.6.6 |
channelState |
int |
Conference channel status. The options are as follows: 0: The conference call is in progress. 1: The conference call is held. 2: The announcement is played. |
3.6.7 |
role |
int |
Conference role. The options are as follows: 0: participant 1: chairperson |
3.6.8 |
enterTime |
long |
Time when a user joins a conference. The value is a timestamp, in milliseconds. |
Triggered Event
None
Error Code
- 000-002
- 100-006
- 100-007
Example
- Message header
Content-Type:application/json; charset=UTF-8 Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- Request parameter
{ "confIds": [ 1029888, 1029889 ] }
- Response parameter
{ "message": "", "retcode": "0", "result": { "confs": [ { "confId": 1029888, "confState": 0, "startTime": 1475745454000, "applyConfTime": 60, "confHaveBeenTime": 29, "addresses": [ { "addressType": "6", "address": "70005", "deviceCallType": 0, "deviceType": 0, "channelAttrib": 3, "channelState": 0, "role": 0, "enterTime": 1475745464000 }, { "addressType": "9", "address": "153", "deviceCallType": 0, "deviceType": 6, "channelAttrib": 3, "channelState": 0, "role": 1, "enterTime": 1475745454000 } ] } ] } }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot