CRM Leads / Save¶
API CRM Leads / Save se foloseste pentru a salva in CRM-ul While1 Voice leads din surse externe.
API URL¶
https://[YOUR-PBX-URL]/api/crm-leads
Datele se transmit prin POST sau GET si trebuie sa fie de forma:¶
Array
(
[action] => save
[data] => Array
(
[ASDF1234] => Array
(
[properties] => Array
(
[id] => null
[crm_type_id] => 1
[remote_id] => null
[subject] => New API Lead
[contact_name] => John Doe
[contact_email] => test@example.com
[contact_telephone] => 0700000001
[referrer_source] => contact form
)
[custom_fields] => Array
(
[11] => array(1, 3, 4)
[13] => array(1)
[16] => Test company
)
)
)
[api_hash] => 20b093246dac88454f390553e813aa0d
)
Parametrul action trebuie sa aiba valoarea save
Parametri:¶
- data: Array cu leadurile
- data - properties: Array cu proprietatile standard ale fiecarui lead
- data - custom_fields: Array cu custom-fields setate in CRM Config :: Custom fields ale fiecarui lead (cheile sunt ID-urile campurilor). Se actualizeaza doar campurile trimise; o valoare goala sterge valoarea campului.
Cheile din data (ex: ASDF1234) sunt folosite in raspuns, pentru rezultatele si erorile fiecarui lead.
Proprietati (properties):¶
- crm_type_id - obligatoriu, ID-ul din CRM Config :: Element types (tip leads); nu se poate schimba la un lead existent
- subject - obligatoriu
- project_id - obligatoriu doar daca CRM_LEADS_PROJECT_REQUIRED este activ
- id - ID-ul lead-ului din While1 Voice, pentru actualizare
- remote_id - ID-ul lead-ului din aplicatia dvs.; daca id lipseste, lead-ul existent este cautat dupa remote_id (si crm_type_id) si actualizat, altfel se creeaza un lead nou
- contact_id - ID-ul contactului din While1 Voice. Daca lipseste, contactul se cauta dupa contact_telephone (daca telefoanele contactelor sunt unice) sau contact_email. Daca nu e gasit, sunt obligatorii contact_name si contact_telephone (si contact_email, daca emailul contactelor este obligatoriu)
- contact_name, contact_email, contact_telephone - datele contactului
- referrer_source, extra_info, comments, reason, source - texte, optional
- due_date - data limita (YYYY-MM-DD), optional
- value, currency - valoarea lead-ului; currency este obligatoriu daca value este completat
- assigned_user_id - ID-ul utilizatorului asignat, optional
- status - pending (implicit), prospecting, inprogress, feedback, scheduled, completed, cancelled, lost
Leadurile se salveaza independent: daca unul are erori, celelalte sunt salvate, iar raspunsul contine atat results pentru cele salvate, cat si messages pentru erori.
Headere HTTP:¶
Content-Type: application/json Authorization: Bearer <token>
Exemplu generare parametri:
$params = array(
'action' => 'save',
'data' => array(
'ASDF1234' => array(
// Lead properties
'properties' => array(
'id' => '', // will be matched by remote_id if left blank
'crm_type_id' => 1, // ID from CRM Config :: Element types
'remote_id' => null,
'subject' => 'New API Lead',
'contact_name' => 'John Doe',
'contact_email' => 'test@example.com',
'contact_telephone' => '0700000001',
'referrer_source' => 'contact form',
),
// Custom fields (keys are IDs from CRM Config :: Custom fields). Only the specified fields are updated, an empty value clears the field
'custom_fields' => array(
11 => 'source: test',
13 => 'product: test',
16 => 'Test company',
)
)
)
);
Exemplu generare hash:
$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash
Exemplu trimitere date:
$url = 'https://[YOUR-PBX-URL]/api/crm-leads';
$token = 'your_api_token';
echo curlPost($url, json_encode($params), array("Authorization: Bearer {$token}", "Content-Type: application/json"));
Raspuns¶
In caz de succes:
{
"has_error": false,
"messages": [],
"results": {
"ASDF1234": {
"id": 3,
"contact_id": 23,
"remote_id": null
}
}
}
Sau in caz de eroare:
{
"has_error": true,
"messages": [
"Error on Lead update (ASDF1234): Contact ID is required"
],
"results": [ ]
}
Disponibil si in alte limbi: EN