Interface API est gratuit et disponible pour tous les utilisateurs Zadarma
Chaque demande qui exige l'autorisation s'accompagne d'un titre supplémentaire, du type:
"Authorization: clé_de l'utilisateur: la signature"
Les clés de l'autorisation il faut recevoir dans l'espace client.
La signature est créée selon l'algorithme suivant:
Appels
Numéros de téléphone
eSIM pour Internet
SMS
Standard téléphonique virtuel
CRM
Analyse vocale
Call tracking
Widget de rappel automatique
Visioconférence
Bouton "Appelez-moi"
Solution d'entreprise
Programme de partenariat
Intégrations
Pour qui
Manuel d'installation
Questions Fréquemment Posées
Chat en ligne
Demande d'assistance
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;
L'exemple prêt de PHP pour travailler avec API, vous pouvez télécharger à GitHub.
Le titre (ou en-tête) Content-Type pour les requêtes POST doit être égal à application/x-www-form-urlencoded ou multipart/form-data.
Les formats de la réponse: json (par défaut) et xml.
Pour recevoir la réponse d'API dans un format xml, dans la chaîne d'interrogation le paramètre est ajouté "format=xml".
{
"status":"error",
"message":"Check phone's number"
}
Dans la réponse l'information sur les limites et l'interrogation actuelle est contenue, par exemple:
X-Zadarma-Method: /v1/ X-RateLimit-Reset: 1434371160 X-RateLimit-Limit: 100 X-RateLimit-Remaining: 99
où,
Les limites générales - 100 demandes par minute, pour les méthodes de statistique - 3 demandes par minute.
Dans le cas de blocage, la méthode répond avec 429 le titre "You exceeded the rate limit".
La réponse contient la clé obligatoire "status" (success ou error). Ensuite, selon la méthode, les clés sont transmises avec l'information demandée.
Dans le cas d'erreur la clé supplémentaire est transmise "message" avec la description d'erreur.
Toutes les réponses sont accompagnées par des HTTP-titres.
Attention: si vous avez toujours besoin de la statistique actuelle du standard virtuel, il ne faut pastoutes les minutes demander la méthode statistics/pbx/. Activez les notifications webhooks et recevez l'information sur chaque appel au moment de son début et sa fin.
le solde de l'utilisateur
{
"status":"success",
"balance":10.34,
"currency":"USD"
}
le coût d'appel selon le forfait actuel de l'utilisateur
{
"status":"success",
"info": {
"prefix":"4420",
"description":"United Kingdom, London",
"price":"0.009",
"currency":"USD",
}
}
le fuseau horaire de l'utilisateur
{
"status":"success",
"unixtime":1483228800,
"datetime":"2017-01-01 00:00:00",
"timezone":"UTC+0"
}
l'information sur le forfait actuel de l'utilisateur
{
"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
}
}
Où:
le rappel automatique
{
"status":"success",
"from":442037691880,
"to":442037691881,
"time":1435573082
}
confirmation du numéro
{
"status":"success",
"from":442037691880,
"to":442037691881,
"lang":"fr",
"time":1612779278
}
l'actualisation des contacts
Si numbers contient un numéro, le résultat sera renvoyé immédiatement, si la liste des numéros est indiquée, le résultat sera envoyé à l'adresse indiquée à la page de l'actualisation des contacts ou à l'adresse mail, si l'adresse n'est pas indiquée.
Attention: le réglage de cette méthode s'effectue à la page de l'actualisation des numéros dans l'espace client.
(Réponse 1)
Réponse 1:
{
"status":"success",
"info":{
"mcc":"24702",
"mnc":"02",
"mccName":"Latvia",
"mncName":"Tele2",
"ported":false,
"roaming":false,
"errorDescription":"No Error"
}
}
(Réponse 2)
Réponse 2:
{
"status":"success"
}
(Réponse 3)
Réponse 3:
{
"success":true,
"description":"Success",
"result": [
{
"mcc":"24702",
"mnc":"02",
"ported":false,
"roaming":false,
"errorDescription":"No Error",
"mccName":"Latvia",
"mncName":"Tele2",
"number":"3712812858",
}, ...
]
} Liste de devises
{
"status": "success",
"currencies": [
"USD",
"EUR",
"GBP",
"PLN"
]
} Liste de langues possibles dans l'espace client
{
"status": "success",
"languages": [
"en",
"es",
"de",
"pl",
"ru",
"ua",
"fr"
]
} Liste de forfaits
{
"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
},
...
]
},
...
]
}
la liste de numéros SIP de l'utilisateur
{
"status":"success",
"sips":[
{"id":"00001", "display_name":"SIP 1", "lines":3},
{"id":"00002", "display_name":"SIP 2", "lines":3}
],
"left":3
}
Où:
online-statut du numéro SIP de l'utilisateur
{
"status":"success",
"sip":"00001",
"is_online":"false"
}
le changement de CallerID
{
"status":"success",
"sip":"00001",
"new_caller_id":"442037691880"
}
l'affichage de renvois actuels par les numéros SIP des utilisateurs
{
"status":"success",
"info": [
{
"sip_id":"00001",
"status":"on",
"condition":"always",
"destination":"phone",
"destination_value":"442037691880"
},
...
]
}
Où:
l'activation/la désactivation de renvoi par le numéro SIP
{
"status":"success",
"sip":"00001",
"current_status":"on"
}
le changement des paramètres de renvoi
{
"status":"success",
"sip":"00001",
"destination":"442037691880"
}
Création de SIP numéro
{
"status": "success",
"sip": "123456"
}
Changement de mot de passe SIP
{
"status":"success",
"sip":$sip,
}
la réception de la statistique générale
(Réponse 1)
Réponse 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"
},
…
]
}
La période maximale de réception de statistique - un mois. Dans le cas de dépassement dans une demande - la période est automatiquement réduite à 30 jours. Si la date du début n'est pas indiquée, le début du mois est choisi. Si la date de la fin n'est pas indiquée – l'échantillon est limité par la date et l'heure actuelle.
Le nombre maximal de lignes affichées pour une demande - 1000. Pour la pagination utilisez les paramètres skip et limit.
?type=cost_only:
(Réponse 2)
Réponse 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
}
]
}
Où:
la statistique du standard virtuel
Attention: si vous avez toujours besoin de la statistique actuelle du standard virtuel, il ne faut pastoutes les minutes demander la méthode statistics/pbx/. Activez les notifications webhooks et recevez l'information sur chaque appel au moment de son début et sa fin.
{
"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"
},
…
]
}
Où:
la statistique de widget Callback
{
"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"
}
]
},
...
]
}
La période maximale de réception de statistique - un mois. Dans le cas de dépassement dans une demande - la période est automatiquement réduite à 30 jours. Si la date du début n'est pas indiquée, le début du mois est choisi. Si la date de la fin n'est pas indiquée – l'échantillon est limité par la date et l'heure actuelle.
Le nombre maximal de lignes affichées pour une demande - 1000. Pour la pagination utilisez les paramètres skip et limit.
Où:
réception de la statistique des appels entrants
{
"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"
},
…
]
}
La période maximale de réception de statistique - un mois. Dans le cas de dépassement dans une demande - la période est automatiquement réduite à 30 jours. Si la date du début n'est pas indiquée, le début du mois est choisi. Si la date de la fin n'est pas indiquée – l'échantillon est limité par la date et l'heure actuelle.
Le nombre maximal de lignes affichées pour une demande - 1000. Pour la pagination utilisez les paramètres skip et limit.
le changement des paramètres de renvoi sur le numéro interne du standard virtuel
{
"status":"success",
"current_status":"on",
"pbx_id":"1234",
"pbx_name":"100",
"type":"phone",
"destination":"79123456789",
"condition":"noanswer"
}
Pour activer et ajuster le renvoi:
Pour désactiver le renvoi:
la réception des paramètres de renvoi sur le numéro interne du standard virtuel
{
"status":"success",
"current_status":"on",
"pbx_id":"1234",
"pbx_name":"100",
"type":"phone",
"destination":"79123456789",
"condition":"noanswer",
}
la demande du fichier d'enregistrement d'appel
Une note: il suffit d'indiquer un des paramètres de l'identification (pbx_call_id ou call_id), en indiquant pbx_call_id les liens dans une réponse peuvent être nombreux.
L'exemple de la réponse quand call_id est indiqué, le lien est seul:
(Réponse 1)
Réponse 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"
}
L'exemple de la réponse quand pbx_call_id est indiqué , les liens peuvent être nombreux:
(Réponse 2)
Réponse 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"
}
chargement de musique
activer/désactiver la musique d'attente pour le standard virtuel
suppression de musique
recevoir des paramètres pbx 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"
}
}
changement de url pour pbx call info
{
"status": "success",
"url": ""
}
changement de réaction aux événements NOTIFY_* pour pbx 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"
}
}
suppression de url pour pbx call info
{
"status": "success",
"url": ""
}
création du standard virtuel
{
"status": "success",
"stop_datetime": "2021-12-31 23:59:59"
}
recevoir des paramètres de pbx webhooks
{
"status": "success",
"url": "",
"hooks": {
"number_lookup": "true",
"call_tracking": "false",
"sms": "true",
"speech_recognition": "true"
}
}
changement de url pour pbx webhooks
{
"status": "success",
"url": ""
}
changement de réaction aux événements pour des autres notifications (Actualisation d'annuaire, Call tracking, SMS et Analyse vocale)
{
"status": "success",
"hooks": {
"number_lookup": "true",
"call_tracking": "false",
"sms": "true",
"speech_recognition": "true"
}
}
suppression de url pour des autres notifications (Actualisation d'annuaire, Call tracking, SMS et Analyse vocale)
{
"status": "success",
"url": ""
}
l'affichage des numéros internes du standard virtuel
{
"status":"success",
"pbx_id":1234,
"numbers": [
100,
101,
...
]
}
Où:
le statut en ligne du numéro interne du standard virtuel
{
"status":"success",
"pbx_id":1234,
"number":100,
"is_online":"false"
}
Où:
information sur le numéro interne du standard virtuel
{
"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
}
où:
l'activation d'enregistrement des appels sur le numéro interne du standard virtuel
{
"status":"success",
"internal_number":100,
"recording":"on",
"email":"test@test.com",
"speech_recognition":"all"
}
création du numéro du standard virtuel
{
"status": "success",
"numbers": [
{
"number": 200,
"password": "PASSWORD"
},
{
"number": 201,
"password": "PASSWORD"
}
]
}
demande de mot de passe du numéro interne du standard virtuel, le mot de passe est visible pour une période limitée
{
"status": "success",
"pbx_id": 114,
"number": 200,
"password": "PASSWORD"
}
changement de mot de passe du numéro interne
{
"status": "success",
"pbx_id": 114,
"number": 200
}
changement du numéro interne du standard virtuel
liste de fichiers dans le stockage du standard virtuel
chargement du fichier
suppression du fichier par ID
Paramètres
liste de SVI
{
"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
}
},
...
]
}
créer le SVI
{
"status": "success",
"menu_id": 2
}
suppression de SVI
{
"status": "success"
}
liste de scénario de SVI
{
"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
},
...
]
}
création d'un scénario SVI
{
"status": "success",
"menu_id": 0,
"scenario_id": 2
}
changement du scénario de SVI
(Réponse 1)
Réponse 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
],
]
]
La déscription de la stratégie de distribution des appels par numéros internes dans la file d’attente:
Les paramètres du délai et de la durée d'appel aux numéros internes s'appliquent à la file d'attente désactivée (queue_strategy : "off").
Réponse: (Réponse 2)
Réponse 2:
{"status": "success"}
Erreur: (Réponse 3)
Réponse 3:
{"status": "error","message": "Wrong parameters!"} suppression de scénario de SVI
{
"status": "success"
}
réception des résultats de la reconnaissance
{
"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
}
]
}
Pour lancer la reconnaissance de l'appel dans les statistiques du standard virtuel, la reconnaissance sélective doit être activée au préalable dans les paramètres du numéro interne
{
"status":"success"
}
l'information sur les numéros directs de l'utilisateur
{
"status":"success",
"info": [
{
"number":"442030000000",
"status":"on",
"country":"Great Britain",
"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"
},
...
]
}
Selon le type de numéros les champs peuvent différer! La description des champs:
information sur le numéro acheté
{
"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"
}
}
statut de renouvellement
{
"status": "success",
"number": "35924913550",
"autoprolongation": "on"
}
recevoir l'information sur les erreurs de vérification des documents ou de l'adresse
{
"status":"success",
"info":{
"wrong_document":{
"document_type":"contract",
"message":"The passport has expired. It is considered invalid."
},
"wrong_address":{
"message":"Invalid address"
}
}
}
changer de statut de renouvellement
{
"status": "success",
"number": "35924913550",
"autoprolongation": "off"
}
liste des pays dont les numéros vous pouvez commander
{
"status": "success",
"info": [
{
"countryCode": "61",
"countryCodeIso": "AU",
"name": "Australia"
},
...
]
}
liste des destinations dans le pays où vous pouvez commander le numéro
{
"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"
},
...
]
}
installation de Nom du numéro (caractères latins et chiffres, jusqu'à 30 caractères)
{
"status": "success",
"number": "+44000000000",
"caller_name": "test"
}
attachement du numéro au sip ou activation du régime de test
{
"status": "success",
"number": "+44000000000",
"sip_id": "00001"
}
numéro à commander
{
'status': 'success',
'numbers': [
{
'id': 1712p0D1643D0t42r198658,
'direction_id': 13755,
'number': '+44000000001'
},
{
'id': 184bdf85006c3f1676be200,
'direction_id': 13755,
'number': '+44000000000'
},
...
]
}
commande/achat du numéro
{
'status': 'success',
'number': '+44000000000',
'is_reserved': 'false',
'is_activated': 'true'
}
prolongation du numéro
{
'status': 'success',
'number': '+44000000000',
'stop_date': '2021-05-01 12:00:00',
'total_paid': {
'amount': 2,
'currency': 'USD'
}
}
activer la réception des SMS (si le numéro gère la réception des SMS)
{
"status": "success",
"number": "",
"receive_sms": "on"
}
liste de fichiers/documents dans le groupe de documents
{
"status": "success",
"documents": [
{
"type": "passport",
"is_verified": "true",
"source": "upload",
"name": "file1.jpg"
},
{
"type": "receipt",
"is_verified": "false",
"source": "upload",
"name": "file2.jpg"
}
]
}
liste de groupe de documents
{
"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
}
]
}
données de groupe précis
{
"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
}
}
vérification: si le groupe de documents convient à la destination/ville
{
"status": "success",
"is_information_match": "true",
"is_documents_uploaded": "true",
"is_documents_verified": "true",
"is_address_match": "true"
}
création du nouveau groupe
{
"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
}
}
renouvellement des données de groupe de documents
{
"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
}
}
chargement du fichier de document pour le groupe de documents
$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"
} information sur le compte du marchand
{
"status": "success",
"balance": 123,
"credit": 0,
"currency": "USD",
"reseller_fee": 10,
"user_fee": 10
} Virement du compte du marchand au compte lié et vice versa
{
"status": "success",
"user": {
"balance": "62.0000",
"currency": "EUR"
},
"reseller": {
"balance": "94.825",
"currency": "USD"
}
}
Liste de numéros de téléphone de l'utilisateur pour contacter
{
"status": "success",
"list": [
{
"id": 0,
"number": "49025000897",
"is_proved": false
}
]
}
Ajout de numéro de téléphone de l'utilisateur pour contacter
{
"status": "success",
"id": 98,
"number": "359000000001",
"is_proved": true
}
Modification de numéro de téléphone de l'utilisateur pour contacter
{
"status": "success",
"id": 99,
"number": "359000000002",
"is_proved": false
}
Demande de confirmation de numéro de téléphone de l'utilisateur pour contacter
{
"number": "359000000002",
"status": "success",
"message": "You were sent an SMS message with a code. Code is valid for 1 hour."
}
Demande de confirmation du numéro de téléphone de contact de l'utilisateur (un appel sera passé et une fois répondu, l'abonné entendra un code de confirmation)
{
"number": "359000000002",
"status": "success",
"message": "You were sent an SMS message with a code. Code is valid for 1 hour."
}
Confirmation du numéro pour contacter avec le code de SMS
{
"status": "success",
"message": "Your number confirmed!",
"number": "35900000019"
}
Enregistrement de l'utilisateur
{
"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."
}
Confirmation d'enregistrement de l'utilisateur
{
"status": "success",
"user_id": 12345
}
Liste d'utilisateurs du marchand affichés page par page (50)
{
"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
},
...
]
}
Recherche de compte d'utilisateur par un critère (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
}
}
Virement du compte du marchand au compte de l'utilisateur
{
"status": "success",
"user_topup": {
"amount": 10,
"currency": "GBP"
},
"reseller_withdraw": {
"amount": 10,
"currency": "GBP"
}
}
Recevoir des clés d'accès à API actuelles de l'utilisateur
{
"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"
}
Recevoir des nouvelles clés d'accès à API de l'utilisateur
{
"status": "success",
"user_id": 1234,
"key": "abscd",
"secret": "12345"
}
l'envoi des 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"
}
]
}
Obtenir une liste de modèles de 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"
},
]
}
]
}
Obtenir une liste d'expéditeurs de SMS valides vers un numéro indiqué
{
"senders": ["Teamsale", "1234567890"]
}
recevoir la clé pour le widget webrtc. Durée de vie de clé - 72 heures.
{
"status":"success",
"key": YOUR_KEY
}
Paramètres:
Création de l'intégration de widget WebRTC
{
"status": "success"
}
Changement des paramètres de l'intégration de widget WebRTC
{
"status": "success"
}
Données de l'intégration de widget WebRTC
{
"status": "success",
"is_exists": true,
"domains": [
"test.domain.com"
],
"settings": {
"shape": "square",
"position": "top_right"
}
}
Ajouter le domaine à l'intégration de widget WebRTC
{
"status": "success"
}
Suppression du domaine de l'intégration de widget WebRTC
{
"status": "success"
}
Suppression de l'intégration de widget WebRTC
{
"status": "success"
}
Liste des appareils compatibles avec eSIM
Description de la réponse réussie (Réponse 1)
Réponse 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"
]
}
}
Description de la réponse en cas d'erreur interne (Réponse 2)
Réponse 2:
{
"status": "error",
"message": "Getting devices internal error"
}
Liste des forfaits disponibles
Description de la réponse réussie (Réponse 1)
Réponse 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
},
}
]
}
Description de la réponse en cas d'erreur interne (Réponse 2)
Réponse 2:
{
"status": "error",
"message": "Getting packages error"
}
Liste des forfaits connectés
Paramètres
Description de la réponse réussie (Réponse 1)
Réponse 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
}
]
}
Description de la réponse en cas d'user_id incorrect (Réponse 2)
Réponse 2:
{
"status": "error",
"message": "You are not a reseller of the requested user"
}
Informations sur le forfait connecté via l'ICCID
Paramètres
Description de la réponse réussie (Réponse 1)
Réponse 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
}
}
Description de la réponse en cas d'erreur si un ICCID inexistant est envoyé (Réponse 2)
Réponse 2:
{
"status": "error",
"message": "Not found"
}
Connecter un forfait
Description de la réponse réussie(Réponse 1)
Réponse 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
}
}
Description de la réponse en cas d'erreur due à un solde insuffisant (Réponse 2)
Réponse 2:
{
"status": "error",
"message": "Not enough money on your account"
}
Demande de vérification avec l'envoi d'une notification à l'utilisateur
Un message SMS contenant un code de vérification sera envoyé au numéro du destinataire. L'envoi via ce canal peut nécessiter un paiement, donc l'utilisateur de l'API doit disposer d'un solde positif.
Paramètres
Lors de la sélection de ce canal, un appel est passé au numéro du destinataire, où un code de vérification est communiqué oralement. L'envoi via ce canal peut nécessiter un paiement, donc l'utilisateur de l'API doit disposer d'un solde positif.
Pour utiliser ce canal, l'utilisateur de l'API doit avoir un numéro enregistré dans le système Zadarma.
Paramètres
Lors de l'utilisation de ce canal, un email contenant un code de vérification est envoyé à l'adresse spécifiée. Pour utiliser ce canal, l'utilisateur de l'API doit avoir une intégration email activée dans le système Teamsale CRM.
Paramètres
Ce canal prévoit un appel au numéro du destinataire, au cours duquel l'utilisateur doit suivre les instructions des fichiers audio et appuyer sur le bouton "1" pour confirmer. L'envoi via ce canal peut nécessiter un paiement, donc l'utilisateur de l'API doit disposer d'un solde positif.
Conditions pour l'utilisation de ce canal :
Particularités : Le résultat de la vérification via ce canal est vérifié à l'aide de NOTIFY_OUT_END webhook, et non via la méthode /v1/verify/check/.
Paramètres
Pour gérer les fichiers audio utilisés dans les paramètres greeting_sound_id, button_1_sound_id et fallback_sound_id, utilisez les méthodes API disponibles dans la section /v1/pbx/ivr/sounds/*.
Pour une demande réussie via les canaux sms, call_code, email (Réponse 1)
Réponse 1:
{
"status": "success",
"request_id": "NDlLMWlNcW5mR3EvOFkraWVtOWF1Q2c9"
}
Pour le canal call_button, une réponse réussie ne contient pas de request_id, car la vérification du résultat est effectuée via NOTIFY_OUT_END webhook(Réponse 2)
Réponse 2:
{
"status": "success"
}
En cas de requête invalide, l'API renvoie une réponse avec le statut error et une description de l'erreur dans le champ message(Réponse 3)
Réponse 3:
{
"status": "error",
"message": "\"to\" param is required"
}
Lors de l'envoi d'une requête via le canal email, si le paramètre from est obligatoire mais non spécifié, le système retournera une réponse avec le statut "error" et un message indiquant l'absence du paramètre nécessaire (Réponse 4)
Réponse 4:
{
"status": "error",
"message": "Can't find active email integration for the \"from\" param's email"
} Vérification du code dans la demande de validation pour les canaux SMS, appel vocal et email
Description de la réponse réussie, si le paramètre code correspond à celui de la requête de vérification (Réponse 1)
Réponse 1:
{
"status": "success",
"message": "Code is correct"
}
Description de la réponse en cas d’erreur, si la requête est expirée ou si aucune requête n’est trouvée pour le request_id (Réponse 2)
Réponse 2:
{
"status": "error",
"message": "No such request id"
}
Description de la réponse en cas d’erreur, si le paramètre code ne correspond pas à celui de la requête (Réponse 3)
Réponse 3:
{
"status": "error",
"message": "Invalid verification code"
}
Pour vérifier le canal call_button, utilisez NOTIFY_OUT_END webhook.
Renvoie la liste des clients
(Réponse 1)
Réponse 1:
{
"status": "company",
"type": "client",
"country": "GB",
"city": "London",
"label": 12,
"utm": 19,
"employees_count": "50",
"responsible": 20
}
Où:
responsible — le responsable (l'identificateur de l'utilisateur)
Chaque paramètre peut être omis, optionnel.
(Réponse 2)
Réponse 2:
{
"attr": "name",
"desc": 0
}
Où:
(Réponse 3)
Réponse 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"
}
]
}
]
}
Où:
YYYY-MM-DD HH:mm:ss)YYYY-MM-DD HH:mm:ss)Renvoie un client par son 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"
}
]
}
Où:
YYYY-MM-DD HH:mm:ss)YYYY-MM-DD HH:mm:ss)Crée un nouveau client avec les données indiquées
(Réponse 1)
Réponse 1:
{
"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"
}
]
}
Où:
(Réponse 2)
Réponse 2:
{
"id": 65
}
Où:
Renouvelle le client existant avec l'ID indiqué
{
"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"
}
]
}
Où:
Supprime le client par son ID
Renvoie une matrice de toutes les balises de source et leurs statistiques
[
{
"id": 78,
"param": "utm_source",
"value": "google",
"display_value": "Google",
"count": 1267
}
]
Où chaque balise contient des champs suivants:
Crée une nouvelle balise de source
(Réponse 1)
Réponse 1:
{
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
Où:
(Réponse 2)
Réponse 2:
{
"id": 78
}
Où:
Met à jour une balise de source existante avec l'ID indiqué
{
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
Où:
Supprime une balise de source du système par son ID
Renvoie la liste de tous les tags et leur statistique
{
"totalCount": 5,
"labels": [
{
"id": 12,
"label": "Best clients",
"count": 14
}
]
}
Où:
Crée un nouveau tag
{
"id": 13,
"label": "Very best clients",
"count": 0
}
Où:
Supprime le tag du système par son ID
Renvoie toutes propriétés avancées
{
"totalCount": 8,
"customProperties": [
{
"id": 18,
"key": "loyalty",
"title": "Loyalty"
}
]
}
Où:
Renvoie les notes dans un fil du client
{
"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"
}
]
}
]
}
Где:
YYYY-MM-DD hh:mm:ssAjoute une note textuelle dans un fil du client avec la possibilité d'attacher les fichiers
{
"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"
}
]
}
Où:
YYYY-MM-DD hh:mm:ssRenouvelle le contenu de la note textuelle existante par son ID
Supprime une note dans un fil du client par son ID
Renvoie la liste des employés du client par son 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"
}
]
}
]
}
Où:
Renvoie l'employé du client par son 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"
}
]
}
Où:
Crée et sauvegarde un nouvel employé pour un client indiqué
(Réponse 1)
Réponse 1:
{
"name": "Steven Knight",
"position": "manager",
"position_title": "",
"comment": "",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "s.knight@example.com"
}
]
}
Où:
(Réponse 2)
Réponse 2:
{
"id": 23
}
Où:
Renouvelle l'employé existant avec l'ID indiqué
{
"name": "Steven Knight",
"position": "manager",
"position_title": "",
"comment": "",
"phones": [
{
"type": "work",
"phone": "+44123456789"
}
],
"contacts": [
{
"type": "email_work",
"value": "john@example.com"
}
]
}
Où:
Supprime l'employé par son ID
Renvoie la liste des leads
(Réponse 1)
Réponse 1:
{
"source": "call_incoming",
"responsible": 32,
"label": 12,
"utm": 19,
"createdAfter": "2020-06-11 12:24:00",
"createdBefore": "2020-06-26 12:24:00"
}
Où:
YYYY-MM-DD hh:mm:ss)createdBefore — afficher les leads créés jusqu'à la période indiquée (un format: YYYY-MM-DD hh:mm:ss)
Chaque paramètre peut être omis, optionnel.
(Réponse 2)
Réponse 2:
{
"attr": "name",
"desc": 0
}
Où:
(Réponse 3)
Réponse 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"
}
]
}
]
}
Où:
YYYY-MM-DD HH:mm:ss)Renvoie le lead par son 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": "Лучшие клиенты"
}
],
"utms": [
{
"id": 19,
"param": "utm_source",
"value": "google",
"display_value": "Google"
}
],
"custom_properties": [
{
"id": 12,
"key": "loyalty",
"title": "Лояльность",
"value": "high"
}
]
}
Où:
YYYY-MM-DD HH:mm:ss)Crée un nouveau lead avec les données indiquées
(Réponse 1)
Réponse 1:
{
"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"
}
]
}
Où:
YYYY-MM-DD HH:mm:ss)(Réponse 2)
Réponse 2:
{
"id": 123
}
Où:
Renouvelle un lead existant avec l'ID indiqué
{
"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"
}
]
}
Où:
YYYY-MM-DD HH:mm:ss)Supprime un lead par son ID
Renvoie la liste des utilisateurs
{
"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"
}
]
}
]
}
Où:
YYYY-MM-DD hh:mm:ss)Renvoie l'utilisateur par son 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
}
Où:
YYYY-MM-DD hh:mm:ss)Renvoie les heures de travail de l'utilisateur
{
"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"
}
]
}
Où:
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:ssRenvoie les groupes et les droits des utilisateurs de chaque groupe
{
"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
}
}
]
}
Où:
true ou false):
Renvoie la liste de tous les contacts (clients, employés, leads, utilisateurs) avec les numéros
(Réponse 1)
Réponse 1:
{
"totalCount": 128,
"contacts": [
{
"contact_type": "customer",
},
{
"contact_type": "employee",
},
{
"contact_type": "lead",
},
{
"contact_type": "user",
}
]
}
Où:
(Réponse 2)
Réponse 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"
}
}
Où:
(Réponse 3)
Réponse 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"
}
}
Où:
(Réponse 4)
Réponse 4:
{
"contact_type": "lead",
"id": 3486,
"name": "Good Company",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Où:
(Réponse 5)
Réponse 5:
{
"contact_type": "user",
"id": 234,
"name": "John Beam",
"avatar": 2457,
"role": "",
"status": "",
"phone": {
"phone": "100",
"type": "internal"
},
"group": {
"type": "admin",
"title": ""
}
}
Où:
Identifie le contact (client, employé, lead, utilisateur) par le numéro
La réponse dépend du type de contact trouvé (client, employé, lead, utilisateur).
(Réponse 1)
Réponse 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"
}
}
Où:
(Réponse 2)
Réponse 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"
}
}
Où:
(Réponse 3)
Réponse 3:
{
"contact_type": "lead",
"id": 3486,
"name": "Good Company",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
Où:
(Réponse 4)
Réponse 4:
{
"contact_type": "user",
"id": 234,
"name": "John Beam",
"avatar": 2457,
"role": "",
"status": "",
"phone": {
"phone": "100",
"type": "internal"
},
"group": {
"type": "admin",
"title": ""
}
}
Où:
Renvoie une liste d'affaires
search (optionnel) — barre de recherche. La recherche s'effectue selon le nom.
filter (optionnel) — filtre des affaires. La structure du filtre:
(Réponse 1)
Réponse 1:
{
"currency": "USD",
"responsible_user": 20,
"status": "new"
}
Où:
status — statut d'affaire. Notions possibles:
Un des paramètres peut être omi car il est optionnel.
(Réponse 2)
Réponse 2:
{
"attr": "name",
"desc": 0
}
Où:
take (longueur de sortie) — le nombre d'affaire à renvoyer (par défaut 20)
skip (longueur de sortie) — le nombre d'affaire à ignorer (par défaut 0)
(Réponse 3)
Réponse 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
}
]
}
Où:
YYYY-MM-DD HH:mm:ss)Renvoie une affaire par son 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
}
Où:
YYYY-MM-DD HH:mm:ss)
Crée une nouvelle affaire avec de données indiquées
(Réponse 1)
Réponse 1:
{
"title": "Good deal",
"budget": 990.00,
"currency": "USD",
"status": "new",
"responsible_user": 20,
"customer_id": 65
}
Où:
(Réponse 2)
Réponse 2:
{
"id": 83
}
Où:
Met à jour une affaire existante avec l'ID indiqué
{
"title": "Good deal",
"budget": 990.00,
"currency": "USD",
"status": "new",
"responsible_user": 20
}
Où:
Supprime une affaire par son ID
Renvoie les données dans le fil d'affaire
{
"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"
}
]
}
]
}
Où:
YYYY-MM-DD hh:mm:ssAjoute une note textuelle au fil de l'affaire avec la possibilité de joindre des fichiers
{
"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"
}
]
}
Où:
YYYY-MM-DD hh:mm:ss
Met à jour le contenu d'une note textuelle existante par son ID
Supprime une note dans le fil d'affaire par son ID
Renvoie la liste des tâches
(Réponse 1)
Réponse 1:
{
"responsible": 456,
"createdBy": 456,
"start": "2020-06-03 02:56:00",
"end": "2020-06-12 02:56:00",
"completed": 1
}
Où:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)(Réponse 2)
Réponse 2:
{
"attr": "start",
"desc": 0
}
Où:
(Réponse 3)
Réponse 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"
}
]
}
]
}
Où:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true ou false) — la date est définie par le paramètre startRenvoie une tâche par son 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"
}
]
}
Où:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true ou false) — la date est définie par le paramètre startCrée une nouvelle tâche avec les données indiquées
(Réponse 1)
Réponse 1:
{
"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]
}
Où:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true ou false) (Réponse 2)
Réponse 2:
{
"id": 7216
}
Où:
Renouvelle une tâche existante avec l'ID indiqué
{
"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]
}
Où:
YYYY-MM-DD hh:mm:ss)YYYY-MM-DD hh:mm:ss)true ou false) Termine (ferme) une tâche
Supprime une tâche par son ID
Renvoie la liste des appels
(Réponse 1)
Réponse 1:
{
"user": 23,
"type": "incoming",
"status": "answer",
"dateFrom": "2020-06-03 14:56:00",
"dateTo": "2020-06-26 14:56:00"
}
Où:
YYYY-MM-DD hh:mm:ss)dateTo — afficher les appels effectués avant le temps indiqué (un format: YYYY-MM-DD hh:mm:ss)
Chaque paramètre peut être omis, optionnel.
(Réponse 2)
Réponse 2:
{
"attr": "time",
"desc": 0
}
Où:
(Réponse 3)
Réponse 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"
}
]
}
]
}
Où:
YYYY-MM-DD hh:mm:ssRend le fichier par son ID
Le système Zadarma peut envoyer l'information sur chaque appel du standard virtuel et envoyer un appel vers le bon numéro selon la réponse. Il faut créer le lien d'accès universel qui va recevoir des POST demandes avec l'information du système Zadarma.
Étape 1. Ajoutez le code au début du script
<?php if (isset($_GET['zd_echo'])) exit($_GET['zd_echo']); ?>
Étape 2. Ajoutez l’URL pour le webhook
Allez dans "Paramètres" → "Intégrations et API", dans le bloc Notifications entrez votre URL dans le champ pour les notifications d’appels dans le standard virtuel, puis cliquez sur "Activer"
le début de l'appel entrant au standard virtuel
La création de la signature de vérification pour les notifications sur les appels entrants, l'exemple de PHP:
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET));
Pour les demandes NOTIFY_START et NOTIFY_IVR vous pouvez immédiatement changer le scénario d'appel en envoyant l'une des réponses:
1. Rediriger un appel:
(Réponse 1)
Réponse 1:
{
"redirect": ID,
"return_timeout": TIMEOUT (необязательное)
}
où,
2. Terminer un appel:
(Réponse 2)
Réponse 2:
{
"hangup": 1
}
(Réponse 3)
Réponse 3:
{
"caller_name": NAME
}
Où:
Dans chaque variante en dessous (de 4 à 7) il existe une réponse-chiffre de l'abonné. Paramètres de la saisie des chiffres:
(Réponse 4)
Réponse 4:
{
"wait_dtmf": {
"timeout": TIMEOUT,
"attempts": ATTEMPTS,
"maxdigits": MAXDIGITS,
"name": NAME,
"default": DEFAULT,
}
}
où,
4. Lire un fichier:
(Réponse 5)
Réponse 5:
{
"ivr_play": "ID"
}
où,
5. Lire une phrase populaire:
(Réponse 6)
Réponse 6:
{
"ivr_saypopular": 1,
"language": "en"
}
où,
La liste des phrases populaires:
6. Lire une chiffre:
(Réponse 7)
Réponse 7:
{
"ivr_saydigits": "12",
"language": "en"
}
7. Lire un nombre (conformément aux régles):
(Réponse 8)
Réponse 8:
{
"ivr_saynumber": "123",
"language": "en"
}
Où:
Si ivr_saydigits ou ivr_saynumber sont indiqué, dans un événement suivant NOTIFY_IVR sera ajouté le paramètre: "ivr_saydigits": "COMPLETE" ou "ivr_saynumber": "COMPLETE"
Dans un événement suivant NOTIFY_IVR est indiqué encore un paramètre: (Réponse 9)
Réponse 9:
{
"wait_dtmf": {
"name": NAME,
"digits": DIGITS,
"default_behaviour": "1"
}
}
où,
le début de l'appel entrant au numéro interne du standard virtuel
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET)); la réponse à l'appel au numéro interne ou externe
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['destination'] .
$_POST['call_start'], API_SECRET)); la fin de l'appel entrant au numéro interne du standard virtuel
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET)); le début de l'appel sortant du standard virtuel
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['internal'] . $_POST['destination'] .
$_POST['call_start'], API_SECRET)); la fin de l'appel sortant du standard virtuel
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['internal'] . $_POST['destination'] .
$_POST['call_start'], API_SECRET)); l'enregistrement de l'appel est prêt à télécharger
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['pbx_call_id'] . $_POST['call_id_with_rec'], API_SECRET)); la réponse de l'abonné à l'action demandée
$signatureTest = base64_encode(hash_hmac('sha1',
$_POST['caller_id'] . $_POST['called_did'] .
$_POST['call_start'], API_SECRET));
le rapport de vérification des numéros
$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));
l'information sur les appels aux numéros, connectés au call tracking
Les paramètres envoyés au lien de notifications:
$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));
l'information sur les SMS entrants
$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));
résultat de reconnaissance de la voix
Paramètres envoyés au lien pour les notifications:
informations sur la vérification des documents
{
"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']); ?>
Pour augmenter la sécurité nous recommandons d'autoriser l'accès à votre lien de l'adresse IP 185.45.152.42.
Si vous avez sorti les clés d'accès à API , dans chaque demande à votre lien sera envoyé un titre supplémentaire "Signature", selon lequel vous porrez vérifier l'intégrité et l'authenticité des données.
Voir l'exemple de script vous pouvez à notre dépôt sur GitHub.