L'interfaccia API è completamente gratuita e disponibile su tutti gli account Zadarma.
Ogni richiesta che richiede l'autorizzazione è accompagnata da un'intestazione aggiuntiva del tipo:
"Authorization: chiave_utente:firma"
Le chiavi per l'autorizzazione devono essere richieste nell' area personale.
La firma viene generata secondo il seguente algoritmo:
Chiamate
Numeri di telefono
SMS
Centralino virtuale
CRM
Call tracking
eSIM per Internet
Agente IA
Analisi vocale con IA
Chiamaci (Click to Call)
Videoconferenza
VoIP per le aziende
Programma di affiliazione
Integrazioni
Per chi
Istruzioni per la configurazione
Domande frequenti
Chat online
Contattaci
Blog
ksort($params);
$paramsStr = http_build_query($params, null, '&', PHP_QUERY_RFC1738);
$sign = base64_encode(hash_hmac('sha1', $method . $paramsStr . md5($paramsStr), $secret));
$header = 'Authorization: ' . $userKey . ':' . $sign;
La classe PHP pronta all'uso per lavorare con l'API può essere scaricata all'indirizzo GitHub.
Il titolo Content-Type per le richieste POST e PUT deve essere uguale a application/x-www-form-urlencoded o multipart/form-data.
Formati di risposta: json (per impostazione predefinita) e xml.
Per ottenere una risposta dall'API in formato xml, aggiungere il parametro "format=xml" alla stringa di richiesta.
{
"status":"error",
"message":"Check phone's number"
}
La risposta contiene anche informazioni sui limiti e sulla richiesta corrente, ad esempio:
X-Zadarma-Method: /v1/ X-RateLimit-Reset: 1434371160 X-RateLimit-Limit: 100 X-RateLimit-Remaining: 99
dove,
Limiti generali: 100 richieste al minuto, per i metodi statistici: 3 richieste al minuto.
In caso di blocco, il metodo restituisce la risposta 429 con l'intestazione "You exceeded the rate limit".
La risposta è composta da una chiave obbligatoria "status" (success o error). Successivamente, a seconda del metodo, vengono restituite le chiavi con le informazioni richieste.
In caso di errore, viene restituita una chiave aggiuntiva "message" con la descrizione dell'errore.
Inoltre, tutte le risposte sono accompagnate dai relativi intestazioni HTTP.
Attenzione: se è necessaria una statistica del centralino sempre aggiornata, Non è necessario richiedere ogni minuto il metodo statistics/pbx/. Attiva le notifiche webhooks e ricevi informazioni su ogni chiamata al momento della sua inizio e fine.
saldo utente
{
"status":"success",
"balance":10.34,
"currency":"USD"
}
costo della chiamata in base alla tariffa attuale dell'utente
{
"status":"success",
"info": {
"prefix":"4420",
"description":"United Kingdom, London",
"price":"0.009",
"currency":"USD",
}
}
fuso orario dell'utente
{
"status":"success",
"unixtime":1483228800,
"datetime":"2017-01-01 00:00:00",
"timezone":"UTC+0"
}
informazioni sulla tariffa attuale dell'utente
{
"status":"success",
"info": {
"tariff_id":5,
"tariff_name":"Standart, special",
"is_active":false,
"cost":0,
"currency":USD,
"used_seconds":1643,
"used_seconds_mobile":34,
"used_seconds_fix":726,
"tariff_id_for_next_period":5,
"tariff_for_next_period":Standart, special
}
}
Dove:
richiamata
{
"status":"success",
"from":442037691880,
"to":442037691881,
"time":1435573082
}
confirmazione del numero
{
"status":"success",
"from":442037691880,
"to":442037691881,
"lang":"fr",
"time":1612779278
}
aggiornamento dei contatti
Se numbers contiene 1 numero, il risultato verrà restituito immediatamente; se è specificato un elenco di numeri, il risultato verrà inviato all'indirizzo indicato nella pagina di aggiornamento dei contatti o inviato via e-mail se l'indirizzo non è specificato.
Attenzione: le impostazioni di questo metodo vengono effettuate nella pagina di aggiornamento dei contatti nell'area personale.
(Esempio 1)
Esempio 1:
{
"status":"success",
"info":{
"mcc":"24702",
"mnc":"02",
"mccName":"Latvia",
"mncName":"Tele2",
"ported":false,
"roaming":false,
"errorDescription":"No Error"
}
}
(Esempio 2)
Esempio 2:
{
"status":"success"
}
(Esempio 3)
Esempio 3:
{
"success":true,
"description":"Success",
"result": [
{
"mcc":"24702",
"mnc":"02",
"ported":false,
"roaming":false,
"errorDescription":"No Error",
"mccName":"Latvia",
"mncName":"Tele2",
"number":"3712812858",
}, ...
]
} Elenco delle valute
{
"status": "success",
"currencies": [
"USD",
"EUR",
"GBP",
"PLN"
]
} Elenco delle lingue disponibili nell'area personale
{
"status": "success",
"languages": [
"en",
"es",
"de",
"pl",
"ru",
"ua",
"fr"
]
} Elenco delle tariffe
{
"status": "success",
"currency": "EUR",
"tariffs": [
{
"tariff_id": 5,
"name": "Standard",
"cost": 0,
"days": "30"
},
...
],
"package_tariffs": [
{
"id": 1,
"name": "EU",
"tariffs": [
{
"tariff_id": 23,
"name": "Office",
"cost": 22,
"cost_annual": 216
},
...
]
},
...
]
}
elenco dei numeri SIP dell'utente
{
"status":"success",
"sips":[
{"id":"00001", "display_name":"SIP 1", "lines":3},
{"id":"00002", "display_name":"SIP 2", "lines":3}
],
"left":3
}
Dove:
stato online del numero SIP dell'utente
{
"status":"success",
"sip":"00001",
"is_online":"false"
}
modifica CallerID
{
"status":"success",
"sip":"00001",
"new_caller_id":"442037691880"
}
Visualizzazione dell’inoltro corrente dei numeri SIP dell’utente
{
"status":"success",
"info": [
{
"sip_id":"00001",
"status":"on",
"condition":"always",
"destination":"phone",
"destination_value":"442037691880"
},
...
]
}
Dove:
attivazione/disattivazione dell'inoltro per numero SIP
{
"status":"success",
"sip":"00001",
"current_status":"on"
}
modifica dei parametri di inoltro
{
"status":"success",
"sip":"00001",
"destination":"442037691880"
}
Creazione di un numero SIP
{
"status": "success",
"sip": "123456"
}
Modifica della password SIP
{
"status":"success",
"sip":$sip,
}
ottenimento di statistiche generali
(Esempio 1)
Esempio 1:
{
"status":"success",
"start":"2015-06-01 00:00:00",
"end":"2015-06-29 13:45:23",
"stats":[
{
"id":"155112249",
"sip":"00001",
"callstart":"2015-06-02 12:20:25",
"from":442037691880,
"to":442037691881,
"description":"United Kingdom, London",
"disposition":"busy",
"billseconds":0,
"cost":0.1950,
"billcost":0.0000,
"currency":"USD"
},
…
]
}
Il periodo massimo per ottenere le statistiche è di un mese. Se nella richiesta viene superato il limite, il periodo viene automaticamente ridotto a 30 giorni. Se non viene specificata la data di inizio del campione, viene selezionato l'inizio del mese corrente. Se non viene specificata la data di fine del campione, il campione è limitato alla data e all'ora correnti.
Il numero massimo di righe visualizzabili per una singola richiesta è 1000. Per la paginazione, utilizzare i parametri skip e limit.
?type=cost_only:
(Esempio 2)
Esempio 2:
{
"status":"success",
"start":"2015-06-01 00:00:00",
"end":"2015-06-29 14:03:57",
"stats":[
{
"cost":38.094,
"currency":"USD",
"seconds":9785
}
]
}
Dove:
statistiche del centralino
Attenzione: se hai bisogno di statistiche sempre aggiornate sul centralino, non è necessario richiedere ogni minuto il metodo statistics/pbx/. Attiva le notifiche webhooks e ricevi informazioni su ogni chiamata all’inizio e alla fine della stessa.
{
"status":"success",
"start":"2015-06-01 00:00:00",
"end":"2015-06-30 23:59:59",
"version":2,
"stats":[
{
"call_id":1439981389.2702773,
"sip":200,
"callstart":"2015-06-01 15:04:00",
"clid":200,
"destination":5,
"disposition":"answered",
"seconds":5,
"is_recorded":true,
"pbx_call_id":"in_ae6b03b3b0765d127ec0b739209346bbc4f0d52d"
},
…
]
}
Dove:
statistiche relative al widget di richiamata
{
"status":"success",
"start":"2016-09-01 00:00:00",
"end":"2016-09-30 23:59:59",
"stats":[
{
"id":"57d16d6a1e46c53d1f8ce323",
"widget_id":"1",
"sip":"00001",
"ip":"127.0.0.1",
"actions":[
{
"kind":"come",
"date":"2016-09-08 16:53:45",
"referrer_url":"http://test.domain.com/page1/",
"url":"http://home.domain.com/page2/"
},
{
"kind":"show",
"date":"2016-09-08 16:53:46",
"rate":15
},
{
"kind":"call_request",
"date":"2016-09-08 16:54:07",
"number":"442037691880",
"request_call_date":"2016-09-09 10:00:00",
"redial":"n"
},
{
"kind":"close",
"date":"2016-09-08 16:54:35"
}
]
},
...
]
}
Il periodo massimo per ottenere le statistiche è di un mese. Se nella richiesta viene superato il limite, il periodo viene automaticamente ridotto a 30 giorni. Se non viene specificata la data di inizio del campione, viene selezionato l'inizio del mese corrente. Se non viene specificata la data di fine del campione, il campione è limitato alla data e all'ora correnti.
Il numero massimo di righe visualizzabili per una singola richiesta è - 1000. Per la paginazione, utilizzare i parametri skip e limit.
Dove:
ottenere statistiche generali sulle chiamate in entrata
{
"status":"success",
"start":"2015-06-01 00:00:00",
"end":"2015-06-29 13:45:23",
"stats":[
{
"id":"155112249",
"sip":"00001",
"callstart":"2015-06-02 12:20:25",
"from":442037691880,
"to":442037691881,
"billseconds":0,
"disposition":"busy",
"description":"United Kingdom, London"
},
…
]
}
Il periodo massimo per ottenere le statistiche è di un mese. Se nella richiesta viene superato il limite, il periodo viene automaticamente ridotto a 30 giorni. Se non viene specificata la data di inizio del campione, viene selezionato l'inizio del mese corrente. Se non viene specificata la data di fine del campione, il campione è limitato alla data e all'ora correnti.
Il numero massimo di righe visualizzabili per una singola richiesta è - 1000. Per la paginazione, utilizzare i parametri skip e limit.
modifica dei parametri di inoltro sul numero interno del centralino
{
"status":"success",
"current_status":"on",
"pbx_id":"1234",
"pbx_name":"100",
"type":"phone",
"destination":"442037691880",
"condition":"noanswer"
}
Per attivare e configurare l'inoltro delle chiamate:
Per disattivare l'inoltro:
ottenimento dei parametri di inoltro sul numero interno del centralino
{
"status":"success",
"current_status":"on",
"pbx_id":"1234",
"pbx_name":"100",
"type":"phone",
"destination":"442037691880",
"condition":"noanswer",
}
richiesta del file di registrazione della chiamata
Nota: è sufficiente indicare uno dei due parametri di identificazione (pbx_call_id o call_id), se viene indicato il pbx_call_id, la risposta alla richiesta può contenere più link.
Esempio di risposta quando è specificato solo call_id, con un solo link:
(Esempio 1)
Esempio 1:
{
"status":"success",
"link": "https://api.zadarma.com/v1/pbx/record/download/NjM3M..NzM2Mg/1-1458313316.343456-100-2016-01-11-100155.mp3",
"lifetime_till": "2016-01-01 23:56:22"
}
Esempio di risposta quando è specificato solo pbx_call_id, possono esserci più link:
(Esempio 2)
Esempio 2:
{
"status":"success",
"links":[
"https://api.zadarma.com/v1/pbx/record/download/NjM3M..NzM2Mg/1-1458313316.343456-100-2016-01-11-100155.mp3",
"https://api.zadarma.com/v1/pbx/record/download/pw7Cj..iOzn99/1-1458313475.213487-101-2016-01-11-100211.mp3"
],
"lifetime_till": "2016-01-01 23:56:22"
}
eliminazione del file di registrazione della chiamata
Nota: è sufficiente specificare uno dei due parametri di identificazione (pbx_call_id o call_id); specificando pbx_call_id è possibile eliminare più file di registrazione.
Esempio di risposta quando è specificato solo call_id, un file è stato eliminato:
(Esempio 1)
Esempio 1:
{
"status":"success",
"file_name": "filename.mp3"
}
Esempio di risposta quando è specificato solo pbx_call_id, è possibile che vengano eliminati più file:
(Esempio 2)
Esempio 2:
{
"status":"success",
"deleted_files":[
"filename1.mp3",
"filename2.mp3"
]
}
caricamento della melodia al posto dei toni di chiamata
att/disatt la melodia per il centralino
eliminazione della melodia al posto dei toni
ottenere le impostazioni del centralino call info
{
"status": "success",
"url": "",
"notifications": {
"notify_start": "true",
"notify_internal": "false",
"notify_end": "true",
"notify_out_start": "false",
"notify_out_end": "false",
"notify_answer": "false"
}
}
modifica dell'url per centralino call info
{
"status": "success",
"url": ""
}
attivazione o disattivazione delle notifiche webhook NOTIFY_* per centralino call info
{
"status": "success",
"notifications": {
"notify_start": "true",
"notify_internal": "false",
"notify_end": "true",
"notify_out_start": "false",
"notify_out_end": "false",
"notify_answer": "false"
}
}
eliminazione url per centralino call info
{
"status": "success",
"url": ""
}
creazione del centralino
{
"status": "success",
"stop_datetime": "2021-12-31 23:59:59"
}
ottenere le impostazioni del centralino webhooks
{
"status": "success",
"url": "",
"hooks": {
"number_lookup": "true",
"call_tracking": "false",
"sms": "true",
"speech_recognition": "true"
}
}
modifica dell'url per centralino webhooks
{
"status": "success",
"url": ""
}
attivazione o disattivazione di altre notifiche webhook (Aggiornamento contatti, Call tracking, SMS e Analisi vocale)
{
"status": "success",
"hooks": {
"number_lookup": "true",
"call_tracking": "false",
"sms": "true",
"speech_recognition": "true"
}
}
eliminazione dell'url per altre notifiche (aggiornamento dei contatti, call tracking, SMS e analisi vocale)
{
"status": "success",
"url": ""
}
visualizzazione dei numeri interni del centralino
{
"status":"success",
"pbx_id":1234,
"numbers": [
100,
101,
...
]
}
Dove:
stato online del numero interno del centralino
{
"status":"success",
"pbx_id":1234,
"number":100,
"is_online":"false"
}
Dove:
informazioni sul numero interno del centralino
{
"status": "success",
"pbx_id": 12345,
"number": 100,
"name": "Extension 100",
"caller_id": "+44000000000",
"caller_id_app_change": "true",
"caller_id_by_direction": "false",
"lines": "3",
"ip_restriction": "1.1.1.1",
"record_store": "For automatic speech recognition",
"record_email": "email@server.com",
"supervisor_status": 1
}
dove:
attivazione della registrazione delle chiamate sul numero interno del centralino
{
"status":"success",
"internal_number":100,
"recording":"on",
"email":"test@test.com",
"speech_recognition":"all"
}
Parametri
creazione di un numero di centralino
{
"status": "success",
"numbers": [
{
"number": 200,
"password": "PASSWORD"
},
{
"number": 201,
"password": "PASSWORD"
}
]
}
richiesta della password del numero interno del centralino, la password è disponibile per la visualizzazione per un periodo di tempo limitato
{
"status": "success",
"pbx_id": 114,
"number": 200,
"password": "PASSWORD"
}
cambio password sul numero interno
{
"status": "success",
"pbx_id": 114,
"number": 200
}
attivazione della modalità supervisore sul numero interno del centralino
Parametri
elenco dei file già caricati per il saluto vocale (IVR)
caricamento del file
eliminazione del file tramite ID
elenco IVR
{
"status": "success",
"pbx_id": 114,
"ivrs": [
{
"menu_id": "0",
"title": "",
"type": "file",
"status": "on",
"waitexten": 5,
"auto_responder": {
"status": "on",
"waitexten": 1,
"working_days": [
{
"day": "mon",
"is_active": true,
"begin": {
"hour": 9,
"minute": 0
},
"end": {
"hour": 18,
"minute": 0
}
},
{
"day": "tue",
"is_active": true,
"begin": {
"hour": 9,
"minute": 0
},
"end": {
"hour": 18,
"minute": 0
}
},
...
{
"day": "sun",
"is_active": false
}
]
},
"dinner_status": "on",
"dinner_time": {
"begin": {
"hour": 12,
"minute": 0
},
"end": {
"hour": 13,
"minute": 0
}
}
},
{
"menu_id": "1",
"title": "Menu 1",
"type": "readtext",
"status": "off",
"waitexten": 5,
"auto_responder": {
"status": "off",
"waitexten": 1
}
},
...
]
}
creare IVR
{
"status": "success",
"menu_id": 2
}
eliminazione IVR
{
"status": "success"
}
elenco degli scenari IVR
{
"status": "success",
"scenarios": [
{
"id": "132",
"title": "-1",
"push_button": -1,
"first_sips": [
"102"
],
"second_sips": [],
"second_sips_delay": 10,
"third_sips": [],
"third_sips_delay": 20
},
...
]
}
creazione di uno scenario IVR
{
"status": "success",
"menu_id": 0,
"scenario_id": 2
}
modifica dello scenario IVR
(Esempio 1)
Esempio 1:
[
"id": "630cb6b3dc666e947503a77a",
"title": "Scenario 1",
"queue_strategy": "off",
"queue_announce_position": 0,
"numbers": [
[
"number": 100,
"delay": 0,
"duration": 20
],
[
"number": 101,
"delay": 20,
"duration": 20
],
[
"number": 102,
"delay": 40,
"duration": 20
],
]
]
Descrizione delle strategie di distribuzione delle chiamate ai numeri interni in coda:
I parametri di ritardo e durata delle chiamate ai numeri interni vengono utilizzati solo con la coda disattivata (queue_strategy : "off").
Risposta: (Esempio 2)
Esempio 2:
{"status": "success"}
Errore: (Esempio 3)
Esempio 3:
{"status": "error","message": "Wrong parameters!"} eliminazione dello scenario IVR
{
"status": "success"
}
ottenimento dei risultati del riconoscimento
{
"status":"success",
"lang":"en-EN",
"recognitionStatus":"in progress",
"otherLangs":["es-ES"],
"words": [
{
"result": [
{
"s": 0.02,
"e": 0.22,
"w": "word",
},
{
"s": 0.31,
"e": 0.56,
"w": "one",
}
],
"channel": 1
}
],
"phrases":[
{
"result": "word one",
"channel": 1
}
]
}
L’attivazione del riconoscimento delle chiamate nelle statistiche del centralino richiede che il riconoscimento selettivo sia stato attivato in precedenza nelle impostazioni del numero interno.
{
"status":"success"
}
informazioni sui numeri virtuali dell'utente
{
"status":"success",
"info": [
{
"number":"442030000000",
"status":"on",
"country":"United Kingdom",
"description":"London",
"number_name":null,
"sip":00001,
"sip_name":null,
"start_date":"2015-01-01 18:14:44",
"stop_date":"2016-02-11 18:14:40",
"monthly_fee":2,
"currency":USD,
"channels":2,
"autorenew":"true",
"is_on_test":"false",
"type":"common"
},
...
]
}
A seconda del tipo di numero, l'insieme dei campi può variare! Descrizione dei campi:
informazioni sul numero acquistato
{
"status": "success",
"info": {
"number": "35924913550",
"status": "on",
"country": "Bulgaria",
"description": "Sofia",
"number_name": "TT",
"sip": "00004",
"sip_name": "SIP",
"start_date": "2016-06-08 14:32:17",
"stop_date": "2016-06-29 10:52:18",
"monthly_fee": 2,
"currency": "USD",
"channels": "2",
"autorenew": "true",
"receive_sms": null,
"is_on_test": "false"
}
}
stato di rinnovo automatico
{
"status": "success",
"number": "35924913550",
"autoprolongation": "on"
}
ricezione di informazioni relative al documento o errore di verifica dell'indirizzo
{
"status":"success",
"info":{
"wrong_document":{
"document_type":"contract",
"message":"The passport has expired. It is considered invalid."
},
"wrong_address":{
"message":"Invalid address"
}
}
}
modificare lo stato del rinnovo automatico
{
"status": "success",
"number": "35924913550",
"autoprolongation": "off"
}
elenco dei Paesi in cui è possibile collegare il numero
{
"status": "success",
"info": [
{
"countryCode": "61",
"countryCodeIso": "AU",
"name": "Australia"
},
...
]
}
elenco delle destinazioni nel Paese in cui è possibile collegare il numero
{
"status": "success",
"info": [
{
"id": "3753",
"countryCode": "49",
"areaCode": "800",
"name": "800 number (Toll-free)",
"connect_fee": 0,
"monthly_fee": 15,
"currency": "USD",
"restrictions": {
"upload": [
"Certificate of registration copy or passport or ID copy (both sides)",
"Proof of address (a copy of utility bill no older than of 6 months) -
your current address (city, street, number and postal code).
The address must be located in the country of ordered phone number"
]
},
"receive_sms": "false",
"is_toll": "true",
"feature": "Available from all networks"
"connect_time": "0"
},
{
"id": "3766",
"countryCode": "49",
"areaCode": "821",
"name": "Augsburg",
"connect_fee": 3,
"monthly_fee": 3,
"currency": "USD",
"restrictions": {
"upload": [
"Passport or ID copy (both sides)"
],
"specify": [
"You current address (city, street, number and postal code).
The address must be located in the region of the city
where you ordered the phone number"
]
},
"receive_sms": "false",
"is_toll": "false",
"feature": null,
"connect_time": "0"
},
...
]
}
Impostazione del Nome del Numero (alfabeto latino e numeri, fino a 30 caratteri)
{
"status": "success",
"number": "+44000000000",
"caller_name": "test"
}
collegamento del numero al sip o attivazione della modalità di prova
{
"status": "success",
"number": "+44000000000",
"sip_id": "00001"
}
numeri disponibili per l'ordine
{
'status': 'success',
'numbers': [
{
'id': 1712p0D1643D0t42r198658,
'direction_id': 13755,
'number': '+44000000001'
},
{
'id': 184bdf85006c3f1676be200,
'direction_id': 13755,
'number': '+44000000000'
},
...
]
}
Ordine/acquisto di un numero
{
'status': 'success',
'number': '+44000000000',
'is_reserved': 'false',
'is_activated': 'true'
}
pagamento anticipato del numero per il numero di mesi indicato
{
'status': 'success',
'number': '+44000000000',
'stop_date': '2021-05-01 12:00:00',
'total_paid': {
'amount': 2,
'currency': 'USD'
}
}
attivazione della ricezione SMS (solo se il numero supporta la ricezione SMS)
{
"status": "success",
"number": "",
"receive_sms": "on"
}
Parametri:
ottenere informazioni sulla possibilità di aumentare i canali in entrata su un numero virtuale
{
"status": "success"
}
Uno dei parametri è obbligatorio
Opzionale
aumento del numero di linee
{
"status": "success"
}
elenco dei file/documenti nel gruppo di documenti
{
"status": "success",
"documents": [
{
"type": "passport",
"is_verified": "true",
"source": "upload",
"name": "file1.jpg"
},
{
"type": "receipt",
"is_verified": "false",
"source": "upload",
"name": "file2.jpg"
}
]
}
elenco dei gruppi di documenti
{
"status": "success",
"groups": [
{
"id": 0,
"email": "email@server.com",
"salutation": 'MR',
"nationality": null,
"first_name": "John",
"middle_name": "Richard",
"last_name": "Smith",
"organization": "Company",
"organization_description": null,
"organization_reg_number": null,
"country": "DE",
"region": "",
"city": "Berlin",
"address": "Brudden Strasse 8, 76611",
"zip_code": '76611',
"street": 'Brudden Strasse',
"street_code": null,
"municipality_code": null,
"building_number": "8",
"building_letter": null,
"phone": "4900000000",
"type_of_id": "",
"id_number": "123000099",
"issuing_authority": null,
"issuing_date": null,
"is_readonly": true
}
]
}
dati relativi a un gruppo specifico
{
"status": "success",
"group": {
"id": 0,
"email": "email@server.com",
"salutation": 'MR',
"nationality": null,
"first_name": "John",
"middle_name": "Richard",
"last_name": "Smith",
"organization": "Company",
"organization_description": null,
"organization_reg_number": null,
"country": "DE",
"region": "",
"city": "Berlin",
"address": "Brudden Strasse 8, 76611",
"zip_code": '76611',
"street": 'Brudden Strasse',
"street_code": null,
"municipality_code": null,
"building_number": "8",
"building_letter": null,
"phone": "4900000000",
"type_of_id": "",
"id_number": "123000099",
"issuing_authority": null,
"issuing_date": null,
"is_readonly": true
}
}
verifica: se il gruppo di documenti è valido per una città o destinazione specifica
{
"status": "success",
"is_information_match": "true",
"is_documents_uploaded": "true",
"is_documents_verified": "true",
"is_address_match": "true"
}
creazione di un nuovo gruppo di documenti
{
"status": "success",
"group": {
"id": 0,
"email": "email@server.com",
"salutation": 'MR',
"nationality": null,
"first_name": "John",
"middle_name": "Richard",
"last_name": "Smith",
"organization": "Company",
"organization_description": null,
"organization_reg_number": null,
"country": "DE",
"region": "",
"city": "Berlin",
"address": "Brudden Strasse 8, 76611",
"zip_code": '76611',
"street": 'Brudden Strasse',
"street_code": null,
"municipality_code": null,
"building_number": "8",
"building_letter": null,
"phone": "4900000000",
"type_of_id": "",
"id_number": "123000099",
"issuing_authority": null,
"issuing_date": null,
"is_readonly": true
}
}
aggiornamento dei dati di un gruppo di documenti
{
"status": "success",
"group": {
"id": 0,
"email": "email@server.com",
"salutation": 'MR',
"nationality": null,
"first_name": "John",
"middle_name": "Richard",
"last_name": "Smith",
"organization": "Company",
"organization_description": null,
"organization_reg_number": null,
"country": "DE",
"region": "",
"city": "Berlin",
"address": "Brudden Strasse 8, 76611",
"zip_code": '76611',
"street": 'Brudden Strasse',
"street_code": null,
"municipality_code": null,
"building_number": "8",
"building_letter": null,
"phone": "4900000000",
"type_of_id": "",
"id_number": "123000099",
"issuing_authority": null,
"issuing_date": null,
"is_readonly": true
}
}
caricare file per il gruppo di documenti
$zd = new \Zadarma_API_Test\Api(KEY, SECRET);
$zd->request(
'documents/upload',
[
'group_id' => 0,
'document_type' => 'passport',
'file' => new CURLFile('passport.jpg', 'image/jpeg', 'passport.jpg')
],
'post'
);
{
"status": "success",
"message": "The File passport.jpg has been successfully uploaded to the website.",
"doc_name": "passport.jpg"
} informazioni sull'account del rivenditore
{
"status": "success",
"balance": 123,
"credit": 0,
"currency": "USD",
"reseller_fee": 10,
"user_fee": 10
} Trasferire il saldo dal conto del rivenditore al saldo di un altro conto collegato o viceversa
{
"status": "success",
"user": {
"balance": "62.0000",
"currency": "EUR"
},
"reseller": {
"balance": "94.825",
"currency": "USD"
}
}
Elenco dei numeri di telefono di contatto dell'utente
{
"status": "success",
"list": [
{
"id": 0,
"number": "49025000897",
"is_proved": false
}
]
}
Aggiunta del numero di telefono di contatto dell'utente
{
"status": "success",
"id": 98,
"number": "359000000001",
"is_proved": true
}
Modifica del numero di telefono di contatto dell'utente
{
"status": "success",
"id": 99,
"number": "359000000002",
"is_proved": false
}
Richiesta di conferma del numero di telefono di contatto dell'utente
{
"number": "359000000002",
"status": "success",
"message": "You were sent an SMS message with a code. Code is valid for 1 hour."
}
Richiesta di conferma del numero di telefono dell'utente (verrà effettuata una chiamata e, una volta risposto, l'utente sentirà un codice di conferma)
{
"number": "359000000002",
"status": "success",
"message": "You were sent an SMS message with a code. Code is valid for 1 hour."
}
Conferma del numero di contatto tramite codice SMS
{
"status": "success",
"message": "Your number confirmed!",
"number": "35900000019"
}
Registrazione utente
{
"status": "success",
"user_id": 12345,
"message": "You registered a new user in the system."
},{
"status": "success",
"message": "You registered a new user in the system. A registration confirmation link was sent to the email address you provided. To activate the account the user needs to click on that link, after which they can log in on the website."
},{
"status": "success",
"message": "You registered a new user in the system. A registration confirmation code was sent to the email address you provided. To activate the account the user needs to send code to you, after which you can confirm registration using API."
}
Conferma della registrazione dell'utente
{
"status": "success",
"user_id": 12345
}
Elenco degli utenti del rivenditore visualizzati per pagina (50 pezzi)
{
"status": "success",
"total": 205,
"total_pages": 5,
"page": 1,
"users": [
{
"id": "1234",
"email": "test@domain.com",
"first_name": "Test",
"last_name": "Test",
"organization": "",
"phone": "+44000000001",
"created": "2021-01-26 14:21:04",
"last_login": "2021-01-30 09:46:31",
"balance": "0.4000",
"currency": "GBP",
"sips_count": "1",
"is_active": true,
"allow_topup": true,
"allow_api_requests": true
},
...
]
}
Ricerca di un account utente in base a un criterio (uno tra id, email, sip)
{
"status": "success",
"user": {
"id": "1234",
"email": "test@domain.com",
"first_name": "Test",
"last_name": "Test",
"organization": "",
"phone": "+44000000001",
"created": "2021-01-26 14:21:04",
"last_login": "2021-01-30 09:46:31",
"balance": "0.4000",
"currency": "GBP",
"sips_count": "1",
"is_active": true,
"allow_topup": true,
"allow_api_requests": true
}
}
Trasferire il saldo dal conto del rivenditore al conto utente
{
"status": "success",
"user_topup": {
"amount": 10,
"currency": "GBP"
},
"reseller_withdraw": {
"amount": 10,
"currency": "GBP"
}
}
Ottenere le chiavi di accesso API correnti dell’utente
{
"status": "success",
"user_id": 1234,
"last_request_datetime": "2021-02-18 10:45:01",
"allow_reset": true,
"key": "hidden",
"secret": "hidden"
},{
"status": "success",
"user_id": 1234,
"last_request_datetime": "2021-02-26 15:59:50",
"allow_reset": false,
"key": "abscd",
"secret": "12345"
}
Ottenere nuove chiavi di accesso API dell’utente
{
"status": "success",
"user_id": 1234,
"key": "abscd",
"secret": "12345"
}
invio di SMS
{
"status":"success",
"messages":1,
"cost":0.24,
"currency":"USD",
"sms_detalization":[
{
"senderid":"xxxxxxxxxxx",
"number":"1234567890",
"cost":0.06
}
],
"denied_numbers":[
{
"number":"1234567890",
"message":"The reason for the SMS not being sent to the number"
}
]
}
Parametri
Ottenere l'elenco dei modelli per SMS
{
"list": [
{
"cath_id":"1",
"title":"The name of the template category",
"templates": [
{
"id":"1",
"text":"The template text with a variable {$var}"
},
{
"id":"2",
"text":"Second template text"
},
]
}
]
}
Ottenere l'elenco dei mittenti SMS autorizzati per un numero specificato
{
"senders": ["Teamsale", "1234567890"]
}
ottenere la chiave per il widget webrtc. La durata della chiave è di 72 ore.
{
"status":"success",
"key": YOUR_KEY
}
Parametri:
Creazione dell'integrazione del widget WebRTC
{
"status": "success"
}
Modifica delle impostazioni di integrazione del widget WebRTC
{
"status": "success"
}
Dati di integrazione del widget WebRTC
{
"status": "success",
"is_exists": true,
"domains": [
"test.domain.com"
],
"settings": {
"shape": "square",
"position": "top_right"
}
}
Aggiungere dominio all'integrazione del widget WebRTC
{
"status": "success"
}
Eliminazione del dominio dall'integrazione del widget WebRTC
{
"status": "success"
}
Eliminazione dell'integrazione del widget WebRTC
{
"status": "success"
}
Elenco dei dispositivi supportati per eSIM
Descrizione della risposta positiva (Esempio 1)
Esempio 1:
{
"status": "success",
"devices": {
"acer": [
"ACER Swift 3",
"ACER Swift 7"
],
"asus": [
"ASUS Mini Transformer T103HAF",
"ASUS NovaGo TP370QL",
"ASUS Vivobook Flip 14 TP401NA"
],
"xiaomi": [
"Xiaomi 12T Pro",
"Xiaomi 13 Lite"
]
}
}
Descrizione della risposta in caso di errore interno (Esempio 2)
Esempio 2:
{
"status": "error",
"message": "Getting devices internal error"
}
Elenco di tutti i pacchetti disponibili
Descrizione della risposta positiva (Esempio 1)
Esempio 1:
{
"status": "success",
"packages": [
{
"duration": 7,
"countries": [
{
"iso2": "cn",
"name": "China",
"aliases": []
}
],
"networks": [
{
"iso2": "CN",
"network": "China Unicom",
"type": "LTE"
}
],
"region": null,
"id": "1-cn-7days-1gb",
"price": 5,
"data": 1,
"duration_unit": "days",
"data_unit": "GB",
"top_up": true,
"kyc_verify": false,
"activation_policy": "first-usage",
"activation_limit_days": null,
"price_multi_currency": {
"eur": 5,
"usd": 5,
"gbp": 4,
"pln": 19,
"kzt": 2000,
"uah": 200
},
}
]
}
Descrizione della risposta in caso di errore interno (Esempio 2)
Esempio 2:
{
"status": "error",
"message": "Getting packages error"
}
Elenco dei pacchetti collegati
Parametri
Descrizione della risposta corretta (Esempio 1)
Esempio 1:
{
"status": "success",
"orders": [
{
"iccid": "8937204017175532566",
"status": "inactive",
"packages": [
{
"iccid": "8937204017175532566",
"price": 4.5,
"currency": "USD",
"countries": [
{
"iso2": "al",
"name": "Albania",
"aliases": []
}
],
"duration": 30,
"data": 1,
"region": null,
"id": "3-al-30days-1gb",
"data_remaining": 1,
"top_up": true,
"created_at": 1730978058,
"auto_prolong": false,
"activated_at": null,
"expired_at": null,
"reference_id": "672ca10a84a28e977c0cfe39"
}
],
"title": null,
"msisdn": null,
"activation_code": "LPA:1$smdp.io$K2-2627GZ-1UM3Z3Y",
"created_at": 1730978058
}
]
}
Descrizione della risposta in caso di user_id non corretto (Esempio 2)
Esempio 2:
{
"status": "error",
"message": "You are not a reseller of the requested user"
}
Informazioni sul pacchetto collegato tramite ICCID
Parametri
Descrizione della risposta positiva (Esempio 1)
Esempio 1:
{
"status": "success",
"order": {
"iccid": "8937204017175532566",
"status": "inactive",
"packages": [
{
"iccid": "8937204017175532566",
"price": 4.5,
"currency": "USD",
"countries": [
{
"iso2": "al",
"name": "Albania",
"aliases": []
}
],
"duration": 30,
"data": 1,
"type": "one-off",
"region": null,
"id": "3-al-30days-1gb",
"data_remaining": 1,
"top_up": true,
"created_at": 1730978058,
"auto_prolong": false,
"activated_at": null,
"expired_at": null,
"reference_id": "672ca10a84a28e977c0cfe39"
}
],
"title": null,
"msisdn": null,
"activation_code": "LPA:1$smdp.io$K2-2627GZ-1UM3Z3Y",
"created_at": 1730978058
}
}
Descrizione della risposta di errore in caso di invio di un ICCID inesistente (Esempio 2)
Esempio 2:
{
"status": "error",
"message": "Not found"
}
Collega il pacchetto
Descrizione della risposta corretta (Esempio 1)
Esempio 1:
{
"status": "success",
"order": {
"iccid": "8937204016150824154",
"activation_code": "LPA:1$smdp.io$K2-1UYQA7-Z8B3BF",
"status": "inactive",
"packages": [
{
"iccid": "8937204016150824154",
"price": 11.01,
"currency": "EUR",
"countries": [
{
"iso2": "us",
"name": "США",
"aliases": []
}
],
"duration": 30,
"data": 0,
"data_remaining": 0,
"top_up": true,
"type": "one-off",
"region": "change",
"created_at": 1720700977,
"auto_prolong": false,
"activated_at": null,
"expired_at": null,
"reference_id": null,
"id": "3-change-30days-0gb"
}
],
"created_at": 1720700977,
"title": null,
"msisdn": null
}
}
Descrizione della risposta con errore in caso di saldo insufficiente (Esempio 2)
Esempio 2:
{
"status": "error",
"message": "Not enough money on your account"
}
Richiesta di verifica con invio di una notifica all'utente
Il tempo di validità della richiesta di verifica è di 10 minuti.
Al numero del destinatario verrà inviato un SMS con un codice di conferma. L'invio tramite questo canale potrebbe richiedere un pagamento, pertanto l'utente API deve disporre di un saldo positivo.
Parametri
Quando si seleziona questo canale, viene effettuata una chiamata al numero del destinatario, durante la quale viene comunicato all'utente il codice di conferma. L'invio tramite questo canale può richiedere un pagamento, pertanto l'utente API deve disporre di un saldo positivo.
Per utilizzare questo canale, l'utente API deve avere un numero registrato nel sistema Zadarma.
Parametri
Utilizzando questo canale, all’indirizzo e-mail indicato viene inviato un messaggio con il codice di conferma. Per l’invio tramite questo canale, l’utente API deve avere l’integrazione e-mail attivata nel sistema CRM Teamsale.
Parametri
Questo canale prevede una chiamata al numero del destinatario, durante la quale l'utente deve seguire le istruzioni fornite dai file audio e premere il tasto "1" per confermare. L'invio tramite questo canale potrebbe richiedere un pagamento, pertanto l'utente API deve disporre di un saldo positivo.
Per utilizzare questo canale è necessario
Caratteristiche: Il risultato della verifica tramite questo canale viene controllato utilizzando NOTIFY_OUT_END webhook, e non con il metodo /v1/verify/check/.
Parametri
Per gestire i file audio utilizzati nelle impostazioni greeting_sound_id, button_1_sound_id e fallback_sound_id, utilizzare i metodi API disponibili nella sezione /v1/pbx/ivr/sounds/*.
Se la richiesta è stata inviata correttamente tramite i canali sms, call_code, email (Esempio 1)
Esempio 1:
{
"status": "success",
"request_id": "NDlLMWlNcW5mR3EvOFkraWVtOWF1Q2c9"
}
Quando si utilizza il canale call_button La risposta corretta non contiene request_id, poiché la verifica del risultato viene effettuata tramite NOTIFY_OUT_END webhook (Esempio 2)
Esempio 2:
{
"status": "success"
}
In caso di richiesta non valida, l'API restituisce una risposta con lo stato error e la descrizione dell'errore nel campo message (Esempio 3)
Esempio 3:
{
"status": "error",
"message": "\"to\" param is required"
}.
Quando si invia una richiesta tramite il canale email, se il parametro from è obbligatorio ma non è stato specificato, il sistema restituirà una risposta con lo stato "error" e un messaggio che indica la mancanza del parametro richiesto (Esempio 4)
Esempio 4:
{
"status": "error",
"message": "Can't find active email integration for the \"from\" param's email"
}. Verifica del codice nella richiesta di verifica per i canali sms, call_code ed email
Descrizione della risposta positiva, se il parametro code corrisponde a quello nella richiesta di verifica (Esempio 1)
Esempio 1:
{
"status": "success",
"message": "Code is correct"
}
Descrizione della risposta con errore se la richiesta è scaduta o non è stata trovata la richiesta per request_id: (Esempio 2)
Esempio 2:
{
"status": "error",
"message": "No such request id"
}
Descrizione della risposta con errore se il parametro code non corrisponde a quello nella richiesta (Esempio 3)
Esempio 3:
{
"status": "error",
"message": "Invalid verification code"
}
Per verificare il canale call_button è necessario utilizzare NOTIFY_OUT_END webhook
Restituisce l'elenco dei clienti
(Esempio 1)
Esempio 1:
{
"status": "company",
"type": "client",
"country": "GB",
"city": "London",
"label": 12,
"utm": 19,
"employees_count": "50",
"responsible": 20
}
Dove:
responsible — responsabile (identificativo utente)
Qualsiasi parametro del filtro può essere omesso, ovvero non è obbligatorio.
(Esempio 2)
Esempio 2:
{
"attr": "name",
"desc": 0
}
Dove:
(Esempio 3)
Esempio 3:
{
"totalCount": 82,
"customers": [
{
"id": 65,
"name": "Good company",
"status": "company",
"type": "client",
"responsible_user_id": 20,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"created_at": "2020-04-28 05:47:47",
"created_by": 20,
"lead_source": "manual",
"lead_created_at": null,
"lead_created_by": null,
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{
"id": 12,
"label": "Best clients"
}
],
"utms": [
{
"id": 19,
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
]
}
]
}
Dove:
YYYY-MM-DD HH:mm:ss)YYYY-MM-DD HH:mm:ss)Restituisce il cliente in base al suo ID
{
"id": 65,
"name": "Good Company",
"status": "company",
"type": "client",
"responsible_user_id": 20,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"created_at": "2020-04-28 05:47:47",
"created_by": 20,
"lead_source": "manual",
"lead_created_at": null,
"lead_created_by": null,
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{
"id": 12,
"label": "Best clients"
}
],
"utms": [
{
"id": 19,
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
],
"custom_properties": [
{
"id": 18,
"key": "loyalty",
"title": "Loyalty",
"value": "high"
}
]
}
Dove:
YYYY-MM-DD HH:mm:ss)YYYY-MM-DD HH:mm:ss)Crea un nuovo cliente con i dati specificati
customer — oggetto con i parametri del nuovo cliente. Struttura dell'oggetto:
(Esempio 1)
Esempio 1:
{
"customer": {
"name": "Good Company",
"status": "company",
"type": "client",
"responsible_user_id": 20,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"lead_source": "manual",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{ "id": 12 },
{ "id": 13 }
],
"utms": [
{ "id": 19 },
{ "id": 20 }
],
"custom_properties": [
{
"id": 18,
"value": "high"
}
]
}
}
Dove:
name — nome del cliente
status — stato del cliente. Valori consentiti:
individual — persona fisica
company — azienda
type — tipo di cliente. Valori consentiti:
client — cliente
reseller — rivenditore
partner — partner
responsible_user_id — responsabile (identificativo utente)
employees_count — numero di dipendenti. Valori ammessi:
50 — meno di 50
comment — descrizione del cliente
country — Paese del cliente. Codice a due lettere (IT, US, ecc.)
city — città del cliente
address — indirizzo del cliente
zip — codice postale
website — sito web del cliente
lead_source — fonte. Valori consentiti:
manual — manualmente
phones — matrice di numeri di telefono. Ogni numero deve contenere i seguenti campi:
type — tipo di numero. Valori possibili:
work — di lavoro
personal — personale
phone — valore del numero
contacts — array dei contatti del cliente. Ogni contatto deve contenere i seguenti campi:
type — tipo di contatto. Valori possibili:
email_work — e-mail di lavoro
email_personal — e-mail personale
labels — array di tag aggiunti al cliente. Ogni elemento deve contenere:
id — identificativo del tag esistente
utms — array delle etichette di origine. Ogni elemento deve contenere:
id — identificativo della proprietà aggiuntiva oppure:
key — nome univoco della proprietà aggiuntiva
value — valore della proprietà aggiuntiva
(Esempio 2)
Esempio 2:
{
"id": 65
}
Dove:
Aggiorna il cliente esistente con l'ID specificato
{
"customer": {
"name": "Good Company",
"status": "company",
"type": "client",
"responsible_user_id": 20,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"lead_source": "manual",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{ "id": 12 },
{ "id": 13 }
],
"utms": [
{ "id": 19 },
{ "id": 20 }
],
"custom_properties": [
{
"id": 18,
"value": "high"
}
]
}
}
Dove:
Elimina il cliente in base al suo ID
Restituisce un array di tutti i tag di origine e le relative statistiche
[
{
"id": 78,
"param": "utm_source",
"value": "google",
"display_value": "Google",
"count": 1267
}
]
Dove ogni etichetta della fonte contiene i seguenti campi:
Crea un nuovo tag di origine
utm — oggetto con i dati del nuova etichetta di fonte. Struttura dell'oggetto: (Esempio 1)
Esempio 1:
{
"utm": {
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
}
Dove:
param — tipo dell'etichetta della fonte. Valori consentiti:
(Esempio 2)
Esempio 2:
{
"id": 78
}
Dove:
Aggiorna l'etichetta esistente della fonte con l'ID specificato
{
"utm": {
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
}
Dove:
Rimuove il tag della fonte dal sistema in base al suo ID
Restituisce l'elenco di tutti i tag e le relative statistiche.
{
"totalCount": 5,
"labels": [
{
"id": 12,
"label": "Best clients",
"count": 14
}
]
}
Dove:
Crea un nuovo tag
{
"id": 13,
"label": "Very best clients",
"count": 0
}
Dove:
Rimuove il tag dal sistema in base al suo ID
Restituisce tutti i parametri aggiuntivi
{
"totalCount": 8,
"customProperties": [
{
"id": 18,
"key": "loyalty",
"title": "Loyalty"
}
]
}
Dove:
Restituisce i record nel feed del cliente
{
"totalCount": 17,
"items": [
{
"id": 37825,
"type": "note",
"content": "Call to the client",
"time": "2020-06-08 06:55:02",
"user_id": 20,
"user_name": "John Beam",
"call_id": null,
"call_type": null,
"call_status": null,
"call_phone": null,
"call_duration": null,
"call_record": null,
"call_contact_name": null,
"attached_files": [
{
"file_id": 576,
"original_filename": "document.doc"
}
]
}
]
}
Dove:
YYYY-MM-DD hh:mm:ssAggiunge una nota testuale nel feed del cliente con la possibilità di allegare file
{
"id": 37825,
"type": "note",
"content": "Call to the client",
"time": "2020-06-08 06:55:02",
"user_id": 20,
"user_name": "John Beam",
"attached_files": [
{
"file_id": 576,
"original_filename": "document.doc"
}
]
}
Dove:
YYYY-MM-DD hh:mm:ssAggiorna il contenuto di una nota di testo esistente in base al suo ID
Elimina la nota dal feed del cliente in base al suo ID.
Restituisce l'elenco dei dipendenti del cliente in base al suo ID.
{
"totalCount": 5,
"employees": [
{
"id": 23,
"customer_id": 11,
"name": "Steven Knight",
"position": "manager",
"position_title": "",
"comment": "",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "s.knight@example.com"
}
]
}
]
}
Dove:
Restituisce il dipendente del cliente in base al suo ID
{
"id": 23,
"customer_id": 11,
"name": "Steven Knight",
"position": "manager",
"position_title": "",
"comment": "",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "s.knight@example.com"
}
]
}
Dove:
Crea e salva un nuovo dipendente per il cliente specificato
(Esempio 1)
Esempio 1:
{
"employee": {
"name": "Steven Knight",
"position": "manager",
"position_title": "",
"comment": "",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "s.knight@example.com"
}
]
}
}
Dove:
(Esempio 2)
Esempio 2:
{
"id": 23
}
Dove:
Aggiorna il dipendente esistente con l'ID specificato
{
"employee": {
"name": "Steven Knight",
"position": "manager",
"position_title": "",
"comment": "",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "john@example.com"
}
]
}
}
Dove:
Elimina il dipendente in base al suo ID
Restituisce l'elenco dei lead
(Esempio 1)
Esempio 1:
{
"filter": {
"source": "call_incoming",
"responsible": 32,
"label": 12,
"utm": 19,
"createdAfter": "2020-06-11 12:24:00",
"createdBefore": "2020-06-26 12:24:00"
}
}
Dove:
YYYY-MM-DD hh:mm:ss)createdBefore — mostra solo i lead creati prima dell'ora specificata (formato: YYYY-MM-DD hh:mm:ss)
Qualsiasi parametro del filtro può essere omesso, ovvero non è obbligatorio.
(Esempio 2)
Esempio 2:
{
"sort": {
"attr": "name",
"desc": 0
}
}
Dove:
(Esempio 3)
Esempio 3:
{
"totalCount": 100,
"uncategorizedCount": 10,
"leads": [
{
"id": 3486,
"name": "Good Company",
"responsible_user_id": 234,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"lead_status": "not_processed",
"lead_source": "manual",
"lead_created_at": "2020-04-28 05:47:47",
"lead_created_by": 234,
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{
"id": 22,
"label": "Best clients"
}
],
"utms": [
{
"id": 19,
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
]
}
]
}
Dove:
YYYY-MM-DD HH:mm:ss)Restituisce il lead in base al suo ID
{
"id": 3486,
"name": "Good Company",
"responsible_user_id": 234,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"lead_status": "not_processed",
"lead_source": "manual",
"lead_created_at": "2020-04-28 05:47:47",
"lead_created_by": 234,
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{
"id": 22,
"label": "Best clients"
}
],
"utms": [
{
"id": 19,
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
],
"custom_properties": [
{
"id": 12,
"key": "loyalty",
"title": "Loyalty",
"value": "high"
}
]
}
Dove:
YYYY-MM-DD HH:mm:ss)Crea un nuovo lead con i dati specificati
(Esempio 1)
Esempio 1:
{
"lead": {
"name": "Good Company",
"responsible_user_id": 234,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"lead_source": "manual",
"lead_status": "in_progress",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{ "id": 22 },
{ "id": 23 }
],
"utms": [
{ "id": 19 },
{ "id": 20 }
],
"custom_properties": [
{
"id": 12,
"value": "high"
}
]
}
}
Dove:
(Esempio 2)
Esempio 2:
{
"id": 123
}
Dove:
Aggiorna il lead esistente con l'ID specificato
{
"lead": {
"name": "Good Company",
"responsible_user_id": 234,
"employees_count": "50",
"comment": "",
"country": "GB",
"city": "London",
"address": "",
"zip": "",
"website": "",
"lead_source": "manual",
"lead_status": "in_progress",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "good_company@example.com"
}
],
"labels": [
{ "id": 22 },
{ "id": 23 }
],
"utms": [
{ "id": 19 },
{ "id": 20 }
],
"custom_properties": [
{
"id": 12,
"value": "high"
}
]
}
}
Dove:
Elimina il lead in base al suo ID
Restituisce l'elenco degli utenti
{
"totalCount": 2,
"users": [
{
"id": 234,
"email": "john@example.com",
"name": "John Beam",
"group_id": 653,
"is_superadmin": 1,
"enabled": 1,
"created_at": "2020-04-27 01:01:31",
"avatar": 2457,
"role": "",
"status": "",
"language": "en",
"color": "220",
"color_hex": "5678BD",
"internal_number": "100",
"timezone": "Europe/London",
"first_day": 1,
"device": "webphone",
"phone_widget_location": "right",
"phones": [
{
"phone": "+44123456789",
"type": "work"
}
],
"contacts": [
{
"type": "email_work",
"value": "ivanov@example.com"
}
]
}
]
}
Dove:
YYYY-MM-DD hh:mm:ss)Restituisce l'utente in base al suo ID
{
"id": 234,
"email": "john@example.com",
"name": "John Beam",
"group_id": 653,
"is_superadmin": 1,
"enabled": 1,
"created_at": "2020-04-27 01:01:31",
"avatar": 2457,
"role": "",
"status": "",
"language": "en",
"color": "220",
"color_hex": "5678BD",
"internal_number": "100",
"timezone": "Europe/London",
"first_day": 1,
"device": "webphone",
"phone_widget_location": "right",
"phones": [
{
"phone": "+44123456789",
"type": "work"
}
],
"contacts": [
{
"type": "email_work",
"value": "simpson@example.com"
}
],
"pending_email_change_request": false
}
Dove:
YYYY-MM-DD hh:mm:ss)Restituisce le ore lavorative dell'utente
{
"schedulePeriod": 7,
"scheduleWorkingHours": [
{
"time_start": "2020-06-15 09:00:00",
"time_end": "2020-06-15 18:00:00"
}
],
"scheduleFixes": [
{
"index": 2,
"repeat_index": 1,
"time_start": "2020-06-24 09:00:00",
"time_end": "2020-06-24 13:00:00",
"deleted": 0
}
],
"customWorkingHours": [
{
"time_start": "2020-06-27 11:00:00",
"time_end": "2020-06-27 15:00:00"
}
]
}
Dove:
YYYY-MM-DD hh:mm:ssYYYY-MM-DD hh:mm:ssYYYY-MM-DD hh:mm:ssYYYY-MM-DD hh:mm:ssYYYY-MM-DD hh:mm:ssYYYY-MM-DD hh:mm:ssRestituisce i gruppi e i diritti degli utenti di ciascuno.
{
"totalCount": 4,
"groups": [
{
"id": 45,
"type": "manager",
"title": "",
"permissions": {
"customers_create": true,
"customers_edit": true,
"customers_delete": true,
"customers_import_export": true,
"customers_view_all": false,
"calendar_other_users_access": false,
"calls_other_users_access": false,
"leads_view": false,
"leads_edit": false,
"leads_delete": false,
"leads_import_export": false,
"team_add": false,
"team_edit": false
}
}
]
}
Dove:
true o false):
Restituisce l'elenco di tutti i contatti (clienti, dipendenti, lead, utenti) con i numeri di telefono
(Esempio 1)
Esempio 1:
{
"totalCount": 128,
"contacts": [
{
"contact_type": "customer",
},
{
"contact_type": "employee",
},
{
"contact_type": "lead",
},
{
"contact_type": "user",
}
]
}
Dove:
(Esempio 2)
Esempio 2:
{
"contact_type": "customer",
"id": 3486,
"name": "Good Company",
"status": "company",
"type": "client",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Dove:
(Esempio 3)
Esempio 3:
{
"contact_type": "employee",
"id": 8,
"name": "Michael Simpson",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"position": {
"position": "manager",
"title": ""
},
"customer": {
"id": 3486,
"name": "Good Company"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Dove:
(Esempio 4)
Esempio 4:
{
"contact_type": "lead",
"id": 3486,
"name": "Good Company",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Dove:
(Esempio 5)
Esempio 5:
{
"contact_type": "user",
"id": 234,
"name": "John Beam",
"avatar": 2457,
"role": "",
"status": "",
"phone": {
"phone": "100",
"type": "internal"
},
"group": {
"type": "admin",
"title": ""
}
}
Dove:
Identifica il contatto (cliente, dipendente, lead, utente) in base al numero di telefono
La risposta dipenderà dal tipo di contatto trovato (cliente, dipendente, lead, utente).
(Esempio 1)
Esempio 1:
{
"contact_type": "customer",
"id": 3486,
"name": "Good Company",
"status": "company",
"type": "client",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Dove:
(Esempio 2)
Esempio 2:
{
"contact_type": "employee",
"id": 8,
"name": "Michael Simpson",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"position": {
"position": "manager",
"title": ""
},
"customer": {
"id": 3486,
"name": "Good Company"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Dove:
(Esempio 3)
Esempio 3:
{
"contact_type": "lead",
"id": 3486,
"name": "Good Company",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Dove:
(Esempio 4)
Esempio 4:
{
"contact_type": "user",
"id": 234,
"name": "John Beam",
"avatar": 2457,
"role": "",
"status": "",
"phone": {
"phone": "100",
"type": "internal"
},
"group": {
"type": "admin",
"title": ""
}
}
Dove:
Restituisce l'elenco delle trattative
search (opzionale) — campo di ricerca. La ricerca delle trattative viene effettuata in base al nome.
filter (opzionale) — oggetto con i filtri delle trattative. Struttura dell'oggetto:
(Esempio 1)
Esempio 1:
{
"filter": {
"currency": "USD",
"responsible_user": 20,
"status": "new"
}
}
Dove:
currency — valuta della trattativa. Codice ISO 4217 a tre lettere: EUR, USD, ecc.
Qualsiasi parametro del filtro può essere omesso, ovvero non è obbligatorio.
(Esempio 2)
Esempio 2:
{
"sort": { "attr": "name",
"desc": 0
}
}
Dove:
take (per visualizzazione a pagine) — numero di trattative da restituire (impostazione predefinita 20)
skip (per visualizzazione a pagine) — numero di trattative da saltare (impostazione predefinita 0)
(Esempio 3)
Esempio 3:
{
"totalCount": 82,
"deals": [
{
"id": 83,
"title": "Good deal",
"budget": 990.00,
"currency": "USD",
"status": "new",
"responsible_user": 20,
"created_at": "2021-10-05 12:40:10",
"created_by": 20,
"customer_id": 65,
"customer_is_lead": 0,
"customer_name": "Good company",
"customer_responsible_user": 20
}
]
}
Dove:
YYYY-MM-DD HH:mm:ss)Restituisce una trattativa in base al suo ID
{
"id": 83,
"title": "Good deal",
"budget": 990.00,
"currency": "USD",
"status": "new",
"responsible_user": 20,
"created_at": "2021-10-05 12:40:10",
"created_by": 20,
"customer_id": 65,
"customer_is_lead": 0,
"customer_name": "Good company",
"customer_responsible_user": 20
}
Dove:
YYYY-MM-DD HH:mm:ss)Crea una nuova trattativa con i dati specificati
(Esempio 1)
Esempio 1:
{
"deal": {
"title": "Good deal",
"budget": 990.00,
"currency": "USD",
"status": "new",
"responsible_user": 20,
"customer_id": 65
}
}
Dove:
(Esempio 2)
Esempio 2:
{
"id": 83
}
Dove:
- **id** — identificativo della trattativa creataAggiorna una trattativa esistente con l'ID specificato
{
"deal": {
"title": "Good deal",
"budget": 990.00,
"currency": "USD",
"status": "new",
"responsible_user": 20
}
}
Dove:
Elimina una trattativa in base al suo ID
Restituisce le note associate alla trattativa
{
"totalCount": 17,
"items": [
{
"id": 37825,
"type": "note",
"content": "Call to the client",
"time": "2020-06-08 06:55:02",
"user_id": 20,
"user_name": "John Beam",
"attached_files": [
{
"file_id": 576,
"original_filename": "document.doc"
}
]
}
]
}
Dove:
YYYY-MM-DD hh:mm:ssAggiunge una nota testuale alla trattativa con la possibilità di allegare file
{
"id": 37825,
"type": "note",
"content": "Call to the client",
"time": "2020-06-08 06:55:02",
"user_id": 20,
"user_name": "John Beam",
"attached_files": [
{
"file_id": 576,
"original_filename": "document.doc"
}
]
}
Dove:
YYYY-MM-DD hh:mm:ssAggiorna il contenuto di una nota di testo esistente in base al suo ID
Elimina una nota dalla trattativa in base al suo ID
Restituisce l'elenco delle attività
(Esempio 1)
Esempio 1:
{
"filter": {
"responsible": 456,
"createdBy": 456,
"start": "2020-06-03 02:56:00",
"end": "2020-06-12 02:56:00",
"completed": 1
}
}
Dove:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)(Esempio 2)
Esempio 2:
{
"sort": {
"attr": "start",
"desc": 0
}
}
Dove:
(Esempio 3)
Esempio 3:
{
"totalCount": 4,
"events": [
{
"id": 40,
"type": "task",
"title": "Create text for Good Company",
"description": "",
"start": "2020-05-26 09:00:00",
"end": "2020-05-26 12:30:00",
"allDay": false,
"created_by": 234,
"responsible_user": 234,
"phone": "",
"call_done": 0,
"completed": 0,
"completed_comment": "",
"members": [234, 235],
"customers": [
{
"id": 3486,
"name": "Good Company",
"status": "company",
"type": "client",
"lead_source": "manual",
"lead_status": "not_processed",
"contact_type": "customer"
}
]
}
]
}
Dove:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true o false) — la data è determinata dal parametro startRestituisce l'attività in base al suo ID
{
"id": 40,
"type": "task",
"title": "Create text for Good Company",
"description": "",
"start": "2020-05-26 09:00:00",
"end": "2020-05-26 12:30:00",
"allDay": false,
"created_by": 234,
"responsible_user": 234,
"phone": "",
"call_done": 0,
"completed": 0,
"completed_comment": "",
"members": [234, 235],
"customers": [
{
"id": 3486,
"name": "Good Company",
"status": "company",
"type": "client",
"lead_source": "manual",
"lead_status": "not_processed",
"contact_type": "customer"
}
]
}
Dove:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true o false)Crea una nuova attività con i dati specificati
(Esempio 1)
Esempio 1:
{
"event": {
"type": "task",
"title": "Create text for Good Company",
"description": "",
"start": "2020-05-26 09:00:00",
"end": "2020-05-26 12:30:00",
"allDay": false,
"responsible_user": 234,
"phone": "",
"members": [234, 235],
"customers": [3486, 3487]
}
}
Dove:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true o false)(Esempio 2)
Esempio 2:
{
"id": 7216
}
Dove:
Aggiorna l'attività esistente con l'ID specificato
{
"event": {
"title": "Create text for Good Company",
"description": "",
"start": "2020-05-26 09:00:00",
"end": "2020-05-26 12:30:00",
"allDay": false,
"created_by": 234,
"responsible_user": 234,
"phone": "",
"members": [234, 235],
"customers": [3486, 3487]
}
}
Dove:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true o false)Completa (chiude) l'attività
Elimina l'attività in base al suo ID
Restituisce l'elenco delle chiamate
(Esempio 1)
Esempio 1:
{
"filter": {
"user": 23,
"type": "incoming",
"status": "answer",
"dateFrom": "2020-06-03 14:56:00",
"dateTo": "2020-06-26 14:56:00"
}
}
Dove:
YYYY-MM-DD hh:mm:ss)dateTo — mostra solo le chiamate effettuate prima dell'ora specificata (formato: YYYY-MM-DD hh:mm:ss)
Qualsiasi parametro del filtro può essere omesso, ovvero non è obbligatorio.
(Esempio 2)
Esempio 2:
{
"sort": {
"attr": "time",
"desc": 0
}
}
Dove:
(Esempio 3)
Esempio 3:
{
"totalCount": 233,
"calls": [
{
"id": 127,
"type": "outgoing",
"status": "answer",
"phone": "+44123456789",
"user_id": 179,
"time": "2019-07-31 17:58:40",
"duration": 9,
"pbx_call_id": "out_807ghh1h7f09fa7a188dbf8a6998b1c9ghg4ij06",
"record": 1,
"record_url_till": "2020-07-24 20:08:10",
"contact_type": "customer",
"contact_name": "Good Company",
"contact_customer_id": 3486,
"contact_employee_id": null,
"employee_customer_id": null,
"contact_user_id": null,
"is_lead": 1,
"record_urls": [
{
"url": "https ://api.zadarma.com/v1/pbx/record/download/[...]/[...]/[...].mp3"
}
]
}
]
}
Dove:
YYYY-MM-DD hh:mm:ssRestituisce il file in base al suo ID
Il sistema Zadarma può inviare informazioni su ogni chiamata al centralino virtuale e instradare la chiamata al numero interno corretto in base alla risposta. Per farlo, è necessario creare un link pubblico in grado di ricevere richieste POST contenenti le informazioni dal sistema Zadarma.
Passaggio 1. Aggiungi il codice all'inizio dello script
<?php if (isset($_GET['zd_echo'])) exit($_GET['zd_echo']); ?>
Passaggio 2. Aggiungi l'URL per il webhook
Vai a "Impostazioni" → "Integrazioni e API", nel blocco Notifiche, inserisci il tuo URL nel campo per le notifiche delle chiamate nel centralino, quindi premi “Attiva”
inizio di una chiamata in entrata nel centralino
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET));
Per le richieste NOTIFY_START e NOTIFY_IVR è possibile modificare “al volo” lo scenario della chiamata in corso. A tal fine, inviare in risposta al webhook una delle seguenti opzioni:
1. Trasferire la chiamata:
(Esempio 1)
Esempio 1:
{
"redirect": ID,
"return_timeout": TIMEOUT (необязательное)
}
Dove:
2. Terminare la chiamata:
(Esempio 2)
Esempio 2:
{
"hangup": 1
}
3. Impostare il nome del numero chiamante
È possibile impostare il nome del numero chiamante (campo SIP CallerName) e questo verrà visualizzato nell'applicazione. In questo modo è possibile trasmettere comodamente il nome del chiamante, se il suo numero è presente nel sistema.
(Esempio 3)
Esempio 3:
{
"caller_name": NAME
}
Dove:
In ciascuna delle seguenti opzioni (numeri 4–7) può essere presente una risposta dell’utente sotto forma di cifre. Parametri di inserimento delle cifre:
(Esempio 4)
Esempio 4:
{
"wait_dtmf": {
"timeout": TIMEOUT,
"attempts": ATTEMPTS,
"maxdigits": MAXDIGITS,
"name": NAME,
"default": DEFAULT,
}
}
Dove:
4. Riprodurre il file:
(Esempio 5)
Esempio 5:
{
"ivr_play": "ID"
}
Dove:
5. Riprodurre la frase popolare:
(Esempio 6)
Esempio 6:
{
"ivr_saypopular": 1,
"language": "en"
}
Dove:
Elenchi di frasi popolari:
6. Riproduci i numeri:
(Esempio 7)
Esempio 7:
{
"ivr_saydigits": "12",
"language": "en"
}
7. Riprodurre il numero (secondo le regole dei numerali complessi):
(Esempio 8)
Esempio 8:
{
"ivr_saynumber": "123",
"language": "en"
}
Dove:
Se sono stati specificati ivr_saydigits o ivr_saynumber, nel successivo evento NOTIFY_IVR verrà aggiunto il parametro: "ivr_saydigits": "COMPLETE" oppure "ivr_saynumber": "COMPLETE"
Nel prossimo evento NOTIFY_IVR verrà specificato anche il parametro:
(Esempio 9)
Esempio 9:
{
"wait_dtmf": {
"name": NAME,
"digits": DIGITS,
"default_behaviour": "1"
}
}
Dove:
inizio di una chiamata in entrata sul numero interno del centralino
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET)); risposta alla chiamata al numero interno o esterno
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['destination'] .
$_POST['call_start'], API_SECRET)); fine della chiamata in entrata al numero interno del centralino
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET)); inizio di una chiamata in uscita dal centralino
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['internal'] . $_POST['destination'] .
$_POST['call_start'], API_SECRET)); fine della chiamata in uscita dal centralino
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['internal'] . $_POST['destination'] .
$_POST['call_start'], API_SECRET)); la registrazione della chiamata è pronta per essere scaricata
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['pbx_call_id'] . $_POST['call_id_with_rec'], API_SECRET)); risposta del chiamante all'azione assegnata
Parametri inviati al link per le notifiche:
Redazione della sottoscrizione di verifica per la notifica delle chiamate in entrata, esempio in PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET));
Le possibili risposte inviate sono simili alle risposte alle richieste. NOTIFY_START
rapporto di verifica dei numeri
$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));
informazioni sulle chiamate ai numeri collegati al call tracking
Parametri inviati al link per le notifiche:
$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));
informazioni sugli SMS in entrata
$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));
risultato del riconoscimento vocale
Parametri inviati al link per le notifiche:
È possibile impostare il link per cui ricevere le notifiche, nonché attivare/disattivare ogni tipo di notifica nella sezione API dell'area personale.
Affinché il sistema accetti il link, è necessario aggiungere un codice di verifica all'inizio dello script.
informazioni sulla verifica dei documenti
{
"wrong_document": {
"user_id":1234567,
"group_id":0,
"document_type":"passport",
"message":"The documents you have uploaded cannot be accepted because of low image quality."
}
}
<?php if (isset($_GET['zd_echo'])) exit($_GET['zd_echo']); ?>
Per aumentare la sicurezza, ti consigliamo di consentire l'accesso al tuo link solo da IP 185.45.152.40/30.
Inoltre, se avete rilasciato chiavi di accesso all'API, Ogni richiesta del tuo link sarà accompagnata da un titolo aggiuntivo "Signature", che ti consentirà di verificare l'integrità e l'autenticità dei dati.
È possibile consultare un esempio di script a nel nostro repository su GitHub.