Consommation des services
Obtenir le detail des consommations des services data et voix.
Netwo - API consommation voix / data (CDR)
La restitution du détail des consommations des services Netwo est disponible par API.
Spécifiquement pour ce service, le format CSV est également disponible en plus du format JSON.
Requête
Format JSON
GET /consumption
Format CSV
GET /consumption/csv
paramètres de la requête
-
after_id : liste les lignes de CDR à partir de l'identifiant du CDR (
id_cdr
) spécifié (exclus). -
after_date : liste les lignes de CDR à partir de la date spécifiée spécifié (Ex:
2022-11-25T18:00:39.349Z
).L'un ou l'autre des paramètres
after_id
etafter_date
est obligatoire. Les deux ne peuvent pas être présents simultanément.L'usage du paramètre
after_id
permet d'accéder aux dernières 48h seulement. Le paramètreafter_id
devrait être utilisé dans le contexte d'une synchronisation régulière.
Pour accéder à une période antérieure, il faut utiliser le paramètreafter_date
. -
limit : permet de spécifier le nombre maximum de résultats. Ce paramètre est obligatoire et borné (actuellement à 5000, mais cette valeur est susceptible d'évoluer)
-
infra_type : Permet de filtrer sur le type d'infrastructure (facultatif).
Valeurs possibles :
- mobile
- landline (pas encore disponible) -
event_type : Permet de filtrer sur le type d'évènement (facultatif).
Valeurs possibles :
- voice_call (pas encore disponible)
- sms (pas encore disponible)
- mms (pas encore disponible)
- data -
service_ids : Permet de limiter la recherche aux lignes de CDR correspondants aux services spécifiés dans la liste
service_ids
. -
iccids : Permet de limiter la recherche aux lignes de CDR correspondants aux iccids spécifiés dans la liste
iccids
. -
service_hierarchy_ids : Permet de limiter la recherche aux lignes de CDR correspondants aux services spécifiés dans la liste
service_hierarchy_ids
.service_ids
,iccids
etservice_hierarchy_ids
sont mutuellement exclusifs. Il n'est pas obligatoire d'utiliser un de ces paramètres.
Exemple d'une requête
GET /consumption?after_id=123453456&limit=2000&service_ids[]=5527053d-f9d9-4288-969a-5458b1b0dc54&service_ids[]=d59fb93f-b176-458b-84a4-af5b5d5d5022
Formats de réponse
Deux formats sont proposés :
- Le format JSON
- Le format CSV :
- séparateur de champs : ","
- séparateur de lignes : "\n"
les formats CSV et JSON sont susceptibles d'évoluer.
Des champs seront ajoutés au fur et à mesure que l'offre telecom Netwo s'enrichira, c'est pourquoi il est vivement recommandé de baser la mapping des champs sur le nom plutôt que sur l'ordre.
Détails des informations restituées
Champs CSV | Champs JSON | Description | Type | Exemple | Optionnel |
---|---|---|---|---|---|
cdr_id | cdr_id | Identifiant unique et strictement croissant de CDR | int(8) | 2345676543 | non |
start_date | start_date | Date de début de la mesure / de l'appel | DateTime(UTC) | 2022-11-25T18:00:39.349Z | non |
end_date | end_date | Date de fin de la mesure / de l'appel | DateTime(UTC) | 2022-11-25T19:00:39.349Z | non |
infra_type | infra_details.type | Type d'infrastructure (fixe, mobile) | enum(mobile, landline) | mobile | non |
iccid | infra_details.iccid | ICCID : identifiant de la carte SIM (mobile uniquement) | String(20) | 89461733011826019699 | oui |
msisdn | infra_details.msisdn | MSISDN : Numéro de téléphone | String(15) | 0612345678 | oui |
imsi | infra_details.imsi | Identifie l'abonné (mobile uniquement) | String(16) | 208391134567890 | oui |
imei | infra_details.imei | Identifie l'équipement (mobile uniquement) | String(15) | 49015420323751 | oui |
origin_network | infra_details.origin_network | Réseau opérateur d'origine - TADIG code (mobile uniquement) | String | FRAF1 | oui |
event_type | event_details.type | Type de communication (Voix, SMS, MMS, data) | enum(voice_call, sms, mms, data) | data | non |
data_consumption_up_bytes | event_details.data_consumption_up_bytes | Consommation de données (envoi) (data uniquement) | int(8) | 3456764345 | oui |
data_consumption_down_bytes | event_details.data_consumption_down_bytes | Consommation de données (réception) (data uniquement) | int(8) | 8765434534 | oui |
service_hierarchy_id | service_hierarchy_id | Identifiant unique de la ligne téléphonique/data | uuid | 13921A62-80AA-4FCD-B4D5-32540A283264 | oui |
Exemple au format JSON
[
{
"cdr_id": 2345676543,
"start_date": "2022-11-25T18:00:39.349Z",
"end_date": "2022-11-25T19:00:39.349Z",
"infra_details": {
"type" : "mobile",
"iccid" : "89461733011826019699",
"msisdn": "0612345678",
"imsi": "208391134567890",
"imei": "49015420323751",
"origin_network": "FRAF1"
},
"event_details": {
"type": "data",
"data_consumption_up_bytes": 3456764345,
"data_consumption_down_bytes": 8765434534
},
"service_hierarchy_id": "13921A62-80AA-4FCD-B4D5-32540A283264"
}
]
Exemple au format CSV
cdr_id,start_date,end_date,infra_type,event_type,iccid,msisdn,imsi,imei,origin_network,data_consumption_up_bytes,data_consumption_down_bytes,service_hierarchy_id
2345676543,2022-11-25T18:00:39.349Z,2022-11-25T19:00:39.349Z,mobile,data,89461733011826019699,0612345678,208391134567890,49015420323751,FRAF1,3456764345,8765434534,13921A62-80AA-4FCD-B4D5-32540A283264
Updated 16 days ago