SparkTG

Documentation de Rapport CDR (v2)

Rapport CDR (v2)

v2

Rapport CDR (v2)

Enregistrements détaillés des appels sur une période

API v2v21 point de terminaison

Présentation

Facturable : cette API est facturée en fonction du nombre d'enregistrements renvoyés. Contactez votre gestionnaire de compte pour connaître les tarifs. Renvoie les enregistrements détaillés des appels (CDR) pour le service et la période. Envoyez un corps JSON (Content-Type: application/json). start_time et end_time sont obligatoires, comme sur tous les endpoints de rapports ; une requête sans eux renvoie 400. svc_id est facultatif et correspond par défaut au service du jeton ; si vous l'envoyez, l'utilisateur du jeton doit être autorisé pour ce service, sinon la requête renvoie 403. Le champ mode permet de choisir normal (par défaut, une liste CDR standard avec totaux) ou extended (les mêmes enregistrements, plus les durées IVR et file d'attente et les temps d'attente). Le corps de la requête est identique dans les deux modes. limit est plafonné à 5000 ; si vous demandez davantage, il est ramené à 5000, utilisez donc offset pour parcourir les jeux de résultats plus volumineux. Les paramètres inconnus sont ignorés.

Points de terminaison disponibles

POST/api/v2/reports/cdr

Paramètres clés

mode(String)

normal (par défaut) ou extended.

svc_id(Integer)

Service sur lequel porte le rapport. Par défaut, le service du jeton.

start_time(Integer (epoch ms))

Début de la période.

end_time(Integer (epoch ms))

Fin de la période (exclusive sur l'heure de début de l'appel).

offset(Integer)

Décalage de pagination (identique dans les deux modes). Par défaut 0.

limit(Integer)

Taille de page. Par défaut 30. Maximum 5000 ; les valeurs supérieures sont plafonnées.

Scénarios d'utilisation

Mode normal

Le mode par défaut. ring_start_time, start_time et end_time sont renvoyés sous forme de chaînes yyyy-MM-ddTHH:mm:ss en IST.

0 paramètreDisponible dans les exemples

Mode étendu

Définissez mode sur extended. L'enveloppe et tous les champs du mode normal restent inchangés ; chaque enregistrement contient en plus agent_answered, ivr_in_time, ivr_out_time, ivr_duration, queue_in_time, queue_out_time, queue_duration et total_wait_duration.

0 paramètreDisponible dans les exemples

Exemple rapide

Essayez cette API avec une simple commande cURL

Appel d'API de base
curl -X POST 'https://telephonycloud.co.in/api/v2/reports/cdr' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"svc_id": 3, "start_time": 1775759400000, "end_time": 1776364200000, "offset": 0, "limit": 30, "call_type": "OUTBOUND", "disposition": "ANSWER"}'
💡 Remplacez <YOUR_TOKEN> par votre jeton d’API

Aperçu de la réponse

Exemple de réponse de cette API

Exemple de réponse
{"count":268,"data":[{"call_transaction_id":"d341e47a-767a-44fb-8d79-9bf38f4caa28","svc_id":3,"call_type":"OUTBOUND","customer_number":"9634780846","agent_number":"10101","disposition":"Answer","durat...
Voir le format de réponse complet dans la section Réponse