Conferences Management

This endpoints help you manage your Conferences

  • Domain: https://conference-api-prod.quickom.com/

Create Conference

This api allows you create a Conference

  • Endpoint: POST /api/account/qrcode/create
  • Header: Authorization: <Your api key>
  • Request body:
{
    "label" : "QR Code label",
    "classroom" : true,
    "valid_from" : 0,
	"valid_to" : 0,
	"expire_at" : 0,
	"class_name" : "",
	"start_date" : 0,
	"end_date" : 0,
	"custom_student_url" : "",
	"custom_tutor_url" : ""
}
  • Parameters:
Param Type Mandatory Description
label String YES QR Code's label/name.
conference Boolean YES This field is
required for creating a group call QR Code
valid_from Long NO Set start-time for QR Code. Value is in millisecond
valid_to Long NO Set end-time for QR Code. Value is in millisecond
expire_at Long NO Set expire-time for QR Code. The QR Code will be deleted after expire-time. Value is in millisecond
class_name String NO Set your class's name
start_date Long NO Set your class's start-date. Value is in millisecond
end_date Long NO Set you class's end-date. Value is in milliseconds
custom_student_url String NO Custom student's url. Default is same as 'url'
custom_tutor_url String NO Custom teacher's url. Default is same as 'url'
  • Response status code: 200
  • Response body:
{
    "alias": "50401581580100161",
    "label": "QUICKOM Conference QR Code",
    "url": "https://conference.quickom.com/call/50401581580100161",
    "alive_type": "one_time",
    "used_minute": 0,
    "used_amount": "0",
    "used_call_number": 0,
    "call_type": "video",
    "allow_chat": true,
    "allow_call": true,
    "me": false,
    "is_expire": false,
    "members": null,
    "type": "classroom",
    "valid_from" : 0,
	"valid_to" : 0,
	"expire_at" : 0,
	"class_name" : "",
	"start_date" : 0,
	"end_date" : "",
	"student_url" : "https://conference.quickom.com/call/50401581580100161",
	"tutor_url" : "https://conference.quickom.com/call/50401581580100161"
}

Get Conference's info

This api allows you get detail of Conference

  • Endpoint: GET /api/account/qrcode/detail
  • Header: Authorization: <Your api key>
  • Request params:
Param Type Mandatory Description
alias String YES QR Code's alias id
  • Response status code: 200
  • Response body:
{
    "alias": "2587156861529703",
    "label": "QR Code's label",
    "group_name": null,
    "url": "https://conference.quickom.com/qr-code/2587156861529703",
    "alive_type": "permanent",
    "expire_at": null,
    "user": null,
    "limit_minute": null,
    "used_minute": 0,
    "limit_amount": null,
    "used_amount": "0",
    "limit_call_number": null,
    "used_call_number": 0,
    "call_type": "video",
    "allow_chat": true,
    "allow_call": true,
    "me": true,
    "is_expire": false
}

Update Conference's info

This api allows you update detail of Conference

  • Endpoint: POST /api/account/qrcode/update
  • Header: Authorization: <Your api key>
  • Request body:
{
	"alias" : "required",
    "label" : "optional",
    "group_name" : "optional",
    "expire_at" : -1,
    "custom_url" : "optional",
    "user" : "optional",
    "limit_minute" : 0,
    "limit_amount" : 0.0,
    "limit_call_number" : 0,
    "call_type" : "optional",
    "allow_chat" : true,
    "allow_call" : true,
    "me" : true,
    "class_name" : "",
	"start_date" : 0,
	"end_date" : 0,
	"custom_student_url" : "",
	"custom_tutor_url" : ""
}
  • Parameters:
Param Type Mandatory Description
alias String YES QR Code id
label String NO QR Code's label/name.
group_name String NO Group's name if you want to create qr code for a group.
expire_at Long NO Timestamp as millisecond that qr code will be expired at
user String NO Member's id if you want to create qr code for specific member.
limit_minute Long NO Minute limit for this qr code. Not apply for group qr code.
limit_amount Long NO Amount ($) budget for this qr code. Not apply for group qr code.
limit_call_number NO NO No. of call limit for this qr code. Not apply for group qr code.
allow_call Boolean NO Allow customer scan this qr code to call
call_type String NO Require if allow_call is TRUE
allow_chat Boolean NO Allow customer scan this qr code to chat
me Boolean NO TRUE if you want to create qr code for your self (not for member or group)
custom_url String NO Set your custom URL for this QR Code
class_name String NO Set your class's name
start_date Long NO Set your class's start-date. Value is in millisecond
end_date Long NO Set you class's end-date. Value is in milliseconds
custom_student_url String NO Custom student's url. Default is same as 'url'
custom_tutor_url String NO Custom teacher's url. Default is same as 'url'
  • Note: pass only fields that you want to change

  • Response status code: 200

  • Response body:

{
    "alias": "2587156861529703",
    "label": "QR Code's label",
    "group_name": null,
    "url": "https://conference.quickom.com/qr-code/2587156861529703",
    "alive_type": "permanent",
    "expire_at": null,
    "user": null,
    "limit_minute": null,
    "used_minute": 0,
    "limit_amount": null,
    "used_amount": "0",
    "limit_call_number": null,
    "used_call_number": 0,
    "call_type": "video",
    "allow_chat": true,
    "allow_call": true,
    "me": true,
    "is_expire": false
}

Delete Conference

This api allows you delete a Conference

  • Endpoint: DELETE /api/account/qrcode/delete
  • Header: Authorization: <Your api key>
  • Request body:
{
	"alias" : "QR code's alias id"
}
  • Parameters:
Param Type Mandatory Description
alias String YES QR Code's alias id
  • Response status code: 200
  • Response body:
{
    "success": true
}

List Conferences

This api allows you list all of your Conferences

  • Endpoint: POST /api/account/qrcode/list
  • Header: Authorization: <Your api key>
  • Request body:
{
  "from_hex_id": "string",
  "limit": 10
}
Param Type Mandatory Description
from_hex_id String NO hex_id define where the list should start from (The response excludes QR Code with hex_id)
limit Integer YES limit the number of QR Codes will be returned. Maximum is 50
  • Load more feature: Because of your QR Codes are much so we use limit for each of api call. To load more QR Codes, put hex_id of the last QR Code of previous api call into from_hex_id on the next api call. Put null at the first call.

  • Response status code: 200

  • Response body:

[
    {
        "hex_id" : "unique id of QR Code",
        "alias": "6154156291178864",
        "label": "tany",
        "group_name": null,
        "url": "https://quickom.beowulfchain.com/qr-code/6154156291178864",
        "alive_type": "permanent",
        "expire_at": null,
        "user": null,
        "limit_minute": null,
        "used_minute": 22,
        "limit_amount": null,
        "used_amount": "0.33",
        "limit_call_number": null,
        "used_call_number": 15,
        "call_type": "video",
        "allow_chat": true,
        "allow_call": true,
        "me": true,
        "is_expire": false
    }
]
Last Updated: 10/28/2020, 3:45:04 AM