For Developers

Members Management

This endpoints help you manage your Members

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

Create member with new account

  • Endpoint: POST /api/member/create
  • Header: Authorization: <Your api key>
  • Request body:
{
	"email" : "",
	"phone_number" : "",
	"password" : "",
	"name" : ""
}
  • Parameters:
Param Type Mandatory Description
email String NO Email
phone_number String NO Phone number must be in format "+84xxxx"
password String YES Password
name String NO Member's name

  • Note: Email or Phone number are required.

  • Response status code: 200

  • Response body:

{
    "company_id": "company's id",
    "member_id": "member's id",
    "email": "member's email",
    "phone_number": "member's phone_number",
    "name": "member's name",
    "description": "Member's description",
    "default_qr_code": "member's default qr code",
    "chat_id": "member's chat id",
    "qrcode_detail": {
        "alias": "member's default qrcode",
        "label": "qrcode label",
        "type": "personal_call",
        "call_type": "video",
        "allow_chat": true,
        "allow_call": true,
        "url": "qrcode url"
    }
}

Add new member (from existed account)

  • Endpoint: POST /api/member/add
  • Header: Authorization: <Your api key>
  • Request body:
{
	"username" : "Email or phone number",
	"name" : "Your member's custom name",
	"description" : "Description"
}
  • Parameters:
Param Type Mandatory Description
username String YES Email or phone number
name String NO Your member's custom name.
description String NO Description
  • Response status code: 200
  • Response body:
{
    "company_id": "company's id",
    "member_id": "member's id",
    "email": "member's email",
    "phone_number": "member's phone_number",
    "name": "member's name",
    "description": "Member's description",
    "default_qr_code": "member's default qr code",
    "chat_id": "member's chat id",
    "qrcode_detail": {
        "alias": "member's default qrcode",
        "label": "qrcode label",
        "type": "personal_call",
        "call_type": "video",
        "allow_chat": true,
        "allow_call": true,
        "url": "qrcode url"
    }
}

Get Member detail

  • Get member's detail by member_id, email or phone_number
  • Endpoint: POST /api/member/detail
  • Header: Authorization: <Your api key>
  • Request body:
{
	"member_id" : "member's id",
	"email" : "",
	"phone_number" : ""
}
  • Parameters:
Param Type Mandatory Description
member_id String NO Member's id.
email String NO Member's email
phone_number NO Member's phone number

  • Note: One of member_id, email and phone_number is required.

  • Response status code: 200

  • Response body:

{
    "company_id": "company's id",
    "member_id": "member's id",
    "email": "member's email",
    "phone_number": "member's phone_number",
    "name": "member's name",
    "description": "Member's description",
    "default_qr_code": "member's default qr code",
    "chat_id": "member's chat id",
    "qrcode_detail": {
        "alias": "member's default qrcode",
        "label": "qrcode label",
        "type": "personal_call",
        "call_type": "video",
        "allow_chat": true,
        "allow_call": true,
        "url": "qrcode url"
    }
}

Delete member

  • Endpoint: POST /api/member/remove
  • Header: Authorization: <Your api key>
  • Request body:
{
	"member_id" : "member's id"
}
  • Parameters:
Param Type Mandatory Description
member_id String YES Member's id.
  • Response status code: 200
  • Response body:
{
    "success": true
}

List members

This api allows you list your all members

  • Endpoint: POST /api/member/list
  • Header: Authorization: <Your api key>
  • Request body:
{
	"group" : "Group's name (optional)"
}
  • Parameters:
Param Type Mandatory Description
group String NO Group's name. Leave it empty for all
  • Response status code: 200
  • Response body:
[
	{
        "company_id": "company id",
        "member_id": "member id",
        "email": "member email",
        "phone_number": "member phone number",
        "name": "member name",
        "description": "",
        "default_qr_code": "member default qrcode",
        "chat_id": "member chat id"
    }
]

Update member's info

  • Endpoint: POST /api/member/update
  • Header: Authorization: <Your api key>
  • Request body:
{
	"member_id" : "member_id",
	"name" : "name",
	"description" : "description"
}
  • Parameters:
Param Type Mandatory Description
member_id String YES Member's id.
name String NO Member's name to update.
description String NO Member's description to update.
  • Response status code: 200
  • Response body:
{
    "company_id": "company's id",
    "member_id": "member's id",
    "email": "member's email",
    "phone_number": "member's phone_number",
    "name": "member's name",
    "description": "Member's description",
    "default_qr_code": "member's default qr code",
    "chat_id": "member's chat id",
    "qrcode_detail": {
        "alias": "member's default qrcode",
        "label": "qrcode label",
        "type": "personal_call",
        "call_type": "video",
        "allow_chat": true,
        "allow_call": true,
        "url": "qrcode url"
    }
}
Last Updated: 9/17/2020, 1:13:54 PM

← QR Codes Management →