Embedded Files
Comment configurer les différentes API ?
Comment configurer les différentes API ?
Premièrement, rendez-vous dans la section "Intégration API" sur votre interface Graam Reseller.
(/!\ Attention de bien vous rendre sur votre compte Reseller pour récupérer votre API)
I. Générer votre clé API
I. Générer votre clé API
Sur cet écran vous aurez accès à la génération de votre clé d'API.
Pour configurer une nouvelle API Key cliqué sur le bouton "Générer une nouvelle clé API".
II. Récupération de la liste des comptes liés au Reseller
II. Récupération de la liste des comptes liés au Reseller
Pour récupérer la liste des comptes liés à votre compte Reseller, il faut faire un appel GET à l'URL suivante :
https://admin.graam.com/ws-v2/api/public/reseller/enterprise/list?apikey=[VOTREAPIKEY]
Vous retrouverez ci-dessous un exemple de retour envoyé, il sera envoyé en HTTP POST avec un payload json :
{
"__version__": 2,
"status": "success",
"answer": [
{
"name": "Compte 1",
"domain": "compte1"
},
{
"name": "Compte 2",
"domain": "compte2"
},
{
"name": "Compte 3",
"domain": "compte3"
}
]
}
II. Récupération des états d'enregistrement SIP d'un compte
II. Récupération des états d'enregistrement SIP d'un compte
Pour récupérer la liste des états d'enregistrement SIP d'un compte (compte enfant) , il faut faire un appel GET à l'URL suivante :
https://admin.graam.com/ws-v2/api/public/reseller/enterprise/sip-registration-status/[DOMAINE_DU_COMPTE_ENFANT]?apikey=[VOTREAPIKEY]
Vous retrouverez ci-dessous un exemple de retour envoyé, il sera envoyé en HTTP POST avec un payload json :
{
"__version__": 2,
"status": "success",
"answer": [
{
"extension": "1000",
"connected_phone": [
{
"user_agent" : "Yealink SIP-T53W 96.86.0.45",
"received_from" : "46.193.64.44",
"contact_ip" : "10.216.40.243"
}
"description": "description test",
"user": null,
"user_email": null,
"room": "Chambre 1"
]
},
{
"extension": "1001",
"connected_phone": [],
"description": "description test",
"user": "Utilisateur test",
"user_email": "utilisateur_test@yopmail.com",
"room": null
}
]
}
III. Récupération des stats d'un compte spécifique
III. Récupération des stats d'un compte spécifique
Pour récupérer les stats d'un compte spécifique, il faut faire un appel GET à l'URL suivante :
https://admin.graam.com/ws-v2/api/public/reseller/enterprise/daily-stats/[DOMAINE_DU_COMPTE_ENFANT]?apikey=[VOTREAPIKEY]
Vous retrouverez ci-dessous un exemple de retour envoyé, il sera envoyé en HTTP POST avec un payload json :
{
"__version__": 2,
"status": "success",
"answer": {
"domain": "fleurdeloire",
"connected_phone": 60,
"total_phone": 84,
"missed_call": 3,
"active_call": 0
}
}
IV. Récupération des stats d'appels sur une période
IV. Récupération des stats d'appels sur une période
Pour récupérer les stats des appels d'un compte spécifique, il faut faire un appel GET à l'URL suivante :
https://admin.graam.com/ws-v2/api/public/reseller/enterprise/call-count/[DOMAINE_DU_COMPTE_ENFANT]?apikey=[VOTREAPIKEY]&start_dt=[DateDeDebut]&end_dt=[DateDeFin]
Exemple de URL: https://admin.graam.com/ws-v2/api/public/reseller/enterprise/call-count/compte_de_test?apikey=7C3824AE74B343&start_dt=2022-12-01&end_dt=2022-12-15
Vous retrouverez ci-dessous un exemple de retour envoyé, il sera envoyé en HTTP POST avec un payload json :
{
"__version__": 2,
"status": "success",
"answer": {
"missed_call_count": 60,
"missed_call_unhandled": 42,
"inbound_call_count": 132,
"outbound_call_count": 0
}
}
IV. Création d'une chambre d'hôtel
IV. Création d'une chambre d'hôtel
Pour créer une chambre d'hôtel, il faut faire un appel POST à l'URL suivante :
https://admin.graam.com//ws-v2/api/public/reseller/enterprise/create-hotel-room/[DOMAINE_DU_COMPTE_ENFANT]?apikey=[VOTREAPIKEY]
Lors de l'appel à l'API, il faudra envoyer dans le body le paramètre room_number correspondant au numéro de la chambre, vous avez aussi la possibilité d'envoyer le paramètre extension correspondant à l'identifiant SIP. (Le paramètre extension n'est pas obligatoire, si celui-ci n'est pas défini une nouvelle extension SIP sera créée)
{
"extension": "1002",
"room_number": "101"
}
Vous retrouverez ci-dessous un exemple de retour envoyé, il sera envoyé en HTTP POST avec un payload json :
{
"__version__": 2,
"status": "success",
"answer": {
"extension": "1002",
"room_number": "101"
}
}
V. Lier une MAC Adress à une extension SIP ou une chambre
V. Lier une MAC Adress à une extension SIP ou une chambre
Pour lier une adresse MAC à une extension SIP ou une chambre, il faut faire un appel POST à l'URL suivante :
https://admin.graam.com//ws-v2/api/public/reseller/enterprise/sipphone-config/[DOMAINE_DU_COMPTE_ENFANT]/link_sip_phone?apikey=[VOTREAPIKEY]
Lors de l'appel à l'API il faudra envoyer dans le body le paramètre mac_address correspondant à l'addresse MAC du téléphone concerné. (le paramètre est obligatoire)
Il faudra ensuite ajouter le paramètre extension et/ou room_number correspondant à l'identifiant SIP ou la chambre d'hôtel à laquelle vous voulez lier le téléphone. (Il faut définir au moins une extension ou un room_number)
{
"mac_address": "000b82bae7a9",
"extension": "1012",
"room_number": "100"
}
Vous retrouverez ci-dessous un exemple de retour envoyé, il sera envoyé en HTTP POST avec un payload json :
{
"__version__": 2,
"status": "success",
"answer": {
"extension": "1012",
"token": "000b82bae7a9",
"last_updated_dt": "2022-05-24T12:51:28.000+00:00",
"phone_model": null,
"firmware_version": null
}
}
Page updated
Report abuse