API - Channel¶
API Channel se foloseste pentru a manipula apelurile (canalele) active din centrala. Parametrul action este obligatoriu: list, hangup, originate sau redirect. Pentru hangup, originate si redirect parametrii se trimit in array-ul data. Raspunsul nu contine pagination.
Datele se transmit prin POST sau GET¶
API URL¶
https://[YOUR-PBX-URL]/api/channel
Lista - arata toate canalele
Array
(
[action] => list
[api_hash] => 0f25e797e72d0dbba96d2c571a7bd6ba
)
¶
Raspuns: results.raw contine canalele asa cum le intoarce Asterisk (cheia este numele canalului), iar results.formatted apelurile procesate (directie, coada, agent, durata).
{
"has_error": false,
"messages": [ ],
"results": {
"raw": {
"PJSIP/john-doe-00000027": {
"Channel": "PJSIP/john-doe-00000027",
"Context": "internal",
"Exten": "s",
"Priority": "1",
"Stats": "Up",
"Application": "AppQueue",
"Data": "(Outgoing Line)",
"CallerID": "0712345678",
"Accountcode": "",
"PeerAccount": "inbound",
"Amaflags": "3",
"Duration": "42",
"Bridged": "1730800000.120",
"UniqueID": "1730800000.121"
}
},
"formatted": [
{
"uniqueid": "1730800000.120",
"channel": "PJSIP/default-trunk-00000026",
"caller_id": "0712345678",
"parsed_user": "john-doe",
"direction": "in",
"info": "Queue",
"info_key": "test-queue",
"queue_name": "test-queue",
"duration": "42",
"status": "speaking",
"call_time": "00:00:42",
"connected_line": "John Doe"
}
]
}
}
Hangup - inchide canalul specificat¶
Parametrul channel este obligatoriu si trebuie sa fie un nume de canal valid (ex: PJSIP/john-doe-00000027, din list).
Array
(
[action] => hangup
[data] => Array
(
[channel] => SIP/john-doe-00000027
)
[api_hash] => 0f25e797e72d0dbba96d2c571a7bd6ba
)
Originate - creati un canal nou si conectati-l la o extensie dialplan¶
Toti parametrii sunt obligatorii: tech (canalul apelat, ex: PJSIP/john-doe sau Local/10@internal), exten (litere, cifre si * # + - ) si context (litere, cifre, - si _). Cand canalul raspunde, este trimis la extensia _exten din contextul context. Apelul se initiaza asincron: raspunsul confirma doar ca a fost pus in executie. Originate catre o aplicatie (appname / appdata) nu este permis.
Array
(
[action] => originate
[data] => Array
(
[tech] => PJSIP/john-doe
[exten] => 10
[context] => internal
)
[api_hash] => 0f25e797e72d0dbba96d2c571a7bd6ba
)
Raspuns: Channel PJSIP/john-doe successfully originated. Daca extensia nu exista in context, eroarea este Failed on channel PJSIP/john-doe: Response: Error Message: Extension does not exist.
Redirect - redirectionati un canal existent catre o extensie dialplan¶
Toti parametrii sunt obligatorii: channel (nume de canal valid), context si priority (litere, cifre, - si _), exten (litere, cifre si * # + - _).
Array
(
[action] => redirect
[data] => Array
(
[channel] => SIP/john-doe-00000027
[context] => internal
[exten] => 504
[priority] => 1
)
[api_hash] => 0f25e797e72d0dbba96d2c571a7bd6ba
)
Raspuns hangup / redirect¶
{
"has_error": false,
"messages": [ ],
"results": [
"Channel PJSIP/john-doe-00000027 successfully hung"
]
}
Erori posibile:
- Request action is missing, Request data array is missing
- Required parameter is missing from data array: channel (cheia din messages este numele parametrului)
- Invalid channel, Invalid tech, Invalid context, Invalid exten, Invalid priority
- Failed on channel ...: ... - comanda nu a putut fi executata (ex: canalul nu mai exista)
- Invalid action: ...
- Manager error: ... - centrala nu raspunde
{
"has_error": true,
"messages": {
"channel": "Invalid channel"
},
"results": [ ]
}
Available in other languages: EN