telecoms.calldata.detail.get function

In addition to custID, you must also supply at least one of callID, callID.min, callID.max.

arg	required?	syntax	info
`custID`	N	posint	custID of account containing the calldata you want to fetch (default is your own account)
`callID`	conditional	list:posint	optional filter to limit the results to specific calls
`callID.min`	conditional	posint	optional filter; will only return calls with a callID greater or equal to this
`callID.max`	N	posint	optional filter; will only return calls with a callID less or equal to this
`disposition`	N	list:enum	optional filter; limit results to calls with specific dispostions
`is_chargeable`	N	boolean	optional filter; limit results to calls that are chargeable (if true) or not chargeable (if false)
`date.min`	conditional	isodate	specifies the earliest date for which you want to retrieve call data
`date.max`	Y	isodate	specifies the latest date for which you want to retrieve call data
`dni`	N	list:posint	optional filter; list of phone numbers for which to return call data
`dni.min`	N	posint	optional filter; smallest phone number (compared numerically) for which to return call data
`dni.max`	N	posint	optional filter; largest phone number (compared numerically) for which to return call data
`dni.starts`	N	unsint	optional filter; limit results to numbers beginning with this
`format`	N	enum	specify output format as "array" (default), "csv" or "tabdel"
`fields`	N	list:enum	supply an array of field names if you want to limit the output to only contain certain fields
`optfields`	N	list:enum	like "fields" except that this list is additive, not absolute.
`startfrom`	N	unsint	first matching call to return, counting from zero
`numtoreturn`	N	posint	number of records to return (subject to a built in hard limit)
`localise`	N	boolean	whether to localise phone numbers into more familiar UK phone numbers (defaults to on)
`sort`	N	list:enum	defines the sort order of the results; a comma separated list of output fields to sort by
`countinfo`	N	set:totmatches\|more_rows	controls what type of pagnination info to return (default=totmatches)

Further argument information

callID

Supply the value as a string of ID values separated by commas, or as an array of ID values.

disposition

Supply the value as a string of ID values separated by commas, or as an array of ID values. Values are:

all - get calls regardless of disposition
ANSWER - normal answered calls
BUSY - calls that failed because the destination was engaged
NOANSWER - remote termination - call was unanswered after the maximum ringing time was reached
CANCEL - local termination - caller hangs up before destination answers
CHANUNAVAIL - call failed due to network congestion
CONGESTION - call failed due to network congestion
FAILED - this is usually when a caller hangs up before our system has attempted to connect them to the destination. The most likely cause of this is that the number they dialled has a calling party announcement and they hung up while this was playing.

If you are trying to fetch all call data, use the 'all' disposition value. This is the only way of picking up calls that were still in progress at the time the stats were gathered. You might want to later re-query these specfic calls.

fields

A specific list of fields to return. You can use this argument to specify a reduced list of fields to fetch; you can include any of the standard fields and any of the optional fields (see optfields below). Supply the value as a string of field names separated by commas, or as an array of field names.

optfields

A list of extra fields to fetch with the call data. Fields specified here will be returned as well as the fields that are returned by default. This differs from the "fields" argument, which causes only the specified fields to be returned.

Supply the value as a string of field names separated by commas, or as an array of field names. Values are:

ref - include the ref string for the number or call (see telecoms.num.ref.set)
extra_params - sub-array of additional call parameters (only applies to some call types)
feature_flags - a list of features that apply to the call, eg (this is not a definitive list):
- CALLREC - the call was recorded
- DNIENBL - DNI enabling (DNI as CLI) was enabled for this call
start_epoch - the unix epoch timestamp of the start_time field (the start_epoch field represents UTC)
answer_epoch - the unix epoch timestamp of the answer_time field (the answer_epoch field represents UTC)
end_epoch - the unix epoch timestamp of the end_time field (the end_epoch field represents UTC)
end_time - the call end time in UK local time
gw_uniqueID - a unique ID string for the call (used in some currently undocumented features)
callrecURL - the URL of the call recording file for recorded calls (this field will not be returned for calls that were not recorded)

countinfo

This argument controls which pagination info will be returned by the function. Supply either a comma separated list or an array of values. You can supply an empty list (for no info), or one (or both) of:

more_rows - results in a 'more_rows' element being returned with the results. This will be either 1 or 0 to indicate whether there are more records matching the search criteria but were not returned.
totmatches - results in a 'totmatches' element being returned with the results. This will be the total number of records matching the search criteria, regardless of the settings for startfrom and numtoreturn (and regardless of the built in hard limit for the number of records returned).

Note: specifying more_rows is potentially far more efficient than totmatches and is the recommended method. The argument defaults to totmatches for backward compatibility with older scripts.

Arguments: