ਡਿਵੈਲਪਰ ਪਲੇਟਫਾਰਮ

' ਿ 
ਕਨੈਕਸ਼ਨ ਪਲੇਟਫਾਰਮ

ਦੋ ਸ਼ਕਤੀਸ਼ਾਲੀ API — ਡਿਵਾਈਸ ਪ੍ਰਬੰਧਨ ਅਤੇ ਸੰਚਾਰ ਆਰਕੈਸਟ੍ਰੇਸ਼ਨ ਲਈ ਇੱਕ RESTful ਸਰਵਰ API, ਅਤੇ ਸਿੱਧੇ ਬੈਜ ਨਿਯੰਤਰਣ ਲਈ ਇੱਕ ਘੱਟ-ਪੱਧਰੀ CBBP ਪ੍ਰੋਟੋਕੋਲ।

ਓਪਨਏਪੀਆਈ 3.0JSON / RESTਬਲੂਟੁੱਥ + ਵਾਈਫਾਈਵੈੱਬਹੁੱਕ ਸਹਾਇਤਾ
Connection Studio
Explorer
examples
send_command.http
response.json
list_devices.http
webhooks.http
src
docs
send_command.http
response.json
# Send a CBBP command via the server
POST /api/v1/devices/{uuid}/cbbp

{
  "command": "speak",
  "object": {
    "text": "Shift starts in 5 minutes",
    "volume": 85,
    "language": "en-US"
  }
}

# Response
{
  "result": 0,
  "detail": "ok"
}
main
HTTPUTF-8Ln 2, Col 1

ਆਰਾਮ API

ਪੂਰਾ ਡਿਵਾਈਸ ਲਾਈਫਸਾਈਕਲ ਪ੍ਰਬੰਧਨ — ਪ੍ਰੋਵਿਜ਼ਨਿੰਗ, ਕੌਂਫਿਗਰੇਸ਼ਨ, ਫਰਮਵੇਅਰ, ਸੰਚਾਰ, ਅਤੇ ਵਿਸ਼ਲੇਸ਼ਣ — ਸਟੈਂਡਰਡ HTTPS ਉੱਤੇ।

REST API ਦੀ ਪੜਚੋਲ ਕਰੋ →

ਸੀਬੀਬੀਪੀ ਪ੍ਰੋਟੋਕੋਲ

ਕਾਮ ਬੈਜ ਬੇਸਿਕ ਪ੍ਰੋਟੋਕੋਲ — ਬਲੂਟੁੱਥ (ਐਪ), ਵਾਈਫਾਈ (ਸਰਵਰ ਪ੍ਰੌਕਸੀ), ਜਾਂ ਸਥਾਨਕ ਡਿਸਪੈਚ ਉੱਤੇ ਸਿੱਧੇ ਡਿਵਾਈਸ ਨਿਯੰਤਰਣ ਲਈ ਇੱਕ JSON ਕਮਾਂਡ ਪ੍ਰੋਟੋਕੋਲ।

CBBP ਦੀ ਪੜਚੋਲ ਕਰੋ →

ਵੈੱਬਹੁੱਕ

ਰੀਅਲ-ਟਾਈਮ ਡਿਵਾਈਸ ਇਵੈਂਟਸ - ਸੰਚਾਰ, ਸਥਿਤੀ ਬਦਲਾਅ, ਸਥਾਨ ਅੱਪਡੇਟ - ਦੀ ਗਾਹਕੀ ਲਓ ਜੋ ਤੁਹਾਡੇ ਐਂਡਪੁਆਇੰਟ 'ਤੇ HTTP POST ਪੇਲੋਡ ਦੇ ਰੂਪ ਵਿੱਚ ਡਿਲੀਵਰ ਕੀਤੇ ਜਾਂਦੇ ਹਨ।

ਵੈੱਬਹੁੱਕਸ ਦੀ ਪੜਚੋਲ ਕਰੋ →

Early Access: The Connection API is currently available by special request to select partners. Contact us to apply for access.

Pro or Plus plan required: Badges must be on the Pro or Plus plan to be controlled via the API.

ਸ਼ੁਰੂ ਕਰਨਾ

ਪ੍ਰਮਾਣਿਕਤਾ

ਕਨੈਕਸ਼ਨ API ਬੇਅਰਰ ਟੋਕਨ ਪ੍ਰਮਾਣੀਕਰਨ ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ। ਸਾਰੀਆਂ ਬੇਨਤੀਆਂ ਵਿੱਚ ਪ੍ਰਮਾਣੀਕਰਨ ਸਿਰਲੇਖ ਵਿੱਚ ਇੱਕ ਵੈਧ JWT ਪਹੁੰਚ ਟੋਕਨ ਸ਼ਾਮਲ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ।

ਟੋਕਨ ਪ੍ਰਾਪਤ ਕਰੋ

ਆਪਣੇ ਪ੍ਰਮਾਣ ਪੱਤਰਾਂ ਨੂੰ ਪ੍ਰਮਾਣੀਕਰਨ ਦੇ ਅੰਤਮ ਬਿੰਦੂ 'ਤੇ ਪੋਸਟ ਕਰੋ। ਤੁਹਾਨੂੰ ਇੱਕ ਥੋੜ੍ਹੇ ਸਮੇਂ ਲਈ ਐਕਸੈਸ_ਟੋਕਨ ਅਤੇ ਇੱਕ ਲੰਬੇ ਸਮੇਂ ਲਈ ਰਿਫ੍ਰੈਸ਼_ਟੋਕਨ ਪ੍ਰਾਪਤ ਹੋਵੇਗਾ।

ਟੋਕਨ ਦੀ ਵਰਤੋਂ ਕਰੋ

ਹਰੇਕ ਬੇਨਤੀ ਵਿੱਚ ਟੋਕਨ ਸ਼ਾਮਲ ਕਰੋ:

Authorization: Bearer <access_token>
POST/api/v1/auth/login
ਬੇਨਤੀ
{
  "email": "admin@yourorg.com",
  "password": "••••••••"
}
ਜਵਾਬ 200
{
  "access_token": "eyJhbG...",
  "refresh_token": "dGhpcw...",
  "expires_in": 3600,
  "token_type": "Bearer"
}

ਬੇਸ URL ਅਤੇ ਵਰਜਨਿੰਗ

ਸਾਰੇ API ਐਂਡਪੁਆਇੰਟ /api/v1/ ਦੇ ਅਧੀਨ ਵਰਜਨ ਕੀਤੇ ਗਏ ਹਨ। ਬੇਸ URL ਤੁਹਾਡੀ ਤੈਨਾਤੀ 'ਤੇ ਨਿਰਭਰ ਕਰਦਾ ਹੈ।

ਕਲਾਉਡ-ਹੋਸਟਡ ਤੈਨਾਤੀਆਂ ਲਈ, ਆਪਣੀ ਸੰਸਥਾ ਨੂੰ ਦਿੱਤੇ ਗਏ ਖੇਤਰੀ ਅੰਤਮ ਬਿੰਦੂ ਦੀ ਵਰਤੋਂ ਕਰੋ। ਆਨ-ਪ੍ਰੀਮਿਸਸ ਸਰਵਰ ਤੈਨਾਤੀਆਂ ਲਈ, ਆਪਣੇ ਸਰਵਰ ਦੇ ਹੋਸਟਨਾਮ ਦੀ ਵਰਤੋਂ ਕਰੋ।

ਵਾਤਾਵਰਣਮੂਲ URL
ਕਲਾਉਡ (ਅਮਰੀਕਾ)https://beta.connection.app/api/v1
ਆਨ-ਪ੍ਰੀਮਿਸਸhttps://<your-server>/api/v1
ਸਮੱਗਰੀ-ਕਿਸਮ
ਸਾਰੀਆਂ ਬੇਨਤੀਆਂ ਅਤੇ ਜਵਾਬ ਸੰਸਥਾਵਾਂ application/json ਦੀ ਵਰਤੋਂ ਕਰਦੀਆਂ ਹਨ। ਇੱਕ ਬਾਡੀ ਵਾਲੀਆਂ ਬੇਨਤੀਆਂ 'ਤੇ Content-Type: application/json ਸ਼ਾਮਲ ਕਰੋ।

ਗਲਤੀਆਂ ਅਤੇ ਸਥਿਤੀ ਕੋਡ

API ਮਿਆਰੀ HTTP ਸਥਿਤੀ ਕੋਡਾਂ ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ। ਗਲਤੀ ਜਵਾਬਾਂ ਵਿੱਚ ਇੱਕ ਮਸ਼ੀਨ-ਪੜ੍ਹਨਯੋਗ ਕੋਡ ਅਤੇ ਮਨੁੱਖੀ-ਪੜ੍ਹਨਯੋਗ ਸੁਨੇਹਾ ਸ਼ਾਮਲ ਹੁੰਦਾ ਹੈ।

ਸਥਿਤੀਭਾਵ
200ਸਫਲਤਾ
201ਬਣਾਇਆ ਗਿਆ
400ਗਲਤ ਬੇਨਤੀ — ਅਵੈਧ ਪੈਰਾਮੀਟਰ
401ਅਣਅਧਿਕਾਰਤ — ਗੁੰਮ ਜਾਂ ਮਿਆਦ ਪੁੱਗਿਆ ਟੋਕਨ
403ਵਰਜਿਤ — ਨਾਕਾਫ਼ੀ ਇਜਾਜ਼ਤਾਂ
404ਨਹੀਂ ਲਭਿਆ
500ਅੰਦਰੂਨੀ ਸਰਵਰ ਗਲਤੀ
ਗਲਤੀ ਜਵਾਬ
{
  "error": {
    "code": "device_not_found",
    "message": "No device with that UUID exists in your organization",
    "status": 404
  }
}
ਆਰਾਮ API

REST API ਸੰਖੇਪ ਜਾਣਕਾਰੀ

ਕਨੈਕਸ਼ਨ ਸਰਵਰ REST API ਤੁਹਾਡੇ ਡਿਵਾਈਸ ਫਲੀਟ, ਸੰਚਾਰ ਬੁਨਿਆਦੀ ਢਾਂਚੇ, ਅਤੇ ਵਿਸ਼ਲੇਸ਼ਣ ਤੱਕ ਪੂਰੀ ਪ੍ਰੋਗਰਾਮੇਟਿਕ ਪਹੁੰਚ ਪ੍ਰਦਾਨ ਕਰਦਾ ਹੈ। ਇਹ JSON ਬੇਨਤੀ/ਜਵਾਬ ਸੰਸਥਾਵਾਂ ਦੇ ਨਾਲ RESTful ਸੰਮੇਲਨਾਂ ਦੀ ਪਾਲਣਾ ਕਰਦਾ ਹੈ।

API ਪ੍ਰਮਾਣੀਕਰਨ
ਉਪਭੋਗਤਾ
ਡਿਵਾਈਸਾਂ
ਚੈਨਲ
ਸੰਚਾਰ
ਆਡੀਓ ਬ੍ਰਿਜ
ਗੱਲਬਾਤ
ਸਮੱਗਰੀ
ਸਥਾਨ
ਪੁਸ਼ ਸੂਚਨਾਵਾਂ
ਸਟੋਰੇਜ
ਥੋਕ ਕਾਰਜ
ਤਾਰੀਖ਼ ਅਤੇ ਸਮਾਂ

ਪ੍ਰਮਾਣਿਕਤਾ

ਟੋਕਨ-ਅਧਾਰਿਤ ਪ੍ਰਮਾਣੀਕਰਨ। ਲੌਗਇਨ ਇੱਕ ਟੋਕਨ ਵਾਪਸ ਕਰਦਾ ਹੈ ਜਿਸਨੂੰ ਅਧਿਕਾਰ ਵਜੋਂ ਭੇਜਿਆ ਜਾਣਾ ਚਾਹੀਦਾ ਹੈ: ਟੋਕਨ<token> ਸਾਰੀਆਂ ਅਗਲੀਆਂ ਬੇਨਤੀਆਂ 'ਤੇ।

POST/api/v1/loginਇੱਕ ਉਪਭੋਗਤਾ ਨੂੰ ਪ੍ਰਮਾਣਿਤ ਕਰੋ ਅਤੇ ਇੱਕ ਪ੍ਰਮਾਣੀਕਰਨ ਟੋਕਨ ਪ੍ਰਾਪਤ ਕਰੋ
POST/api/v1/login-deviceUUID ਅਤੇ MAC ਪਤੇ ਦੁਆਰਾ ਡਿਵਾਈਸ ਨੂੰ ਪ੍ਰਮਾਣਿਤ ਕਰੋ
POST/api/v1/logoutਮੌਜੂਦਾ ਸੈਸ਼ਨ ਟੋਕਨ ਨੂੰ ਅਵੈਧ ਕਰੋ

ਉਪਭੋਗਤਾ

ਉਪਭੋਗਤਾ ਖਾਤੇ ਬਣਾਓ ਅਤੇ ਪ੍ਰਬੰਧਿਤ ਕਰੋ। GET /users/user ਅੰਤਮ ਬਿੰਦੂ ਮੌਜੂਦਾ ਪ੍ਰਮਾਣਿਤ ਉਪਭੋਗਤਾ ਨੂੰ ਵਾਪਸ ਕਰਦਾ ਹੈ।

GET/api/v1/users/userਵਰਤਮਾਨ ਵਿੱਚ ਲੌਗ-ਇਨ ਕੀਤਾ ਉਪਭੋਗਤਾ ਪ੍ਰੋਫਾਈਲ ਪ੍ਰਾਪਤ ਕਰੋ
POST/api/v1/users/userਇੱਕ ਨਵਾਂ ਉਪਭੋਗਤਾ ਖਾਤਾ ਬਣਾਓ
PATCH/api/v1/users/user/{uuid}ਯੂਜ਼ਰ ਪ੍ਰੋਫਾਈਲ ਅੱਪਡੇਟ ਕਰੋ (ਜਿਵੇਂ ਕਿ ਪ੍ਰੋਫਾਈਲ ਚਿੱਤਰ)

ਡਿਵਾਈਸਾਂ

ਡਿਵਾਈਸਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ ਅਤੇ ਨਿਰੀਖਣ ਕਰੋ, ਉਪਭੋਗਤਾ-ਡਿਵਾਈਸ ਐਸੋਸੀਏਸ਼ਨਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰੋ, ਪ੍ਰਤੀ-ਡਿਵਾਈਸ ਸੈਟਿੰਗਾਂ ਅਤੇ ਸਥਿਤੀ ਪੜ੍ਹੋ ਅਤੇ ਲਿਖੋ, ਫਰਮਵੇਅਰ ਅਤੇ ਸਟੋਰੇਜ ਚਿੱਤਰਾਂ ਨੂੰ ਸੰਭਾਲੋ, ਅਤੇ ਲੌਗ ਅਤੇ ਕਰੈਸ਼ ਰਿਪੋਰਟਾਂ ਪ੍ਰਾਪਤ ਕਰੋ।

GET/api/v1/devices/deviceਸਾਰੇ ਡਿਵਾਈਸਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
GET/api/v1/devices/device/{uuid}ਫਰਮਵੇਅਰ ਅਤੇ ਸੈਟਿੰਗਾਂ ਸਮੇਤ ਵਿਸਤ੍ਰਿਤ ਡਿਵਾਈਸ ਜਾਣਕਾਰੀ ਪ੍ਰਾਪਤ ਕਰੋ
PUT/api/v1/devices/association/{uuid}ਇੱਕ ਉਪਭੋਗਤਾ ਅਤੇ ਇੱਕ ਡਿਵਾਈਸ ਵਿਚਕਾਰ ਸਬੰਧ ਨੂੰ ਅੱਪਡੇਟ ਕਰੋ
DELETE/api/v1/devices/association/{uuid}ਯੂਜ਼ਰ-ਡਿਵਾਈਸ ਐਸੋਸੀਏਸ਼ਨ ਅਤੇ ਸਟੋਰ ਕੀਤੀਆਂ ਸੈਟਿੰਗਾਂ ਨੂੰ ਹਟਾਓ
GET/api/v1/devices/device/{device_uuid}/settingsਕਿਸੇ ਡਿਵਾਈਸ ਲਈ ਸਟੋਰ ਕੀਤੀਆਂ ਸੈਟਿੰਗਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
POST/api/v1/devices/device/{device_uuid}/settingsਡਿਵਾਈਸ-ਵਿਸ਼ੇਸ਼ ਸੈਟਿੰਗਾਂ ਨੂੰ ਸੁਰੱਖਿਅਤ ਕਰੋ
GET/api/v1/devices/device/{device_uuid}/statusਡਿਵਾਈਸ ਸਥਿਤੀ ਪ੍ਰਾਪਤ ਕਰੋ (ਕਨੈਕਟੀਵਿਟੀ, ਬੈਟਰੀ, ਸੈਂਸਰ, ਆਡੀਓ ਸਥਿਤੀ)
POST/api/v1/devices/device/{device_uuid}/statusਡਿਵਾਈਸ ਤੋਂ ਡਿਵਾਈਸ ਸਥਿਤੀ ਪੋਸਟ ਕਰੋ
GET/api/v1/devices/device/{device_uuid}/contextਕਿਸੇ ਡਿਵਾਈਸ ਲਈ ਸਟੋਰ ਕੀਤੇ ਸੰਦਰਭ ਮੁੱਲਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
POST/api/v1/devices/device/{device_uuid}/ingest-contextਡਿਵਾਈਸ ਤੋਂ GPS + WiFi ਸੰਦਰਭ ਪ੍ਰਾਪਤ ਕਰੋ
GET/api/v1/devices/firmwareਦਿੱਤੇ ਗਏ ਹਾਰਡਵੇਅਰ/ਸਾਫਟਵੇਅਰ ਸੰਸਕਰਣ ਦੇ ਅਨੁਕੂਲ ਫਰਮਵੇਅਰ ਰੀਲੀਜ਼ਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
GET/api/v1/devices/firmware/{uuid}/{image_type}/fetchਟੁਕੜਿਆਂ ਵਿੱਚ ਇੱਕ ਫਰਮਵੇਅਰ ਚਿੱਤਰ ਪ੍ਰਾਪਤ ਕਰੋ
GET/api/v1/devices/languageਸਮਰਥਿਤ ਡਿਵਾਈਸ ਭਾਸ਼ਾਵਾਂ ਅਤੇ ਆਵਾਜ਼ਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
GET/api/v1/devices/storage_imageਕਿਸੇ ਲੋਕੇਲ ਲਈ ਅਨੁਕੂਲਿਤ ਡਿਵਾਈਸ ਸਟੋਰੇਜ ਚਿੱਤਰ ਡਾਊਨਲੋਡ ਕਰੋ
POST/api/v1/devices/logਕਿਸੇ ਡਿਵਾਈਸ ਤੋਂ ਇੱਕ ਲੌਗ ਫਾਈਲ ਪ੍ਰਾਪਤ ਕਰੋ
POST/api/v1/devices/crashਇੱਕ ਡਿਵਾਈਸ ਤੋਂ ਇੱਕ ਕੋਰ ਡੰਪ ਪ੍ਰਾਪਤ ਕਰੋ
PATCH/api/v1/devices/crash/{uuid}ਕਰੈਸ਼ ਰਿਕਾਰਡ ਅੱਪਡੇਟ ਕਰੋ

CBBP ਪ੍ਰੌਕਸੀ

ਸਰਵਰ ਰਾਹੀਂ ਕਿਸੇ ਵੀ ਡਿਵਾਈਸ ਨੂੰ ਕੋਈ ਵੀ CBBP ਕਮਾਂਡ ਭੇਜੋ। ਸਰਵਰ ਡਿਵਾਈਸ ਦੇ WiFi ਕਨੈਕਸ਼ਨ 'ਤੇ ਕਮਾਂਡ ਨੂੰ ਰੀਲੇਅ ਕਰਦਾ ਹੈ ਅਤੇ ਡਿਵਾਈਸ ਪ੍ਰਤੀਕਿਰਿਆ ਵਾਪਸ ਕਰਦਾ ਹੈ। ਆਊਟਗੋਇੰਗ-ਮੇਕ ਪ੍ਰਤੀਕਿਰਿਆ ਇੱਕ CBBPMessage ਨੂੰ ਵੀ ਏਮਬੇਡ ਕਰਦੀ ਹੈ ਜਿਸਨੂੰ ਡਿਵਾਈਸ ਤੁਰੰਤ ਲਾਗੂ ਕਰਦੀ ਹੈ।

POST/api/v1/devices/device/{device_uuid}/cbbpਸਰਵਰ ਰਾਹੀਂ ਇੱਕ ਡਿਵਾਈਸ ਨੂੰ CBBP ਕਮਾਂਡ ਭੇਜੋ
GET/api/v1/devices/device/{device_uuid}/cbbp/{uuid}ਪਹਿਲਾਂ ਭੇਜੀ ਗਈ CBBP ਕਮਾਂਡ ਦੀ ਸਥਿਤੀ ਅਤੇ ਜਵਾਬ ਪ੍ਰਾਪਤ ਕਰੋ

ਬੇਨਤੀ ਬਾਡੀ ਇੱਕ CBBP ਕਮਾਂਡ ਲਿਫਾਫਾ ਹੈ। ਸਟੋਰ ਕੀਤਾ CBBPCommand ਆਬਜੈਕਟ ਡਿਲੀਵਰੀ ਸਥਿਤੀ ਨੂੰ ਟਰੈਕ ਕਰਦਾ ਹੈ: UNSET → SENT → RECEIVED ਜਾਂ TIMED_OUT।

ਇਹ ਜਾਂਚਣ ਲਈ ਕਿ ਕੀ ਡਿਵਾਈਸ ਨੇ ਕਮਾਂਡ ਪ੍ਰਾਪਤ ਕੀਤੀ ਅਤੇ ਉਸਦਾ ਜਵਾਬ ਦਿੱਤਾ, GET /cbbp/ ਪੋਲ ਕਰੋ।
ਬੇਨਤੀ — outgoingMessage
{
  "outgoingMessage": {
    "command": "WiFiScan"
  }
}
ਜਵਾਬ — CBBPਕਮਾਂਡ ਸਥਿਤੀ
{
  "uuid": "a3f2...",
  "status": "SENT",
  "device": "d7f3a1b2-...",
  "dateSent": "2025-09-15T14:22:01Z",
  "outgoingMessage": { /* echoed */ },
  "incomingMessage": null
}

ਚੈਨਲ

ਚੈਨਲ ਮੁੱਖ ਸੰਚਾਰ ਪ੍ਰਾਈਮਿਟਿਵ ਹਨ। ਕਿਸਮਾਂ ਵਿੱਚ ਚੈਨਲਪੀਪਲ, ਚੈਨਲਗਰੁੱਪ, ਚੈਨਲਕੰਟੈਕਟ, ਚੈਨਲਕੰਟੈਕਟਨੰਬਰ, ਚੈਨਲਐਕਸਟਰਨਲਨੰਬਰ, ਚੈਨਲਸਰਵਿਸ, ਅਤੇ ਚੈਨਲਰਿਕਾਰਡਰ ਸ਼ਾਮਲ ਹਨ।

GET/api/v1/channels/channelਚੈਨਲਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ, ਵਿਕਲਪਿਕ ਤੌਰ 'ਤੇ object_type ਦੁਆਰਾ ਫਿਲਟਰ ਕੀਤਾ ਗਿਆ
POST/api/v1/channels/channelਇੱਕ ਚੈਨਲ ਬਣਾਓ (ਚੈਨਲਗਰੁੱਪ, ਚੈਨਲਕੰਟੈਕਟ, ਜਾਂ ਚੈਨਲਐਕਸਟਰਨਲਨੰਬਰ)
PATCH/api/v1/channels/channel/{uuid}ਚੈਨਲਗਰੁੱਪ ਜਾਂ ਚੈਨਲਸੰਪਰਕ ਅੱਪਡੇਟ ਕਰੋ
DELETE/api/v1/channels/channel/{uuid}ਇੱਕ ਚੈਨਲ ਮਿਟਾਓ
DELETE/api/v1/channels/{uuid}ਇੱਕ ਚੈਨਲ ਸਮੂਹ ਮਿਟਾਓ
DELETE/api/v1/channels/by-type/{channelType}ਦਿੱਤੇ ਗਏ ਕਿਸਮ ਦੇ ਸਾਰੇ ਚੈਨਲ ਮਿਟਾਓ (ਵਰਤਮਾਨ ਵਿੱਚ ChannelContact)
GET/api/v1/channels/associationਮੌਜੂਦਾ ਉਪਭੋਗਤਾ ਲਈ ਚੈਨਲ ਐਸੋਸੀਏਸ਼ਨਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
POST/api/v1/channels/associationਕਿਸੇ ਚੈਨਲ ਨਾਲ ਸਬੰਧ ਦੀ ਬੇਨਤੀ ਕਰੋ
PATCH/api/v1/channels/association/{uuid}ਐਸੋਸੀਏਸ਼ਨ ਸੈਟਿੰਗਾਂ ਨੂੰ ਸਵੀਕਾਰ ਕਰੋ, ਅਸਵੀਕਾਰ ਕਰੋ, ਜਾਂ ਅੱਪਡੇਟ ਕਰੋ
DELETE/api/v1/channels/association/{uuid}ਕਿਸੇ ਚੈਨਲ ਨਾਲ ਸਬੰਧ ਹਟਾਓ
GET/api/v1/channels/historyਮੌਜੂਦਾ ਉਪਭੋਗਤਾ ਲਈ ਪੰਨਾਬੱਧ ਚੈਨਲ ਪਹੁੰਚ ਇਤਿਹਾਸ ਪ੍ਰਾਪਤ ਕਰੋ
POST/api/v1/channels/historyਚੈਨਲ ਇਤਿਹਾਸ ਐਂਟਰੀ ਬਣਾਓ
GET/api/v1/channels/searchਪੁੱਛਗਿੱਛ ਸਤਰ ਅਤੇ ਵਿਕਲਪਿਕ ਕਿਸਮ ਫਿਲਟਰ ਦੁਆਰਾ ਚੈਨਲ ਖੋਜੋ

ਸੰਚਾਰ

ਸਰਗਰਮ ਸੰਚਾਰ ਸੈਸ਼ਨ ਸ਼ੁਰੂ ਕਰੋ ਅਤੇ ਪ੍ਰਬੰਧਿਤ ਕਰੋ — ਆਊਟਗੋਇੰਗ ਕਾਲਾਂ, VCP, ਰਿਕਾਰਡਿੰਗ, ਅਤੇ ਸਮੱਗਰੀ ਸਟ੍ਰੀਮਿੰਗ। ਆਊਟਗੋਇੰਗ-ਮੇਕ ਰਿਸਪਾਂਸ ਵਿੱਚ ਇੱਕ CBBPMessage ਸ਼ਾਮਲ ਹੁੰਦਾ ਹੈ ਜਿਸ 'ਤੇ ਡਿਵਾਈਸ ਤੁਰੰਤ ਕੰਮ ਕਰਦੀ ਹੈ।

POST/api/v1/communicate/outgoing-makeਇੱਕ ਚੈਨਲਪੀਪਲ, ਚੈਨਲਗਰੁੱਪ, ਚੈਨਲਕੰਟੈਕਟ, ਜਾਂ ਚੈਨਲਕੰਟੈਕਟਨੰਬਰ ਵਿੱਚ ਇੱਕ ਆਊਟਗੋਇੰਗ ਚੈਨਲ ਸ਼ੁਰੂ ਕਰੋ
POST/api/v1/communicate/incoming-acceptanceਆਉਣ ਵਾਲੀ ਚੈਨਲ ਜੁਆਇਨ ਬੇਨਤੀ ਨੂੰ ਸਵੀਕਾਰ ਜਾਂ ਅਸਵੀਕਾਰ ਕਰੋ
POST/api/v1/communicate/closeਕਿਸੇ ਡਿਵਾਈਸ 'ਤੇ ਮੌਜੂਦਾ ਕਿਰਿਆਸ਼ੀਲ ਸੰਚਾਰ ਚੈਨਲ ਨੂੰ ਬੰਦ ਕਰੋ
POST/api/v1/communicate/vcp-activateਸਰਵਰ ਅਤੇ ਡਿਵਾਈਸ 'ਤੇ ਵੌਇਸ ਕਮਿਊਨੀਕੇਸ਼ਨ ਪ੍ਰੋਟੋਕੋਲ (VCP) ਸ਼ੁਰੂ ਕਰੋ
POST/api/v1/communicate/vcp-deactivateVCP ਨੂੰ ਅਕਿਰਿਆਸ਼ੀਲ ਕਰੋ, ਕਿਸੇ ਵੀ ਪਿਛਲੇ ਚੈਨਲ 'ਤੇ ਵਾਪਸ ਜਾਓ
POST/api/v1/communicate/recording-activateਸਰਵਰ ਅਤੇ ਡਿਵਾਈਸ 'ਤੇ ਰਿਕਾਰਡਿੰਗ ਮੋਡ ਨੂੰ ਸਰਗਰਮ ਕਰੋ
POST/api/v1/communicate/content-startਆਡੀਓ ਸਮੱਗਰੀ ਲਈ ਇੱਕ ਸਟ੍ਰੀਮਿੰਗ ਚੈਨਲ ਖੋਲ੍ਹੋ
POST/api/v1/communicate/request-vocalizationਦਿੱਤੇ ਗਏ ਟੈਕਸਟ ਲਈ TTS ਆਡੀਓ ਤਿਆਰ ਕਰੋ, ਵਿਕਲਪਿਕ ਤੌਰ 'ਤੇ ਇਸਦਾ ਅਨੁਵਾਦ ਕਰੋ

ਆਡੀਓ ਬ੍ਰਿਜ

ਪੂਰੀਆਂ ਟ੍ਰਾਂਸਕ੍ਰਿਪਟਾਂ, ਭਾਗੀਦਾਰਾਂ ਦੀਆਂ ਸੂਚੀਆਂ, ਅਤੇ AI-ਤਿਆਰ ਕੀਤੇ ਸਾਰਾਂਸ਼ਾਂ ਸਮੇਤ ਰਿਕਾਰਡ ਕੀਤੇ ਬ੍ਰਿਜ ਗੱਲਬਾਤਾਂ ਤੱਕ ਪਹੁੰਚ ਕਰੋ। ਸਾਰਾਂਸ਼ਾਂ ਲਈ ਕਈ ਸਾਰਾਂਸ਼ ਟੈਂਪਲੇਟਾਂ (ਮੀਟਿੰਗ ਨੋਟਸ, ਕਲਾਸ ਨੋਟਸ, ਸਿਹਤ ਸੰਭਾਲ, ਆਦਿ) ਅਤੇ TTS ਆਡੀਓ ਜਨਰੇਸ਼ਨ ਦਾ ਸਮਰਥਨ ਕਰਦਾ ਹੈ।

GET/api/v1/bridge/conversationsਸਾਰੀਆਂ ਬ੍ਰਿਜ ਗੱਲਬਾਤਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
GET/api/v1/bridge/conversations/{uuid}ਟ੍ਰਾਂਸਕ੍ਰਿਪਟ, ਭਾਗੀਦਾਰ ਅਤੇ ਸੰਖੇਪ ਸਮੇਤ ਇੱਕ ਵਿਸਤ੍ਰਿਤ ਗੱਲਬਾਤ ਪ੍ਰਾਪਤ ਕਰੋ
POST/api/v1/bridge/conversations/{conversation_uuid}/summaryਗੱਲਬਾਤ ਲਈ ਇੱਕ AI ਸੰਖੇਪ ਤਿਆਰ ਕਰੋ
POST/api/v1/bridge/conversations/{conversation_uuid}/summary/{summary_uuid}/audioਗੱਲਬਾਤ ਦੇ ਸਾਰਾਂਸ਼ ਲਈ ਆਡੀਓ ਤਿਆਰ ਕਰੋ

ਗੱਲਬਾਤ

ਚੈਟਜੀਪੀਟੀ, ਜੇਮਿਨੀ, ਜਾਂ ਨੇਟਿਵ ਇੰਜਣ ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹੋਏ ਏਆਈ-ਸੰਚਾਲਿਤ ਗੱਲਬਾਤ ਸੈਸ਼ਨ। ਕਈ ਵਿਅਕਤੀਆਂ (ਡਾਕਟਰ, ਟਿਊਟਰ, ਮਕੈਨਿਕ, ਆਦਿ) ਅਤੇ ਪੰਨੇਬੱਧ ਸੰਦੇਸ਼ ਇਤਿਹਾਸ ਦਾ ਸਮਰਥਨ ਕਰਦਾ ਹੈ।

GET/api/v1/conversations/conversationAI ਜਨਰੇਟਰ ਸੈਸ਼ਨਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ, ਜੋ ਕਿ ਵਿਅਕਤੀ ਅਤੇ ਟੂਲ ਦੁਆਰਾ ਫਿਲਟਰ ਕੀਤੇ ਜਾ ਸਕਦੇ ਹਨ।
POST/api/v1/conversations/conversationਇੱਕ ਨਵਾਂ AI ਗੱਲਬਾਤ ਸੈਸ਼ਨ ਬਣਾਓ
GET/api/v1/conversations/conversation/{uuid}ਵਿਕਲਪਿਕ ਸਾਰਾਂਸ਼/ਦੂਰ ਅੱਪਡੇਟ ਦੇ ਨਾਲ ਇੱਕ ਗੱਲਬਾਤ ਸੈਸ਼ਨ ਪ੍ਰਾਪਤ ਕਰੋ
DELETE/api/v1/conversations/conversation/{uuid}ਗੱਲਬਾਤ ਸੈਸ਼ਨ ਮਿਟਾਓ
GET/api/v1/conversations/conversation/{uuid}/messagesਗੱਲਬਾਤ ਵਿੱਚ ਸੁਨੇਹਿਆਂ ਦੀ ਸੂਚੀ ਬਣਾਓ
POST/api/v1/conversations/conversation/{uuid}/messagesਇੱਕ ਉਪਭੋਗਤਾ ਸੁਨੇਹਾ ਸ਼ਾਮਲ ਕਰੋ ਅਤੇ ਇੱਕ AI ਜਵਾਬ ਪ੍ਰਾਪਤ ਕਰੋ

ਸਮੱਗਰੀ

ਡਿਵਾਈਸਾਂ 'ਤੇ ਸਟ੍ਰੀਮਿੰਗ ਆਡੀਓ ਸਮੱਗਰੀ ਨੂੰ ਬ੍ਰਾਊਜ਼ ਕਰੋ ਅਤੇ ਚਲਾਓ। ਸਮੱਗਰੀ ਨੂੰ ਇੱਕ ਸ਼੍ਰੇਣੀ ਟ੍ਰੀ ਵਿੱਚ ਵਿਵਸਥਿਤ ਕੀਤਾ ਜਾਂਦਾ ਹੈ; ਪ੍ਰਸਿੱਧ ਸਮੱਗਰੀ ਨੂੰ ਸ਼ਹਿਰ, ਖੇਤਰ ਜਾਂ ਦੇਸ਼ ਦੁਆਰਾ ਫਿਲਟਰ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ।

GET/api/v1/content/categoriesਸਮੱਗਰੀ ਸ਼੍ਰੇਣੀਆਂ ਦਾ ਇੱਕ ਰੁੱਖ ਪ੍ਰਾਪਤ ਕਰੋ
GET/api/v1/content/contentਕਿਸੇ ਸ਼੍ਰੇਣੀ ਦੇ ਅੰਦਰ ਉਪਲਬਧ ਸਮੱਗਰੀ ਦੀ ਸੂਚੀ ਬਣਾਓ
GET/api/v1/content/popularਕਿਸੇ ਦਿੱਤੇ ਗਏ ਸ਼ਹਿਰ, ਖੇਤਰ ਜਾਂ ਦੇਸ਼ ਲਈ ਪ੍ਰਸਿੱਧ ਸਮੱਗਰੀ ਦੀ ਸੂਚੀ ਬਣਾਓ

ਸਥਾਨ

ਭੂਗੋਲਿਕ ਨਿਰਦੇਸ਼ਾਂਕਾਂ ਨੂੰ ਇੱਕ ਢਾਂਚਾਗਤ ਸ਼ਹਿਰ, ਖੇਤਰ ਅਤੇ ਦੇਸ਼ ਦੇ ਵਸਤੂ ਲਈ ਹੱਲ ਕਰੋ। ਸੰਦਰਭ ਨੂੰ ਗ੍ਰਹਿਣ ਕਰਦੇ ਸਮੇਂ ਡਿਵਾਈਸਾਂ ਦੁਆਰਾ ਵਰਤਿਆ ਜਾਂਦਾ ਹੈ।

POST/api/v1/location/determineਸ਼ਹਿਰ, ਖੇਤਰ ਅਤੇ ਦੇਸ਼ ਲਈ ਇੱਕ ਅਕਸ਼ਾਂਸ਼/ਰੇਖਾਂਸ਼ ਹੱਲ ਕਰੋ

ਪੁਸ਼ ਸੂਚਨਾਵਾਂ

FCM ਪੁਸ਼ ਸੂਚਨਾਵਾਂ ਪ੍ਰਾਪਤ ਕਰਨ ਲਈ ਇੱਕ ਮੋਬਾਈਲ ਐਪ ਰਜਿਸਟਰ ਕਰੋ। iOS, Android, ਅਤੇ ਵੈੱਬ ਟਾਰਗੇਟਾਂ ਦਾ ਸਮਰਥਨ ਕਰਦਾ ਹੈ।

POST/api/v1/push-notifications/pushFCM ਪੁਸ਼ ਸੂਚਨਾਵਾਂ (iOS, Android, ਵੈੱਬ) ਲਈ ਇੱਕ ਮੋਬਾਈਲ ਐਪ ਰਜਿਸਟਰ ਕਰੋ।

ਸਟੋਰੇਜ

ਮਾਡਲ ਵਸਤੂਆਂ 'ਤੇ ਸਟੋਰ ਕੀਤੀਆਂ ਫਾਈਲਾਂ ਡਾਊਨਲੋਡ ਕਰੋ, ਅਤੇ ਚਿੱਤਰ ਬੈਕਗ੍ਰਾਊਂਡ ਹਟਾਉਣ ਨੂੰ ਚਲਾਓ (base64-ਏਨਕੋਡਡ ਨਤੀਜਾ ਵਾਪਸ ਕਰਦਾ ਹੈ)।

GET/api/v1/storage/retrieve/{path}ਮਾਰਗ ਦੁਆਰਾ ਇੱਕ ਸਟੋਰ ਕੀਤੀ ਫਾਈਲ ਡਾਊਨਲੋਡ ਕਰੋ
POST/api/v1/storage/remove-backgroundਇੱਕ ਚਿੱਤਰ ਤੋਂ ਪਿਛੋਕੜ ਹਟਾਓ (base64 ਵਾਪਸ ਕਰਦਾ ਹੈ)

ਥੋਕ ਕਾਰਜ

ਇੱਕ ਸਿੰਗਲ HTTP ਬੇਨਤੀ ਵਿੱਚ ਕਈ API ਓਪਰੇਸ਼ਨ ਚਲਾਓ। ਸਾਰੇ ਓਪਰੇਸ਼ਨਾਂ ਨੂੰ ਇੱਕ ਐਟਮੀ ਟ੍ਰਾਂਜੈਕਸ਼ਨ ਵਿੱਚ ਸਮੇਟਣ ਲਈ single_transaction=true ਪਾਸ ਕਰੋ — ਕਿਸੇ ਵੀ ਆਈਟਮ 'ਤੇ ਅਸਫਲਤਾ ਪੂਰੇ ਬੈਚ ਨੂੰ ਰੋਲ ਬੈਕ ਕਰਦੀ ਹੈ।

POST/api/v1/bulkਇੱਕ ਸਿੰਗਲ ਬੇਨਤੀ ਵਿੱਚ ਕਈ API ਓਪਰੇਸ਼ਨ ਚਲਾਓ, ਵਿਕਲਪਿਕ ਤੌਰ 'ਤੇ ਇੱਕ ਸਿੰਗਲ ਐਟਮਿਕ ਟ੍ਰਾਂਜੈਕਸ਼ਨ ਦੇ ਤੌਰ 'ਤੇ

ਤਾਰੀਖ਼ ਅਤੇ ਸਮਾਂ

ਮੌਜੂਦਾ ਸਰਵਰ ਮਿਤੀ ਅਤੇ ਸਮਾਂ GMT+0 ਵਿੱਚ ਵਾਪਸ ਕਰਦਾ ਹੈ। ਪ੍ਰਮਾਣੀਕਰਨ ਦੀ ਲੋੜ ਨਹੀਂ ਹੈ। ਡਿਵਾਈਸਾਂ ਦੁਆਰਾ ਆਪਣੀ ਅੰਦਰੂਨੀ ਘੜੀ ਨੂੰ ਸਿੰਕ ਕਰਨ ਲਈ ਵਰਤਿਆ ਜਾਂਦਾ ਹੈ।

GET/api/v1/current-datetimeਮੌਜੂਦਾ ਮਿਤੀ ਅਤੇ ਸਮਾਂ GMT+0 ਵਿੱਚ ਵਾਪਸ ਕਰੋ
ਸੀਬੀਬੀਪੀ ਪ੍ਰੋਟੋਕੋਲ

ਕਾਮ ਬੈਜ ਬੇਸਿਕ ਪ੍ਰੋਟੋਕੋਲ

CBBP ਕਨੈਕਸ਼ਨ ਬੈਜਾਂ ਨਾਲ ਸਿੱਧੇ ਸੰਪਰਕ ਲਈ ਇੱਕ ਹਲਕਾ JSON ਕਮਾਂਡ ਪ੍ਰੋਟੋਕੋਲ ਹੈ। ਇਹ ਤੁਹਾਨੂੰ ਡਿਵਾਈਸ ਦੇ ਹਰ ਹਾਰਡਵੇਅਰ ਅਤੇ ਸਾਫਟਵੇਅਰ ਫੰਕਸ਼ਨ 'ਤੇ ਪੂਰਾ ਨਿਯੰਤਰਣ ਦਿੰਦਾ ਹੈ।

ਸੁਨੇਹਾ ਫਾਰਮੈਟ

ਹਰੇਕ CBBP ਇੰਟਰੈਕਸ਼ਨ ਵਿੱਚ ਡਿਵਾਈਸ ਨੂੰ ਭੇਜਿਆ ਗਿਆ ਇੱਕ ਕਮਾਂਡ ਸੁਨੇਹਾ ਅਤੇ ਡਿਵਾਈਸ ਦੁਆਰਾ ਵਾਪਸ ਕੀਤਾ ਗਿਆ ਇੱਕ ਨਤੀਜਾ ਸੁਨੇਹਾ ਹੁੰਦਾ ਹੈ।

ਬੇਨਤੀ ਅਤੇ ਜਵਾਬ ਦੋਵਾਂ ਵਿੱਚ ਆਬਜੈਕਟ ਫੀਲਡ ਕਮਾਂਡ-ਵਿਸ਼ੇਸ਼ ਡੇਟਾ ਰੱਖਦਾ ਹੈ ਅਤੇ ਲੋੜ ਨਾ ਪੈਣ 'ਤੇ ਇਸਨੂੰ ਛੱਡਿਆ ਜਾ ਸਕਦਾ ਹੈ।

ਰਜਿਸਟਰਡ ਭਾਈਵਾਲਾਂ ਲਈ ਪੂਰਾ ਪ੍ਰੋਟੋਕੋਲ ਦਸਤਾਵੇਜ਼ ਉਪਲਬਧ ਹੈ। ਆਪਣੇ ਕਨੈਕਸ਼ਨ ਕਾਰੋਬਾਰ ਪ੍ਰਤੀਨਿਧੀ ਨਾਲ ਸੰਪਰਕ ਕਰੋ ਜਾਂ ਸੰਪਰਕ ਕਰੋ developer@connectionbadge.com ਪੂਰੇ CBBP ਕਮਾਂਡ ਸੰਦਰਭ ਤੱਕ ਪਹੁੰਚ ਦੀ ਬੇਨਤੀ ਕਰਨ ਲਈ, ਜਿਸ ਵਿੱਚ ਪੂਰੀ ਬੇਨਤੀ/ਜਵਾਬ ਸਕੀਮਾ, ਗਲਤੀ ਕੋਡ, ਅਤੇ ਏਕੀਕਰਣ ਗਾਈਡ ਸ਼ਾਮਲ ਹਨ।
ਹੁਕਮ ਸੁਨੇਹਾ
{
  "command": "command_name",
  "object": {
    // optional command parameters
  }
}
ਨਤੀਜਾ ਸੁਨੇਹਾ
{
  "result": 0,          // 0 = success, -1 = error
  "detail": "ok",      // human-readable status
  "object": {          // optional response data
    // command-specific fields
  }
}

ਆਵਾਜਾਈ

ਤੁਹਾਡੇ ਏਕੀਕਰਨ ਆਰਕੀਟੈਕਚਰ ਦੇ ਆਧਾਰ 'ਤੇ, CBBP ਸੁਨੇਹੇ ਤਿੰਨ ਵੱਖ-ਵੱਖ ਟ੍ਰਾਂਸਪੋਰਟਾਂ ਰਾਹੀਂ ਇੱਕ ਬੈਜ ਤੱਕ ਪਹੁੰਚਾਏ ਜਾ ਸਕਦੇ ਹਨ।

ਬਲੂਟੁੱਥ (ਐਪ)

BLE ਰਾਹੀਂ ਮੋਬਾਈਲ ਐਪ ਤੋਂ ਸਿੱਧੇ CBBP ਕਮਾਂਡਾਂ ਭੇਜੋ। ਡਿਵਾਈਸ ਨੂੰ ਪੇਅਰ ਕੀਤਾ ਜਾਣਾ ਅਤੇ ਰੇਂਜ ਦੇ ਅੰਦਰ ਹੋਣਾ ਜ਼ਰੂਰੀ ਹੈ।

ਮੋਬਾਈਲ SDK

ਸਰਵਰ ਰਾਹੀਂ ਵਾਈਫਾਈ ਜਾਂ ਬਲੂਟੁੱਥ

REST API — POST /devices//cbbp ਰਾਹੀਂ ਪ੍ਰੌਕਸੀ CBBP। ਸਰਵਰ ਆਪਣੇ ਆਪ ਹੀ WiFi ਜਾਂ ਬਲੂਟੁੱਥ ਰਾਹੀਂ ਡਿਵਾਈਸ ਨੂੰ ਰੂਟ ਕਰਦਾ ਹੈ, ਇਹ ਇਸ ਗੱਲ 'ਤੇ ਨਿਰਭਰ ਕਰਦਾ ਹੈ ਕਿ ਬੈਜ ਕਿਵੇਂ ਜੁੜਿਆ ਹੋਇਆ ਹੈ। ਬੈਕਐਂਡ ਏਕੀਕਰਨ ਲਈ ਸਭ ਤੋਂ ਆਮ।

ਆਰਾਮ API

ਅੰਦਰੂਨੀ ਡਿਸਪੈਚ

ਡਿਵਾਈਸ 'ਤੇ ਜਾਂ ਇੰਟਰ-ਪ੍ਰੋਸੈਸ CBBP ਡਿਸਪੈਚ। ਬੈਜ ਫਰਮਵੇਅਰ ਦੁਆਰਾ ਅੰਦਰੂਨੀ ਸਬ-ਸਿਸਟਮਾਂ ਵਿਚਕਾਰ ਕਮਾਂਡਾਂ ਨੂੰ ਰੂਟ ਕਰਨ ਲਈ ਵਰਤਿਆ ਜਾਂਦਾ ਹੈ।

ਸਿਰਫ਼ ਫਰਮਵੇਅਰ

ਪਾਵਰ ਕਮਾਂਡਾਂ

ਡਿਵਾਈਸ ਪਾਵਰ ਸਥਿਤੀ ਨੂੰ ਕੰਟਰੋਲ ਕਰੋ — ਸਲੀਪ, ਵੇਕ, ਰੀਬੂਟ, ਅਤੇ ਫੈਕਟਰੀ ਰੀਸੈਟ।

PowerRebootਡਿਵਾਈਸ ਨੂੰ ਤੁਰੰਤ ਰੀਬੂਟ ਕਰੋ।
PowerDeepsleepਡੂੰਘੀ ਨੀਂਦ (ਘੱਟ-ਪਾਵਰ) ਮੋਡ ਵਿੱਚ ਦਾਖਲ ਹੋਵੋ।
FactoryResetਸਾਰੀ ਸੰਰਚਨਾ ਮਿਟਾਓ ਅਤੇ ਫੈਕਟਰੀ ਡਿਫੌਲਟ ਤੇ ਰੀਸੈਟ ਕਰੋ।

ਵਾਈਫਾਈ ਕਮਾਂਡਾਂ

ਵਾਇਰਲੈੱਸ ਨੈੱਟਵਰਕਾਂ ਨੂੰ ਕੌਂਫਿਗਰ ਕਰੋ, APs ਲਈ ਸਕੈਨ ਕਰੋ, ਕਨੈਕਸ਼ਨ ਸਥਿਤੀ ਦੀ ਜਾਂਚ ਕਰੋ, ਅਤੇ ਸੁਰੱਖਿਅਤ ਕੀਤੇ ਪ੍ਰਮਾਣ ਪੱਤਰਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰੋ।

WiFiScanਉਪਲਬਧ WiFi ਐਕਸੈਸ ਪੁਆਇੰਟਾਂ ਲਈ ਸਕੈਨ ਕਰੋ।
WiFiAPTestਕਿਸੇ ਖਾਸ WiFi ਐਕਸੈਸ ਪੁਆਇੰਟ ਨਾਲ ਕਨੈਕਟੀਵਿਟੀ ਦੀ ਜਾਂਚ ਕਰੋ।
WiFiAPJoinਦਿੱਤੇ ਗਏ ਪ੍ਰਮਾਣ ਪੱਤਰਾਂ ਨਾਲ ਇੱਕ WiFi ਐਕਸੈਸ ਪੁਆਇੰਟ ਵਿੱਚ ਸ਼ਾਮਲ ਹੋਵੋ।

ਬਲੂਟੁੱਥ ਕਮਾਂਡਾਂ

BLE ਇਸ਼ਤਿਹਾਰਬਾਜ਼ੀ, ਜੋੜੀ ਬਣਾਉਣ, ਅਤੇ ਬੈਜ-ਟੂ-ਬੈਜ ਸੰਚਾਰ ਨੂੰ ਕੰਟਰੋਲ ਕਰੋ।

BTScanBTਕਲਾਸਿਕ ਬਲੂਟੁੱਥ ਡਿਵਾਈਸਾਂ ਲਈ ਸਕੈਨ ਕਰੋ।
BTScanBLEBLE ਡਿਵਾਈਸਾਂ ਲਈ ਸਕੈਨ ਕਰੋ।
DeviceBLEServiceAvailableBLE ਸੇਵਾ ਨੂੰ ਉਪਲਬਧ ਵਜੋਂ ਚਿੰਨ੍ਹਿਤ ਕਰੋ।
DeviceBLEServiceUnavailableBLE ਸੇਵਾ ਨੂੰ ਅਣਉਪਲਬਧ ਵਜੋਂ ਚਿੰਨ੍ਹਿਤ ਕਰੋ।
DeviceBLEActiveBLE ਰੇਡੀਓ ਨੂੰ ਕਿਰਿਆਸ਼ੀਲ ਸਥਿਤੀ 'ਤੇ ਸੈੱਟ ਕਰੋ।
DeviceBLEIdleBLE ਰੇਡੀਓ ਨੂੰ ਨਿਸ਼ਕਿਰਿਆ ਸਥਿਤੀ 'ਤੇ ਸੈੱਟ ਕਰੋ।
DeviceBLEAdvChannelAddBLE ਇਸ਼ਤਿਹਾਰਬਾਜ਼ੀ ਪੇਲੋਡ ਵਿੱਚ ਇੱਕ ਚੈਨਲ ਸ਼ਾਮਲ ਕਰੋ।
DeviceBTScanਬਲੂਟੁੱਥ ਡਿਵਾਈਸ ਸਕੈਨ ਸ਼ੁਰੂ ਕਰੋ।
DeviceBTA2DStartਬਲੂਟੁੱਥ A2DP ਆਡੀਓ ਸਟ੍ਰੀਮਿੰਗ ਸ਼ੁਰੂ ਕਰੋ।
DeviceBTA2DEndਬਲੂਟੁੱਥ A2DP ਆਡੀਓ ਸਟ੍ਰੀਮਿੰਗ ਬੰਦ ਕਰੋ।
DeviceBTNativeAssistStartਮੂਲ ਬਲੂਟੁੱਥ ਵੌਇਸ ਅਸਿਸਟੈਂਟ ਸ਼ੁਰੂ ਕਰੋ।
DeviceBTNativeAssistEndਮੂਲ ਬਲੂਟੁੱਥ ਵੌਇਸ ਅਸਿਸਟੈਂਟ ਨੂੰ ਖਤਮ ਕਰੋ।

ਸੈਟਿੰਗਾਂ ਕਮਾਂਡਾਂ

ਡਿਵਾਈਸ ਕੌਂਫਿਗਰੇਸ਼ਨ ਪੜ੍ਹੋ ਅਤੇ ਲਿਖੋ — ਡਿਸਪਲੇ ਨਾਮ, ਸਮਾਂ ਖੇਤਰ, ਭਾਸ਼ਾ, ਅਤੇ ਵਿਸ਼ੇਸ਼ਤਾ ਝੰਡੇ।

SettingsListGetਸਾਰੀਆਂ ਸੈਟਿੰਗਾਂ ਨੂੰ ਇੱਕ ਕੁੰਜੀ-ਮੁੱਲ ਸੂਚੀ ਦੇ ਰੂਪ ਵਿੱਚ ਪ੍ਰਾਪਤ ਕਰੋ।
SettingsListSetਇੱਕੋ ਸਮੇਂ ਕਈ ਸੈਟਿੰਗਾਂ ਮੁੱਲ ਲਿਖੋ।
SettingsGetਕੁੰਜੀ ਦੁਆਰਾ ਇੱਕ ਸਿੰਗਲ ਸੈਟਿੰਗ ਦਾ ਮੁੱਲ ਪ੍ਰਾਪਤ ਕਰੋ।
SettingsSetਇੱਕ ਸਿੰਗਲ ਸੈਟਿੰਗ ਦਾ ਮੁੱਲ ਸੈੱਟ ਕਰੋ।
SettingsSendਮੌਜੂਦਾ ਸੈਟਿੰਗਾਂ ਨੂੰ ਸਰਵਰ ਤੇ ਧੱਕੋ।
SettingsClearਖਾਸ ਸੈਟਿੰਗ ਮੁੱਲ ਸਾਫ਼ ਕਰੋ।
SettingsEraseਸਾਰੀਆਂ ਸਟੋਰ ਕੀਤੀਆਂ ਸੈਟਿੰਗਾਂ ਮਿਟਾਓ।

ਫਰਮਵੇਅਰ ਕਮਾਂਡਾਂ

OTA ਫਰਮਵੇਅਰ ਅੱਪਡੇਟ ਚਾਲੂ ਕਰੋ, ਅੱਪਡੇਟ ਸਥਿਤੀ ਦੀ ਜਾਂਚ ਕਰੋ, ਅਤੇ ਡਿਵਾਈਸ 'ਤੇ ਮੌਜੂਦਾ ਫਰਮਵੇਅਰ ਸੰਸਕਰਣ ਦੀ ਪੁੱਛਗਿੱਛ ਕਰੋ।

FirmwareCheckਜਾਂਚ ਕਰੋ ਕਿ ਕੀ ਕੋਈ ਫਰਮਵੇਅਰ ਅੱਪਡੇਟ ਉਪਲਬਧ ਹੈ।
FirmwareUpdateਇੱਕ OTA ਫਰਮਵੇਅਰ ਅੱਪਡੇਟ ਸ਼ੁਰੂ ਕਰੋ।
FirmwareValidateਡਾਊਨਲੋਡ ਕੀਤੇ ਫਰਮਵੇਅਰ ਚਿੱਤਰ ਦੀ ਇਕਸਾਰਤਾ ਦੀ ਪੁਸ਼ਟੀ ਕਰੋ।

ਡਿਵਾਈਸ ਕਮਾਂਡਾਂ

ਡਿਵਾਈਸ ਲਾਈਫਸਾਈਕਲ, ਪ੍ਰਮਾਣੀਕਰਨ, ਕੌਂਫਿਗਰੇਸ਼ਨ, ਲੌਗਿੰਗ, ਸਥਿਤੀ, ਅਤੇ ਹਾਰਡਵੇਅਰ ਕੰਟਰੋਲ।

NoOpਕੋਈ ਕਾਰਵਾਈ ਨਹੀਂ / ਜ਼ਿੰਦਾ ਰੱਖੋ।
Testਮੁੱਢਲੀ ਕਨੈਕਟੀਵਿਟੀ ਟੈਸਟ।
DeviceDateTimeਡਿਵਾਈਸ ਦੀ ਮਿਤੀ ਅਤੇ ਸਮਾਂ ਪ੍ਰਾਪਤ ਕਰੋ ਜਾਂ ਸੈੱਟ ਕਰੋ।
DeviceAuthenticateਸਰਵਰ ਨਾਲ ਡਿਵਾਈਸ ਨੂੰ ਪ੍ਰਮਾਣਿਤ ਕਰੋ।
DeviceConfigureਡਿਵਾਈਸ ਤੇ ਇੱਕ ਕੌਂਫਿਗਰੇਸ਼ਨ ਪੇਲੋਡ ਲਾਗੂ ਕਰੋ।
DevicePostConnectionTasksਪੋਸਟ-ਕਨੈਕਸ਼ਨ ਸ਼ੁਰੂਆਤੀ ਕਾਰਜ ਚਲਾਓ।
DeviceStorageLoadਡਿਵਾਈਸ ਸਟੋਰੇਜ ਤੋਂ ਡਾਟਾ ਲੋਡ ਕਰੋ।
DeviceLoadCustomAudioਡਿਵਾਈਸ ਉੱਤੇ ਕਸਟਮ ਆਡੀਓ ਫਾਈਲਾਂ ਲੋਡ ਕਰੋ।
DeviceCoredumpSendਸਰਵਰ ਤੇ ਕਰੈਸ਼ ਕੋਰ ਡੰਪ ਅਪਲੋਡ ਕਰੋ।
DeviceAttachਡਿਵਾਈਸ ਨੂੰ ਸਰਵਰ ਸੈਸ਼ਨ ਨਾਲ ਜੋੜੋ।
DeviceDetachਸਰਵਰ ਸੈਸ਼ਨ ਤੋਂ ਡਿਵਾਈਸ ਨੂੰ ਵੱਖ ਕਰੋ।
DeviceLogSendਸਰਵਰ 'ਤੇ ਡਿਵਾਈਸ ਲੌਗ ਅੱਪਲੋਡ ਕਰੋ।
DeviceConnectionTestਸਰਵਰ ਕਨੈਕਟੀਵਿਟੀ ਦੀ ਜਾਂਚ ਕਰੋ।
DeviceStatusSendਡਿਵਾਈਸ ਸਥਿਤੀ ਨੂੰ ਸਰਵਰ ਤੇ ਪੁਸ਼ ਕਰੋ।
DeviceStatusGetਮੌਜੂਦਾ ਡਿਵਾਈਸ ਸਥਿਤੀ ਪ੍ਰਾਪਤ ਕਰੋ।
DeviceInteractionਇੱਕ ਡਿਵਾਈਸ ਇੰਟਰੈਕਸ਼ਨ ਇਵੈਂਟ ਨੂੰ ਟ੍ਰਿਗਰ ਕਰੋ।
DeviceSetAPIHostAPI ਸਰਵਰ ਹੋਸਟ ਸੈੱਟ ਕਰੋ।
DeviceTestMicsਮਾਈਕ੍ਰੋਫ਼ੋਨ ਸਵੈ-ਜਾਂਚ ਚਲਾਓ।
HardwareI2CCommandਇੱਕ ਹਾਰਡਵੇਅਰ ਪੈਰੀਫਿਰਲ ਨੂੰ ਇੱਕ ਕੱਚਾ I2C ਕਮਾਂਡ ਭੇਜੋ।

ਸੰਚਾਰ ਹੁਕਮ

ਕਾਲਾਂ ਸ਼ੁਰੂ ਕਰੋ, ਸੁਨੇਹੇ ਭੇਜੋ, ਸਰਗਰਮ ਸੰਚਾਰ ਸੈਸ਼ਨਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰੋ, ਅਤੇ ਰਿਕਾਰਡਿੰਗ ਨੂੰ ਕੰਟਰੋਲ ਕਰੋ।

CommunicateChannelJoinਇੱਕ ਸੰਚਾਰ ਚੈਨਲ ਵਿੱਚ ਸ਼ਾਮਲ ਹੋਵੋ।
CommunicateChannelLeaveਇੱਕ ਸੰਚਾਰ ਚੈਨਲ ਛੱਡੋ।
CommunicateChannelChangeਕਿਸੇ ਵੱਖਰੇ ਚੈਨਲ 'ਤੇ ਜਾਓ।
CommunicateChannelCloseਇੱਕ ਸੰਚਾਰ ਚੈਨਲ ਬੰਦ ਕਰੋ।
CommunicateReceiveIncomingਆਉਣ ਵਾਲੇ ਸੰਚਾਰ ਬਾਰੇ ਡਿਵਾਈਸ ਨੂੰ ਸੂਚਿਤ ਕਰੋ।
CommunicateRequestOutgoingਬਾਹਰ ਜਾਣ ਵਾਲੇ ਸੰਚਾਰ ਦੀ ਬੇਨਤੀ ਕਰੋ।
CommunicateVCPActivateਵੌਇਸ ਕਮਿਊਨੀਕੇਸ਼ਨ ਪ੍ਰੋਟੋਕੋਲ ਸੈਸ਼ਨ ਨੂੰ ਸਰਗਰਮ ਕਰੋ।
CommunicateVCPDeactivateVCP ਸੈਸ਼ਨ ਨੂੰ ਅਕਿਰਿਆਸ਼ੀਲ ਕਰੋ।
CommunicateRecordingActivateਸਰਗਰਮ ਸੰਚਾਰ ਨੂੰ ਰਿਕਾਰਡ ਕਰਨਾ ਸ਼ੁਰੂ ਕਰੋ।
CommunicateIncomingAcceptਇਨਕਮਿੰਗ ਕਾਲ ਸਵੀਕਾਰ ਕਰੋ।
CommunicateIncomingRejectਆਉਣ ਵਾਲੀ ਕਾਲ ਨੂੰ ਅਸਵੀਕਾਰ ਕਰੋ।
CommunicateHFPCallStartਇੱਕ ਬਲੂਟੁੱਥ HFP ਫ਼ੋਨ ਕਾਲ ਸ਼ੁਰੂ ਕਰੋ।
CommunicateHFPCallEndਬਲੂਟੁੱਥ HFP ਫ਼ੋਨ ਕਾਲ ਖਤਮ ਕਰੋ।
CommunicateContentStartਡਿਵਾਈਸ ਤੇ ਆਡੀਓ ਸਮੱਗਰੀ ਨੂੰ ਸਟ੍ਰੀਮ ਕਰਨਾ ਸ਼ੁਰੂ ਕਰੋ।
CommunicateContentStopਆਡੀਓ ਸਮੱਗਰੀ ਨੂੰ ਸਟ੍ਰੀਮ ਕਰਨਾ ਬੰਦ ਕਰੋ।
SocketReceiveStatusਵੈੱਬਸੌਕੇਟ ਸਥਿਤੀ ਅੱਪਡੇਟ ਪ੍ਰਾਪਤ ਕਰੋ।

ਆਡੀਓ ਕਮਾਂਡਾਂ

ਸਪੀਕਰ ਵਾਲੀਅਮ, ਮਾਈਕ੍ਰੋਫੋਨ ਲਾਭ, ਆਡੀਓ ਪ੍ਰੋਫਾਈਲਾਂ, ਅਤੇ ਟੈਕਸਟ-ਟੂ-ਸਪੀਚ ਪਲੇਬੈਕ ਨੂੰ ਕੰਟਰੋਲ ਕਰੋ।

AudioPlayStorageਡੀਵਾਈਸ ਸਟੋਰੇਜ ਤੋਂ ਇੱਕ ਆਡੀਓ ਫਾਈਲ ਚਲਾਓ।
AudioPlayContentਸਟ੍ਰੀਮ ਕੀਤੀ ਆਡੀਓ ਸਮੱਗਰੀ ਚਲਾਓ।
AudioSetVolumeਸਪੀਕਰ ਆਉਟਪੁੱਟ ਵਾਲੀਅਮ ਸੈੱਟ ਕਰੋ।

LED ਕਮਾਂਡਾਂ

ਬੈਜ ਇੰਡੀਕੇਟਰ ਲਾਈਟ 'ਤੇ LED ਰੰਗ, ਚਮਕ ਅਤੇ ਐਨੀਮੇਸ਼ਨ ਪੈਟਰਨ ਸੈੱਟ ਕਰੋ।

DeviceIlluminationSetLED ਰੰਗ ਅਤੇ ਰੋਸ਼ਨੀ ਪੈਟਰਨ ਸੈੱਟ ਕਰੋ।

ਅੰਦਰੂਨੀ ਕਮਾਂਡਾਂ

ਅੰਦਰੂਨੀ ਡਿਸਪੈਚ ਕਮਾਂਡਾਂ ਸੰਦਰਭ ਡਿਲੀਵਰੀ, ਚੈਨਲ ਇਤਿਹਾਸ, ਵੋਕਲਾਈਜ਼ੇਸ਼ਨ, ਅਤੇ ਆਡੀਓ ਡੀਕੋਡਿੰਗ ਲਈ ਵਰਤੀਆਂ ਜਾਂਦੀਆਂ ਹਨ।

InternalSendContextਅੰਦਰੂਨੀ ਸੰਦਰਭ ਹੈਂਡਲਰ ਨੂੰ ਸੰਦਰਭ ਡੇਟਾ ਭੇਜੋ।
InternalSendChannelHistoryਚੈਨਲ ਇਤਿਹਾਸ ਨੂੰ ਅੰਦਰੂਨੀ ਹੈਂਡਲਰ ਨੂੰ ਭੇਜੋ।
InternalRequestVocalizationਅੰਦਰੂਨੀ ਤੌਰ 'ਤੇ ਟੈਕਸਟ-ਟੂ-ਸਪੀਚ ਵੋਕਲਾਈਜ਼ੇਸ਼ਨ ਦੀ ਬੇਨਤੀ ਕਰੋ।
InternalHandleVocalizationRTPਆਉਣ ਵਾਲੀ ਵੋਕਲਾਈਜ਼ੇਸ਼ਨ RTP ਸਟ੍ਰੀਮ ਨੂੰ ਹੈਂਡਲ ਕਰੋ।
InternalDecodeAudioਆਉਣ ਵਾਲੀ ਆਡੀਓ ਸਟ੍ਰੀਮ ਨੂੰ ਡੀਕੋਡ ਕਰੋ।

ਮੋਬਾਈਲ ਕਮਾਂਡਾਂ

ਬੈਜ ਨੂੰ ਇੱਕ ਪੇਅਰ ਕੀਤੇ ਮੋਬਾਈਲ ਐਪ ਨਾਲ ਤਾਲਮੇਲ ਕਰਨ ਲਈ ਕਮਾਂਡਾਂ — ਪੁਸ਼ ਸੂਚਨਾਵਾਂ, ਐਪ ਸਟੇਟ ਸਿੰਕ, ਅਤੇ ਡੀਪ ਲਿੰਕਿੰਗ।

MobileServiceStatusਡਿਵਾਈਸ ਨੂੰ ਮੋਬਾਈਲ ਸੇਵਾ ਸਥਿਤੀ ਦੀ ਰਿਪੋਰਟ ਕਰੋ। (ਮੋਬਾਈਲ → ਡਿਵਾਈਸ)
MobileSocketOpenਮੋਬਾਈਲ ਐਪ ਨੂੰ ਵੈੱਬਸੌਕੇਟ ਕਨੈਕਸ਼ਨ ਖੋਲ੍ਹਣ ਲਈ ਨਿਰਦੇਸ਼ ਦਿਓ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobileSocketCloseਮੋਬਾਈਲ ਐਪ ਨੂੰ WebSocket ਕਨੈਕਸ਼ਨ ਬੰਦ ਕਰਨ ਲਈ ਨਿਰਦੇਸ਼ ਦਿਓ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobileSocketStatusਮੋਬਾਈਲ ਐਪ ਨੂੰ ਵੈੱਬਸੌਕੇਟ ਸਥਿਤੀ ਦੀ ਰਿਪੋਰਟ ਕਰੋ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobileReceiveStatusਮੋਬਾਈਲ ਐਪ ਨੂੰ ਪ੍ਰਾਪਤ ਸਥਿਤੀ ਦੀ ਰਿਪੋਰਟ ਕਰੋ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobileSocketUpdateਮੋਬਾਈਲ ਐਪ ਨੂੰ ਇੱਕ WebSocket ਡਾਟਾ ਅੱਪਡੇਟ ਭੇਜੋ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobilePTTStartਮੋਬਾਈਲ ਐਪ ਨੂੰ ਸੂਚਿਤ ਕਰੋ ਕਿ PTT ਟ੍ਰਾਂਸਮਿਸ਼ਨ ਸ਼ੁਰੂ ਹੋ ਗਿਆ ਹੈ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobilePTTStopਮੋਬਾਈਲ ਐਪ ਨੂੰ ਸੂਚਿਤ ਕਰੋ ਕਿ PTT ਟ੍ਰਾਂਸਮਿਸ਼ਨ ਖਤਮ ਹੋ ਗਿਆ ਹੈ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobileContextSetਮੋਬਾਈਲ ਐਪ 'ਤੇ ਸੰਦਰਭ ਡੇਟਾ ਸੈੱਟ ਕਰੋ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)
MobileEchoਮੋਬਾਈਲ ਕਨੈਕਟੀਵਿਟੀ ਦੀ ਜਾਂਚ ਲਈ ਈਕੋ ਕਮਾਂਡ। (ਡਿਵਾਈਸ → ਮੋਬਾਈਲ)

ਬਣਾਉਣ ਲਈ ਤਿਆਰ ਹੋ?

ਕਨੈਕਸ਼ਨ ਡਿਵੈਲਪਰ ਕਮਿਊਨਿਟੀ ਵਿੱਚ ਸ਼ਾਮਲ ਹੋਵੋ ਅਤੇ ਸੈਂਡਬੌਕਸ ਡਿਵਾਈਸਾਂ, SDK, ਅਤੇ ਸਮਰਪਿਤ ਸਹਾਇਤਾ ਤੱਕ ਪਹੁੰਚ ਪ੍ਰਾਪਤ ਕਰੋ।