Request Data

Action and Server respons is fully customisable per Client or per Key Set, Examples are provided here for clarification

Operations

Request CDR

Request

Retrieve a list of call detail records.

Returns 1000 entries by default and a maximum of 10,000 entries.
Default for date from and date to is today.
Features could be any additional routing configured on the backend. Could be call outcome, IVR, call survey, selected Post Code for PCP...etc.
If any of the additional parameters are ommitted from the call, the default value is considered.
stt feature requires your Account to be enabled for Speech To Text, Please contact AVANSER Support for more informations about speech to text.
subclient feature requires your Account to be enabled for Divisions & SubClients access, Please contact AVANSER Support for more informations about Division Configuration.
sentiment feature displays the sentiment analysis.

Server Response

Key	Description
id	Unique call identification number (integer 11 digits).
date	YYYY-MM-DD HH:MM:SS (AEST/AEDT).
duration	Call duration in seconds (integer).
answer_number	Answer Point Number in international format (Integer 8-15 digits).
answer_name	Answer Point Name (50 alphanumeric).
answer_folder	A unique identifier for the answerpoint.
target_number	Call Tracking Number (integer 8-15 digits).
target_name	Ad Source Name (50 alphanumeric).
caller_number	Originating Caller ID in international format (integer 8-15 digits).
country	Country code of the originating caller (2 characters).
state	Originating caller state/territory (5 alphanumeric).
location	Location of originating caller (50 alphanumeric).
status_code	2 digits (see Call Completion Codes table).
status_name	20 alphanumeric (see Call Completion Codes table).
audio	Message/Recording – audio file type.
audioURL	URL to the audio file.
spooler_id	Unique ID for extra referrer parameters that can be obtained by calling the getC2C method (set to 0 if no extra parameters exist).
evaluation_xx	Answers to the evaluation question, XX is the ID of the evaluation question (refer to action Evaluation Details for more details).
feature01 - feature09	Features as configured.
feature10	AVANSER reserved field.
audioUrl	url of call recording.
webReferrer	Referring website URL.
webURL	Client website URL.
webLanding	Landing page URL on client website.
webConversion	Online ad campaign where call was generated.
webKeyword	Keywords(s) typed in by user to find campaign.
webMedium	Medium through which user landed.
webSource	Source used to find client website.
IP	IP address of the user.
IPlocation	IP location of the user.
connection_time	YYYY-MM-DD HH:MM:SS (AEST Time).
connection_duration	Seconds passed between call landing and call connection.
date_stop	Call stop date and time.
wpcid	AdSource's wpcid.
masterId	AdSource's masterId.
call_notes	Array containing all call notes.
cdr_label	Label associated with the CDR
cdr_tag	Tag associated with the CDR
custom_id	Customers can set this field on a tracking number for their internal system reference (only provided when show_custom = 'yes')
custom_group	Customers can set this field on a tracking number for their internal tracking (only provided when show_custom = 'yes')
memo	Customers can set this field on a tracking number for their own notes (only provided when show_custom = 'yes')
dealerCode	Dealer Code associated with the CDR, for ARTIC calls this is going to be the Agent Code
subclient	Can be either a subclient available in your Division or keyword `all` to fetch all configured subclients.
stt	Speech To Text is set to 'yes' fetches transcribed data, if available.
sentiment_score	Overall score for the call.
sentiment_agent	Single sentiment score for the the agent.
sentiment_caller	Single sentiment score for the caller.
sentiment_talkmost	`agent`, `caller`, `balanced` based on who spoke the most.
sentiment_communication	Quality of communication.
sentiment_conduct	Agent conduct.
sentiment_politeness	Assesses the politeness of the agent. The agent is scored based on their use of phrases associated with politeness.
sentiment_highrisk	Flags if the call was High Risk.
sentiment_badattitude	Assesses the attitude of the agent. The agent is scored based on their use of phrases that either indicate an unwillingness to help or intention to insult the caller.
sentiment_slang	Assesses whether the agent used colloquial language in the call. The agent is scored based on their use of slang phrases.
sentiment_profanity	Assesses whether the agent used profanities in the call. The agent is scored based on their use of profane phrases.

Security

HTTP_BASIC or sessionToken

Query

account_idstringrequired

Provided by AVANSER. Required only for token-based authentication.

Example:account_id=example.user

tokenstringrequired

Token received from Phase 2 of Authentication. Required only for token-based authentication.

Example:token=bzNDGPOMUu4pmGZZ0yyzvTlQZZNPnQPP

date_fromstring

Start Date.

Example:date_from=2017-10-27

date_tostring

End Date.

Example:date_to=2017-10-28

last_idstring

Call ID of the last CDR result – Sends records for call IDs higher than the one specified.

Example:last_id=34560626

limitnumber

Maximum number of CDRs in reply (max 10,000).

Default:1000

bnumstring

If provided, will restrict response to calls to that specific number. Number to be provided in the following format: +CC-NNNNNNNN where CC is country code (e.g. 61, 64, 65 etc), -NNNNNNNN is telephone number including area code.

Example:bnum=+61-0290081234 (Australia landline) | +65-66641234 (Singapore landline)

evaluationsstring

Include the answers to the call evaluations.

Default:"no"

Enum:"yes""no"

featuresstring

Include additional routing feature values. Please note that feature configurations vary from client to client. Contact Support for more information.

Default:"no"

Enum:"yes""no"

wavstring

Returns the url of the call recording.

Default:"no"

Enum:"yes""no"

webstring

Returns extra web log details.

Default:"no"

Enum:"yes""no"

detailedstring

Returns all call details, without needing to specify the parameters: features, wav, web, stt, localtime, and sentiment.

Default:"no"

Enum:"yes""no"

localtimestring

Returns all dates and times as Answer Point time zone is configured on the system.

Default:"no"

Enum:"yes""no"

cdr_labelstring

If provided, will restrict response to calls to that specific label

cdr_tagstring

If provided, will restrict response to calls to that specific tag

dealerCodestring

If provided, will restrict response to calls to that specific dealerCode

sttstring

If set, returns call transcribed. When this feature is enabled json response will include additional speech to text results.

Default:"no"

Enum:"yes""no"

subclientstring

If provided, will fetch records for all your subclients. When this feature is enabled json response will include additional fields "subclient_name" and "subclient_id"

sentimentstring

If set, returns call sentiment. When this feature is enabled json response will include additional sentiment results. Using only flag will display calls that only have a sentiment analysis.

Default:"no"

Enum:"yes""only""no"

call_statusnumber

If provided, will restrict calls to that specific status.

Enum:0123456

adtagstring

If provided, will restrict calls to adsources with that specific tag

orderstring

If set, reverses the sorting of the records

Default:"first"

Enum:"first""last"

client_idnumber

When using Http Basic Authentication over SSL this parameter allows the user to select what client the request is for.

show_customstring

If provided, will return the additional customer defined fields. This includes custom id, custom group and memo fields.

Default:"no"

Enum:"yes""no"

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.avanser.com/JSON?action=getCDR?account_id=example.user&token=bzNDGPOMUu4pmGZZ0yyzvTlQZZNPnQPP&date_from=2017-10-27&date_to=2017-10-28&last_id=34560626&limit=1000&bnum=%2B61-0290081234%20(Australia%20landline)%20%7C%20%2B65-66641234%20(Singapore%20landline)&evaluations=yes&features=yes&wav=yes&web=yes&detailed=yes&localtime=yes&cdr_label=string&cdr_tag=string&dealerCode=string&stt=yes&subclient=string&sentiment=yes&call_status=0&adtag=string&order=first&client_id=0&show_custom=yes'

Responses

Retrieve a list of call detail records.

Body

resultsinteger

Example:1

callsArray of objects(CallDetailRecord)

Response

{
  "results": 1,
  "calls": [
    { … }
  ]
}

Request Data

Request CDR

Request

Server Response

Query

Responses

Was this helpful?