Version: V3.0

Visitor Management API

Get Visitor Temp Key List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
visitor_temp_key_id	String	Body	Visitor temp key ID
visitor_temp_key_name	String	Body	Visitor temp key name
visitor_temp_key_number	String	Body	Visitor temp key number
qr_code_url	String	Body	QR code URL
device_validity_count	String	Body	Device validity count
visitor_identity_number	String	Body	Visitor identity number
repeat_mode	String	Body	Repeat mode, never or daily or weekly
available_days	[]String	Body	Available days
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
created_time	String	Body	Created time, UTC
creator	String	Body	Creator

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_visitor_temp_key_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "visitor_temp_key_id": "vr2c4b070cc928496198944858b344fc6",
      "visitor_temp_key_name": "test",
      "visitor_temp_key_number": "93014275",
      "qr_code_url": "https://test.akubela.com/a.png",
      "device_validity_count": "",
      "visitor_identity_number": "123456",
      "repeat_mode": "weekly",
      "available_days": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday",
        "Sunday"
      ],
      "start_time": "13:14:00",
      "finish_time": "15:14:00",
      "created_time": "2024-01-25 21:10:16",
      "creator": "pm"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Visitor Temp Key Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
visitor_temp_key_id	String	Body	Yes	Visitor temp key ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
visitor_temp_key_name	String	Body	Visitor temp key name
visitor_temp_key_number	String	Body	Visitor temp key number
qr_code_url	String	Body	QR code URL
device_validity_count	String	Body	Device validity count
visitor_identity_number	String	Body	Visitor identity number
residence_id	String	Body	Residence ID
family_name	String	Body	Family name
residence_no	String	Body	Residence number
building_id	String	Body	Building ID
building_name	String	Body	Building name
repeat_mode	String	Body	Repeat mode, never or daily or weekly
available_days	[]String	Body	Available days
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
created_time	String	Body	Created time, UTC
creator	String	Body	Creator
devices	[]Object<device>	Body	Device Information

device description

Parameter Name	Type	Location	Description
building_id	String	Body	Building ID
building_name	String	Body	Building name
device_id	String	Body	Device ID
device_name	String	Body	Device name
mac	String	Body	MAC
online	Boolean	Body	Whether the device is online or not? true: online false: offline
device_type	String	Body	Device type, Multi-tenants Doorphone or Single-tenant Doorphone or Indoor Monitor or Guard Phone or Access Control
relays	[]Object<relay>	Body	Relay information
security_relays	[]Object<relay>	Body	Security relay information

relay description

Parameter Name	Type	Location	Description
relay_name	String	Body	Relay name
relay_number	String	Body	Relay number
relay_id	String	Body	Relay ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_visitor_temp_key_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "visitor_temp_key_id": "vr2c4b070cc928496198944858b344fc6",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "visitor_temp_key_name": "test",
      "visitor_temp_key_number": "93014275",
      "qr_code_url": "https://test.akubela.com/a.png",
      "device_validity_count": "",
      "visitor_identity_number": "123456",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "repeat_mode": "weekly",
      "available_days": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday",
        "Sunday"
      ],
      "start_time": "13:14:00",
      "finish_time": "15:14:00",
      "created_time": "2024-01-25 21:10:16",
      "creator": "pm",
      "devices": [
        {
          "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
          "device_name": "test",
          "mac": "C10519082089",
          "building_id": "b1a621c1ae77040d697bd2134700f57ee",
          "building_name": "AB01",
          "online": true,
          "device_type": "Multi-tenants Doorphone",
          "security_relays": [],
          "relays": [
            {
              "relay_name": "Front Door 3",
              "relay_number": "#",
              "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
            }
          ]
        }
      ]
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Visitor Temp Key Device List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
building_id	String	Body	Building ID
building_name	String	Body	Building name
device_id	String	Body	Device ID
device_name	String	Body	Device name
mac	String	Body	MAC
online	Boolean	Body	Whether the device is online or not? true: online false: offline
device_type	String	Body	Device type, Multi-tenants Doorphone or Single-tenant Doorphone or Indoor Monitor or Guard Phone or Access Control
relays	[]Object<relay>	Body	Relay information
security_relays	[]Object<relay>	Body	Security relay information

relay description

Parameter Name	Type	Location	Description
relay_name	String	Body	Relay name
relay_number	String	Body	Relay number
relay_id	String	Body	Relay ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_visitor_temp_key_device_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
      "device_name": "test",
      "mac": "C10519082089",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "online": true,
      "device_type": "Multi-tenants Doorphone",
      "security_relays": [],
      "relays": [
        {
          "relay_name": "Front Door 3",
          "relay_number": "#",
          "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
        }
      ]
    }
  ]
}

Failure Return Example

See Failure Return Example

Create Visitor Temp Key Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
visitor_temp_key_name	String	Body	Yes	Visitor temp key name
device_validity_count	String	Body	No	Device validity count
visitor_identity_number	String	Body	No	Visitor identity number
notice_email	String	Body	No	Notice email
residence_id	String	Body	Yes	Residence ID
family_name	String	Body	Yes	Family name
residence_no	String	Body	Yes	Residence number
building_id	String	Body	Yes	Building ID
building_name	String	Body	Yes	Building name
repeat_mode	String	Body	Yes	Repeat mode, never or daily or weekly
available_days	[]String	Body	No	Available days
start_time	String	Body	Yes	Start time, UTC
finish_time	String	Body	Yes	Finish time, UTC
devices	[]Object<device>	Body	Yes	Device Information

device description

Parameter Name	Type	Location	Required	Description
building_id	String	Body	Yes	Building ID
device_id	String	Body	Yes	Device ID
mac	String	Body	Yes	MAC
relays	[]Object<relay>	Body	Yes	Relay information
security_relays	[]Object<relay>	Body	Yes	Security relay information

relay description

Parameter Name	Type	Location	Required	Description
relay_id	String	Body	Yes	Relay ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
visitor_temp_key_id	String	Body	Visitor temp key ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_visitor_temp_key_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "visitor_temp_key_name": "test",
    "device_validity_count": "",
    "visitor_identity_number": "123456",
    "notice_email": "test@akubela.com",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "family_name": "test",
    "residence_no": "101",
    "building_id": "b1a621c1ae77040d697bd2134700f57ee",
    "building_name": "AB01",
    "repeat_mode": "weekly",
    "available_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday",
      "Sunday"
    ],
    "start_time": "13:14:00",
    "finish_time": "15:14:00",
    "devices": [
      {
        "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
        "building_id": "b1a621c1ae77040d697bd2134700f57ee",
        "mac": "C10519082081",
        "security_relays": [],
        "relays": [
          {
            "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
          }
        ]
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "visitor_temp_key_id": "v2a621c1ae77040d697bd2134700f57ea"
  }
}

Failure Return Example

See Failure Return Example

Delete Visitor Temp Key Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
visitor_temp_key_id	String	Body	Yes	Visitor temp key ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_visitor_temp_key_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "visitor_temp_key_id": "vrbr2c4b070cc928496198944858b344f"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Batch Delete Visitor Temp Key Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
visitor_temp_keys	[]Object<visitor_temp_key>	Body	Yes	Visitor temp key information

visitor_temp_key description

Parameter Name	Type	Location	Required	Description
visitor_temp_key_id	String	Body	Yes	Visitor temp key ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_visitor_temp_key_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p01adc223cc4b3bedb6bd4742dedcfa52",
    "visitor_temp_keys": [
      {
        "visitor_temp_key_id": "v8b5a73f8dd84abaa94dcs248be49b0d1"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Get Visitor Temp Key History

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index
visitor_temp_key_id	String	Body	Yes	Visitor temp key ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
open_door	Boolean	Body	Whether the door opening is successful or not? true: success false: failure
account_name	String	Body	Account name
device_name	String	Body	Device name
capture_thumbnail_url	String	Body	Capture thumbnail URL
open_door_type	String	Body	Open door type
capture_picture_url	String	Body	Capture picture URL
open_door_time	String	Body	Open door time
residence_no	String	Body	Residence number
building_name	String	Body	Building name
record_type	String	Body	Record type
number	String	Body	Number

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_visitor_temp_key_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "visitor_temp_key_id": "vr2c4b070cc928496198944858b344fc6",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "open_door_time": "2020-05-18 15:25:45",
      "building_name": "test",
      "device_name": "device",
      "account_name": "tom",
      "residence_no": "121",
      "record_type": "open door",
      "open_door_type": "temp key",
      "number": "12314134",
      "open_door": true,
      "capture_thumbnail_url": "https://test.akubela.com/r.jpg",
      "capture_picture_url": "https://test.akubela.com/d.jpg"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Visitor Temp Key List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Visitor Temp Key Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

device description​

relay description​

Request Example​

Success Return Example​

Failure Return Example​

Get Visitor Temp Key Device List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

relay description​

Request Example​

Success Return Example​

Failure Return Example​

Create Visitor Temp Key Information​

Request URL​

Request Parameter​

param description​

device description​

relay description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Delete Visitor Temp Key Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Batch Delete Visitor Temp Key Information​

Request URL​

Request Parameter​

param description​

visitor_temp_key description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Get Visitor Temp Key History​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Visitor Temp Key List

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Visitor Temp Key Information

Request URL

Request Parameter

param description

Return Parameter

result description

device description

relay description

Request Example

Success Return Example

Failure Return Example

Get Visitor Temp Key Device List

Request URL

Request Parameter

param description

Return Parameter

result description

relay description

Request Example

Success Return Example

Failure Return Example

Create Visitor Temp Key Information

Request URL

Request Parameter

param description

device description

relay description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Delete Visitor Temp Key Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Batch Delete Visitor Temp Key Information

Request URL

Request Parameter

param description

visitor_temp_key description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Get Visitor Temp Key History

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example