HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Config ble beacon profile

post
https://{api-base-url}/cfg_beacon_profiles/

Config Ble Beacon Profile

Path Params
string
required

the name of configured group

Query Params
string
required

config ble beacon profile name

string
enum
required
Defaults to auto_generate

ble beacon profile method. Openlocate advertisement beacon only support auto_generate.

Allowed:
string
enum

ble advertise beacon format

Allowed:
string
enum
required

apply the profile ble radio instance

Allowed:
integer

ble beacon advertisement interval, in ms. increment in multiples of 100 and range is 100-30000

integer

ibeacon config, range is 0-65535

integer

ibeacon config, range is 0-65535

integer

ibeacon config, range is 0-65535

integer

ibeacon config, range is 0-65535

string

ibeacon config

string

custom beacon config, length is 3-31 bytes and each bytes include 2 ASCII characters

Body Params

the detail for beacon advertisement. by adv_format value to config deatil payload.

openlocate
object
Responses
200

Successful response

401

Unauthorized

403

Forbidden

429

API Rate limit exceeded

default

Unexpected error

Updated about 2 years ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago