API - CallQueue / Save¶
API CallQueue / Save se foloseste pentru a programa apeluri care vor fi sunate mai tarziu, conform unui orar prestabilit, folosind Originate call.
API URL¶
https://[YOUR-PBX-URL]/api/call-queue
Datele se transmit prin POST sau GET si trebuie sa fie de forma:¶
Array
(
[action] => save
[data] => Array
(
[project_id] => 1
[type] => queue
[destination] => test-queue
[campaign_name] => Test campaign
[campaign_info] => Some special info
[outbound_type] => auto
[attend_type] => attended
[outbound_number] => +40212345678
[outbound_trunk] => default-trunk
[calls] => Array
(
[0] => Array
(
[caller_id] => 0123456789
[caller_id_name] => John Doe
[priority] => 0
[schedule] =>
[external_id] => asdf1234
[max_retries] => 5
[vars] => Array
(
[SKIP_WELCOME] => 1
[SKIP_WE_ARE_RECORDING] => 1
[SKIP_ENTER_QUEUE] => 0
[BACKEND_LINK] => https://[YOUR-EXTERNAL-CRM-URL]/?change_this_url=1234
)
)
)
)
[api_hash] => 20b093246dac88454f390553e813aa0d
)
Parametrul action trebuie sa aiba valoarea save (daca lipseste, implicit este save)
Parametri:¶
- project_id: ID proiect in centrala, obligatoriu
- type: tipul destinatiei catre care se trimite apelul intern (user, queue, context), obligatoriu
- destination: user-ul / coada / contextul din centrala pentru care se initiaza apelul, obligatoriu. Pentru user si queue se verifica existenta in centrala
- campaign_name: nume campanie, obligatoriu
- campaign_info: informatii suplimentare campanie, obligatoriu
- outbound_type: tipul de campanie automata sau manuala (auto, manual), obligatoriu
- attend_type: apelul se realizeaza cu sau fara un agent (attended, unattended), obligatoriu
- outbound_number: numarul care este afisat catre destinatar, optional; implicit numarul de outbound al proiectului
- outbound_trunk: providerul prin care se face apelul, optional; implicit default-trunk
- calls: array cu apelurile, obligatoriu
- caller_id: numarul de telefon care este apelat, obligatoriu; se pastreaza doar cifrele si +
- caller_id_name: numele persoanei care este apelata, obligatoriu
- external_id: ID din baza de date externa (ex: activity ID), obligatoriu
- priority: prioritatea apelului in call queue, optional, implicit 0
- schedule: data si ora la care se programeaza apelul, optional, implicit data si ora curenta. Format: Y-m-d H:i:s (ex: 2017-02-16 00:00:00)
- max_retries: numarul maxim de incercari pana se abandoneaza apelul, optional, implicit valoarea setata in proiect
- vars: array cu diferite variabile pentru contextul din PBX, optional
Fiecare apel din calls este procesat separat: apelurile valide sunt salvate chiar daca altele au erori (has_error = true). Cheile din results si din messages sunt indexul apelului din calls, deci verificati intotdeauna results.
Un apel este considerat duplicat (si nu este salvat) daca exista deja unul in asteptare (pending / inprogress) cu acelasi caller_id, project_id si external_id si cu aceeasi destinatie a rutei Inbound asociate lui outbound_number (daca exista).
Headere HTTP:¶
Content-Type: application/json Authorization: Bearer <token>
Exemplu generare parametri:
$params = array(
'action' => 'save',
'data' => array(
'project_id' => 1,
'type' => 'queue', // user, queue, context
'destination' => 'test-queue',
'campaign_name' => 'Test campaign',
'campaign_info' => 'Some special info',
'outbound_type' => 'auto', // auto, manual
'attend_type' => 'attended', // attended, unattended
'outbound_number' => '+40212345678', // dnid
'outbound_trunk' => 'default-trunk',
'calls' => array(
array(
'caller_id' => '0123456789',
'caller_id_name' => 'John Doe',
'priority' => 0,
'schedule' => '', // default NOW()
'external_id' => 'asdf1234',
'max_retries' => 5,
'vars' => array(
'SKIP_WELCOME' => 1,
'SKIP_WE_ARE_RECORDING' => 1,
'SKIP_ENTER_QUEUE' => 0,
'BACKEND_LINK' => 'https://[YOUR-EXTERNAL-CRM-URL]/?change_this_url=1234', // for pop-up
),
)
)
)
);
Exemplu generare hash:
$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash
Exemplu trimitere date:
$url = 'https://[YOUR-PBX-URL]/api/call-queue';
$token = 'your_api_token';
echo curlPost($url, json_encode($params), array("Authorization: Bearer {$token}", "Content-Type: application/json"));
Date trimise JSON¶
{
"action": "save",
"data": {
"project_id": 1,
"type": "queue",
"destination": "test-queue",
"campaign_name": "Test campaign",
"campaign_info": "Some special info",
"outbound_type": "auto",
"attend_type": "attended",
"outbound_number": "+40212345678",
"outbound_trunk": "default-trunk",
"calls": [
{
"caller_id": "0123456789",
"caller_id_name": "John Doe",
"priority": 0,
"schedule": "",
"external_id": "asdf1234",
"max_retries": 5,
"vars": {
"SKIP_WELCOME": 1,
"SKIP_WE_ARE_RECORDING": 1,
"SKIP_ENTER_QUEUE": 0,
"BACKEND_LINK": "https://[YOUR-EXTERNAL-CRM-URL]/?change_this_url=1234"
}
}
]
},
"api_hash": "19a84b02b61cb907611cd986f10062db"
}
Raspuns¶
In caz de succes:
{
"has_error": false,
"messages": [ ],
"results": [
{
"external_id": "asdf1234",
"queue_id": 79,
"schedule": "2017-02-20 15:22:32"
}
]
}
Sau in caz de eroare:
{
"has_error": true,
"messages": {
"0": "row #0 is already scheduled with queue_id #78",
"schedule::1": "Invalid schedule (1), format must be Y-m-d H:i:s"
},
"results": [ ]
}
Disponibil si in alte limbi: EN