Search Specific Scheduled Conferences

Search specific conferences from the scheduled conference list.

Request URL

GET {base_url}/{api_path}/conference/search?access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
page Yes Integer Define which page is displayed.
page_size Yes Integer Define how many records per page.
sort_by No String Define the sorting field.

Valid value:

  • number (Default)
  • name
order_by No String Define the display order.

Valid value:

  • asc: Ascending order. (Default)
  • desc: Descending order.
search_value No String Search keywords.

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of conferences.
data Array<Conference_Info> The list of the conferences' information.
Conference_Info
Table 3.
Parameter Type Description
id Integer The ID of the conference.
name String Conference name.
number String Conference number.
moderator_list Array<Moderator_List> The information list of conference moderators.
Moderator_List
Parameter Type Description
id String The ID of the conference moderator.
name String The name of the conference moderator.
type String The type of the conference moderator.
  • extension: Extension.
  • ext_group: Extension group.

Examples

Request example

Search for sales-related conferences.

GET /openapi/v1.0/conference/search?access_token=4mZxlzE08rl3g7rE7wjoMIowMoVkMvUr&page=1&page_size=5&search_value=sales HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 2,
    "data": [
        {
            "id": 1,
            "name": "Sales Weekly Meeting",
            "number": "6500",
            "moderator_list": [
                {
                    "id": "50",
                    "name": "Emily Parker",
                    "type": "extension"
                }
            ]
        },
        {
            "id": 4,
            "name": "Regional Sales Strategy Session",
            "number": "6503",
            "moderator_list": [
                {
                    "id": "53",
                    "name": "Rachel Morgan",
                    "type": "extension"
                }
            ]
        }
    ]
}