Call history API

This API allows you to retrieve the history of incoming and outbound calls, using two methods.

1 General considerations

The API uses the REST paradigm, accepting data as parameters by way of GET or POST operations, and returning data in JSON format.

1.1 Parameters

All the API functions require the use of the following login parameters:

NameTypeDefaultMand.Description
loginAlphanum 32YAPI user ID
passwordAlphanum 32YPassword

And filter parameters to extract data:

NameTypeDefaultMand.Description
dateYYYY-MM-DDYStart date or requested date
date_endYYYY-MM-DDNEnd date, max 1 month from the start date
service_numberNumériqueNService number, in the E.164 format
caller_numberNumériqueNCaller number, in the E.164 format

1.2 Incoming call history

URL/vm/calls/in
Method(s)POST

Query format

Queries must be formatted as follows:

curl "https://api.axialys.com/vm/calls/in" -u <login>:<password> -H "Content-Type: application/json" -d '{"date":"<YYYY-MM-DD>", "date_end":"<YYYY-MM-DD>",  "service_number":"<e164>", "caller_number":"<e164>"}' -X POST

Response

NameTypeDescription
id_appelNumericcall ID
dateDateDate, in the ISO 8601 format
service_numberNumericService number, in the E.164 format
caller_numberNumericCaller number, in the E.164 format
cpNumericCaller postcode
post_appelNumericPause time, in seconds
duration_ringNumericRing time, in seconds
durationNumericCall duration, in seconds
statusAlphanumOutbound call status
group_nameAlphanumName of the group that received the call
op_nameAlphanumName of the operator who received the call
rub_nameAlphanumName of the section that received the call
id_op NumIdentifier of the operator who received the call

NB: “op_name”, and “rub_name” are updated after 2 hours, so the method must be called least 2 hours after the service closing time.

1.3 Outbound call history

URL/vm/calls/out
Method(s)POST

Query format

Queries must be formatted as follows:

curl "https://api.axialys.com/vm/calls/out" -u <login>:<pass> -H "Content-Type: application/json" -d '{"date":"<YYYY-MM-DD>, " date_end ":"<YYYY-MM-DD>", "service_number":"<e164>", "called_number":"<e164>" }' -X POST

Response

NameTypeDescription
id_appelNumericcall ID
dateDateDate, in the ISO 8601 format
service_numberNumericService number, in the E.164 format
caller_numberNumericCaller number, in the E.164 format
cpNumericCaller postcode
post_appelNumericPause time, in seconds
duration_ringNumericRing time, in seconds
durationNumericCall duration, in seconds
statusAlphanumOutbound call status
group_nameAlphanumName of the group that received the call
op_nameAlphanumName of the operator who received the call
rub_nameAlphanumName of the section that received the call
id_opNumIdentifier of the operator who received the call
The call ID (id_appel) of an outbound call is preceded by a “-”.

1.4 List of call statuses

Common to both types of call:

NameDescription
ANSWERanswered
BUSYbusy
NOANSWERunanswered
UNKNOWNunknown
CANCELcancelled
CONGESTIONcongestion
CHANUNAVAILchannel unavailable

Specific to incoming calls:

NameDescription
NOno transfer
CALLBACKcallback
VOICEMAILvoicemail

1.5 Call history in groups

URL/vm/calls/out
Method(s)POST

The request must be made in the form:

curl “https://api.axialys.com/vm/calls/groups” -u <login>:<password> -H “Content-Type: application/json” -d ‘{“date”:”<YYYY-MM-DD>”, “date_end”:”<YYYY-MM-DD>”, “service_number”:”<e164>”, “caller_number”:”<e164>”}’ -X POST

Back

NameTypeDescription
id_appelNumCall identifier
dateDateDate in ISO 8601 format
service_numberNumService number in e164 format
caller_numberNumCaller's number in e164 format
date_inDateGroup entry date in ISO 8601 format
date_outDateGroup exit date in ISO 8601 format
date_answerDateDate call answered, in ISO 8601 format
durationNumDuration of call in seconds
group_nameAlphanumName of group that received the call
op_nameAlphanumName of operator who received the call

1.6 Call history in categories

URL/vm/calls/out
Method(s)POST

The request must be made in the form:

curl “https://api.axialys.com/vm/calls/rubriques” -u <login>:<password> -H “Content-Type: application/json” -d ‘{“date”:”<YYYY-MM-DD>”, “date_end”:”<YYYY-MM-DD>”, “service_number”:”<e164>”, “caller_number”:”<e164>”}’ -X POST

Back

NameTypeDescription
id_appelNumCall identifier
dateDateDate in ISO 8601 format
service_numberNumService number in e164 format
caller_numberNumCaller's number in e164 format
date_inDateGroup entry date in ISO 8601 format
date_outDateGroup exit date in ISO 8601 format
date_answerDateDate call answered, in ISO 8601 format
durationNumDuration of call in seconds
rub_name AlphanumName of rubric that received the call