organizácie
Spravujte organizácie v rámci svojho účtu ChatHub. Organizácie slúžia ako kontajnery pre operátorov a chatové operácie.
Prehľad
Organizácie v ChatHub:
- Skupinových operátorov podľa oddelenia, tímu alebo funkcie
- Izolujte chatové operácie medzi rôznymi obchodnými jednotkami
- Spravujte povolenia na úrovni organizácie
- Sledujte metriky podľa organizácie
Zoznam organizácií
Získajte všetky organizácie prístupné pomocou vášho firemného tokenu.
Koncový bod
Žiadosť
curl -X GET https://chatapi.smsbat.com/api/company/organization \
-H "Authorization: Bearer {company-token}" \
-H "Accept: text/plain"
Hlavičky
| Hlavička | Hodnota | povinné | Popis |
|---|---|---|---|
| "Oprávnenie" | Nositeľ | áno | Token spoločnosti |
| "Prijať" | text/obyčajný | áno | Formát odpovede |
Odpoveď
[
{
"id": 6,
"name": "Customer Support"
},
{
"id": 24,
"name": "Sales Team"
},
{
"id": 42,
"name": "Technical Support"
}
]
Polia odpovedí
| Pole | Typ | Popis |
|---|---|---|
| 'id' | celé číslo | Jedinečný identifikátor organizácie |
| "meno" | reťazec | Zobrazovaný názov organizácie |
Organizačná štruktúra
Každá organizácia obsahuje:
- Operátori: Chat agenti pridelení organizácii
- Chatové relácie: Aktívne a historické chatové konverzácie
- Miniaplikácie: Vstavané miniaplikácie chatu pre túto organizáciu
- Nastavenia: Konfigurácia špecifická pre organizáciu
Prípady použitia
Spoločnosť s viacerými oddeleniami
Company: ACME Corp
├── Organization: Sales (id: 10)
│ ├── Operator: John (Sales Rep)
│ └── Operator: Sarah (Sales Manager)
├── Organization: Support (id: 20)
│ ├── Operator: Mike (Support Agent)
│ └── Operator: Lisa (Support Lead)
└── Organization: Technical (id: 30)
└── Operator: Alex (Tech Expert)
Podnikanie s viacerými značkami
Company: Retail Group
├── Organization: Brand A (id: 101)
│ └── Widget: branda.com
├── Organization: Brand B (id: 102)
│ └── Widget: brandb.com
└── Organization: Brand C (id: 103)
└── Widget: brandc.com
Príklady implementácie
Python
import requests
def get_organizations(company_token):
"""Get list of all organizations"""
response = requests.get(
'https://chatapi.smsbat.com/api/company/organization',
headers={
'Authorization': f'Bearer {company_token}',
'Accept': 'text/plain'
}
)
response.raise_for_status()
return response.json()
def find_organization_by_name(company_token, name):
"""Find organization by name"""
organizations = get_organizations(company_token)
for org in organizations:
if org['name'].lower() == name.lower():
return org
return None
def get_organization_by_id(company_token, org_id):
"""Get specific organization by ID"""
organizations = get_organizations(company_token)
for org in organizations:
if org['id'] == org_id:
return org
return None
# Usage
token = "your-company-token"
# Get all organizations
orgs = get_organizations(token)
print(f"Found {len(orgs)} organizations")
# Find specific organization
support_org = find_organization_by_name(token, "Support")
if support_org:
print(f"Support organization ID: {support_org['id']}")
# Get by ID
org = get_organization_by_id(token, 24)
print(f"Organization: {org['name']}")
JavaScript (Node.js)
const axios = require('axios');
class OrganizationManager {
constructor(companyToken) {
this.companyToken = companyToken;
this.baseUrl = 'https://chatapi.smsbat.com';
}
async getOrganizations() {
const response = await axios.get(
`${this.baseUrl}/api/company/organization`,
{
headers: {
'Authorization': `Bearer ${this.companyToken}`,
'Accept': 'text/plain'
}
}
);
return response.data;
}
async findByName(name) {
const organizations = await this.getOrganizations();
return organizations.find(org =>
org.name.toLowerCase() === name.toLowerCase()
);
}
async findById(id) {
const organizations = await this.getOrganizations();
return organizations.find(org => org.id === id);
}
async listByIds(ids) {
const organizations = await this.getOrganizations();
return organizations.filter(org => ids.includes(org.id));
}
}
// Usage
const manager = new OrganizationManager('your-company-token');
async function manageOrganizations() {
// Get all organizations
const orgs = await manager.getOrganizations();
console.log(`Found ${orgs.length} organizations`);
// Find by name
const support = await manager.findByName('Support');
console.log('Support org:', support);
// Find by ID
const org = await manager.findById(24);
console.log('Organization:', org);
// Get multiple organizations
const selectedOrgs = await manager.listByIds([10, 20, 30]);
console.log('Selected organizations:', selectedOrgs);
}
manageOrganizations();
PHP
<?php
class OrganizationManager {
private $companyToken;
private $baseUrl = 'https://chatapi.smsbat.com';
public function __construct($companyToken) {
$this->companyToken = $companyToken;
}
public function getOrganizations() {
$ch = curl_init($this->baseUrl . '/api/company/organization');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $this->companyToken,
'Accept: text/plain'
]);
$response = curl_exec($ch);
curl_close($ch);
return json_decode($response, true);
}
public function findByName($name) {
$organizations = $this->getOrganizations();
foreach ($organizations as $org) {
if (strcasecmp($org['name'], $name) === 0) {
return $org;
}
}
return null;
}
public function findById($id) {
$organizations = $this->getOrganizations();
foreach ($organizations as $org) {
if ($org['id'] === $id) {
return $org;
}
}
return null;
}
}
// Usage
$manager = new OrganizationManager('your-company-token');
// Get all organizations
$orgs = $manager->getOrganizations();
echo "Found " . count($orgs) . " organizations\n";
// Find by name
$support = $manager->findByName('Support');
if ($support) {
echo "Support organization ID: " . $support['id'] . "\n";
}
// Find by ID
$org = $manager->findById(24);
if ($org) {
echo "Organization: " . $org['name'] . "\n";
}
Práca s organizáciami
Zoznam všetkých organizácií
const organizations = await getOrganizations(companyToken);
organizations.forEach(org => {
console.log(`${org.id}: ${org.name}`);
});
výstup:
Filtrujte organizácie
// Get organizations matching criteria
const supportOrgs = organizations.filter(org =>
org.name.toLowerCase().includes('support')
);
// Get organizations by IDs
const specificOrgs = organizations.filter(org =>
[10, 20, 30].includes(org.id)
);
Mapujte organizácie
// Create ID to name mapping
const orgMap = organizations.reduce((map, org) => {
map[org.id] = org.name;
return map;
}, {});
console.log(orgMap[24]); // "Sales Team"
Integračné vzory
Používateľské rozhranie výberu organizácie
async function renderOrganizationSelect(companyToken) {
const organizations = await getOrganizations(companyToken);
const select = document.createElement('select');
select.id = 'organization-select';
organizations.forEach(org => {
const option = document.createElement('option');
option.value = org.id;
option.textContent = org.name;
select.appendChild(option);
});
return select;
}
Smerujte rozhovory podľa organizácie
async function routeChatToOrganization(chatRequest) {
const organizations = await getOrganizations(companyToken);
// Route based on business logic
let targetOrg;
if (chatRequest.department === 'sales') {
targetOrg = organizations.find(org =>
org.name.toLowerCase().includes('sales')
);
} else if (chatRequest.department === 'support') {
targetOrg = organizations.find(org =>
org.name.toLowerCase().includes('support')
);
}
return targetOrg?.id;
}
Metriky organizácie
class OrganizationMetrics {
async getMetrics(companyToken, orgId) {
// Get operators for organization
const operators = await getOperators(companyToken, orgId);
// Get chat statistics (example)
return {
organizationId: orgId,
operatorCount: operators.length,
activeOperators: operators.filter(op => op.isActive).length,
// Add more metrics as needed
};
}
async getAllMetrics(companyToken) {
const organizations = await getOrganizations(companyToken);
const metrics = await Promise.all(
organizations.map(org =>
this.getMetrics(companyToken, org.id)
)
);
return metrics;
}
}
Osvedčené postupy
Ukladanie do vyrovnávacej pamäte
Uložte zoznam organizácií do vyrovnávacej pamäte, aby ste znížili volania rozhrania API:
class CachedOrganizationManager {
constructor(companyToken, cacheTTL = 300000) { // 5 minutes
this.companyToken = companyToken;
this.cacheTTL = cacheTTL;
this.cache = null;
this.cacheTime = 0;
}
async getOrganizations(forceRefresh = false) {
const now = Date.now();
if (!forceRefresh &&
this.cache &&
now - this.cacheTime < this.cacheTTL) {
return this.cache;
}
this.cache = await fetchOrganizations(this.companyToken);
this.cacheTime = now;
return this.cache;
}
clearCache() {
this.cache = null;
this.cacheTime = 0;
}
}
Spracovanie chýb
async function getOrganizationsWithRetry(companyToken, retries = 3) {
for (let i = 0; i < retries; i++) {
try {
return await getOrganizations(companyToken);
} catch (error) {
if (error.response?.status === 401) {
throw new Error('Invalid or expired company token');
}
if (i === retries - 1) throw error;
// Wait before retry
await new Promise(resolve =>
setTimeout(resolve, Math.pow(2, i) * 1000)
);
}
}
}
Overenie
function validateOrganizationId(organizations, orgId) {
const org = organizations.find(o => o.id === orgId);
if (!org) {
throw new Error(`Organization ${orgId} not found`);
}
return org;
}
// Usage
const organizations = await getOrganizations(companyToken);
const org = validateOrganizationId(organizations, requestedOrgId);
Riešenie problémov
Prázdny zoznam organizácií
- Overte, či je token spoločnosti platný
- Kontrolný token má prístup organizácie
- Zabezpečte existenciu organizácií na účte
Organizácia sa nenašla
- Overte, či je ID organizácie správne
- Skontrolujte, či organizácia nebola odstránená
- Obnoviť zoznam organizácií
401 Neoprávnené
- Overte, či je token spoločnosti platný a jeho platnosť nevypršala
- V prípade potreby požiadajte o nový firemný token
- Skontrolujte správnosť formátu tokenu
Ďalšie kroky
- Autentifikácia - Získajte firemný token – Operátori – Správa operátorov v organizáciách – Integrácia miniaplikácií – Integrácia četu pre organizácie