API Queue Inbound

General authentication: All APIs use Kong dual-auth : Header Authorization(API key) is required. Header X-Tenant-IDinjected by Kong — if testing internally without going through Kong, omit this header, the backend will resolve tenantId based on the Authorization key. Do not use JWT ( x-access-token) in this flow.

GET /v1/queues/inbound

Retrieve the list of all inbound queues for the tenant. Supports pagination.

Authentication: Header X-Api-Key(scope: queue). Kong dual-auth: prioritize X-Tenant-IDheader, fallback to query DB based on the Authorization key.

Base URL: Dev: https://xapi-dev.alohub.vn |  Prod: https://xapi.alohub.vn

Parameters

Request Body

Sample code

curl -X GET "https://xapi.alohub.vn/v1/queues/inbound" \
  -H "X-Api-Key: sk_live_xxx" \
  -H "X-Tenant-ID: 20260310"

# Phân trang
curl -X GET "https://xapi.alohub.vn/v1/queues/inbound?page=0&size=10" \
  -H "X-Api-Key: sk_live_xxx" \
  -H "X-Tenant-ID: 20260310"

const axios = require('axios');
const response = await axios.get(
  '{{host}}/api/v1/queues/inbound?page=0&size=20',
  { headers: { 'Authorization': '{{api-key}}', 'X-Tenant-ID': '{{tenant-id}}', 'Content-Type': 'application/json' } }
);
console.log(response.data);

import requests

params = {"page": "0", "size": "20"}
headers = {"Authorization": "{{api-key}}", "X-Tenant-ID": "{{tenant-id}}", "Content-Type": "application/json"}
response = requests.get(
    '{{host}}/api/v1/queues/inbound',
    headers=headers, params=params
)
print(response.json())

Response 200

{
  "success": "1",
  "error_code": "SUCCESS",
  "totalRecord": 3,
  "data": [
    {
      "callinId": 1001226,
      "callinName": "test",
      "strategy": 1,
      "musicinQueue": "waiting.wav",
      "timeWait": "120",
      "agentSelector": null,
      "nguongRanhRoi": null,
      "callinNumber": null
    }
  ]
}

Response Fields

Error Codes

Rate Limit Headers

GET /v1/queues/inbound/{id}

Retrieve details of 1 inbound queue. Backend checks ownership: the queue must belong to the tenant of the auth header.

Authentication: Header X-Api-Key(scope: queue). Kong dual-auth: prioritize X-Tenant-IDheader, fallback to query DB based on the Authorization key.

Base URL: Dev: https://xapi-dev.alohub.vn |  Prod: https://xapi.alohub.vn

Parameters

Request Body

Sample code

curl -X GET "https://xapi.alohub.vn/v1/queues/inbound/1001226" \
  -H "X-Api-Key: sk_live_xxx" \
  -H "X-Tenant-ID: 20260310"

const axios = require('axios');
const response = await axios.get(
  '{{host}}/api/v1/queues/inbound/{{id}}',
  { headers: { 'Authorization': '{{api-key}}', 'X-Tenant-ID': '{{tenant-id}}', 'Content-Type': 'application/json' } }
);
console.log(response.data);

import requests

headers = {"Authorization": "{{api-key}}", "X-Tenant-ID": "{{tenant-id}}", "Content-Type": "application/json"}
response = requests.get(
    '{{host}}/api/v1/queues/inbound/{{id}}',
    headers=headers
)
print(response.json())

Response 200

{
  "callinId": 1001226,
  "callinName": "test",
  "strategy": 1,
  "musicinQueue": "waiting.wav",
  "timeWait": "120",
  "agentSelector": null,
  "nguongRanhRoi": null,
  "callinNumber": null
}

Response Fields

Error Codes

Rate Limit Headers

PUT /v1/queues/inbound/{id}

Update inbound queue configuration. All fields are optional — at least 1 field is required. Strategy must be an integer in the set {1,2,3,4,99}.

Authentication: Header X-Api-Key(scope: queue). Kong dual-auth: prioritize X-Tenant-IDheader, fallback to query DB based on the Authorization key.

Base URL: Dev: https://xapi-dev.alohub.vn |  Prod: https://xapi.alohub.vn

Parameters

Request Body

{
  "moh_file_id": "waiting.wav",
  "max_wait_sec": "180",
  "strategy": 1,
  "announce_position": "1"
}

Sample code

curl -X PUT "https://xapi.alohub.vn/v1/queues/inbound/1001226" \
  -H "X-Api-Key: sk_live_xxx" \
  -H "X-Tenant-ID: 20260310" \
  -H "Content-Type: application/json" \
  -d '{"strategy":1}'

# Update nhiều field
curl -X PUT "https://xapi.alohub.vn/v1/queues/inbound/1001226" \
  -H "X-Api-Key: sk_live_xxx" \
  -H "X-Tenant-ID: 20260310" \
  -H "Content-Type: application/json" \
  -d '{"moh_file_id":"waiting.wav","max_wait_sec":"180","strategy":1}'

const axios = require('axios');
const response = await axios.put(
  '{{host}}/api/v1/queues/inbound/{{id}}',
  {
  "moh_file_id": "waiting.wav",
  "max_wait_sec": "180",
  "strategy": 1,
  "announce_position": "1"
},
  { headers: { 'Authorization': '{{api-key}}', 'X-Tenant-ID': '{{tenant-id}}', 'Content-Type': 'application/json' } }
);
console.log(response.data);

import requests

headers = {"Authorization": "{{api-key}}", "X-Tenant-ID": "{{tenant-id}}", "Content-Type": "application/json"}
payload = {
    "moh_file_id": "waiting.wav",
    "max_wait_sec": "180",
    "strategy": 1,
    "announce_position": "1"
}
response = requests.put(
    '{{host}}/api/v1/queues/inbound/{{id}}',
    json=payload,
    headers=headers
)
print(response.json())

Response 200

{
  "success": "1",
  "error_code": "SUCCESS",
  "error_message": "Inbound queue updated successfully"
}

Response Fields

Error Codes

Rate Limit Headers