Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Verba_source

http://192.168.1.104/verba/gwtCallSearch.do?reset=1&p_date_from=2011-07-10 23:59:59&p_date_to=2011-07-11 21:00:00&p_phone_number=1002&p_phone_number_operator=INCLUDES

...

Verba_source

http://192.168.1.104/verba/extssologin.do?token=12345&ssotarget=gwtCallSearch.do&reset=1&p_date_from=2011-07-10 23:59:59&p_date_to=2011-07-11 21:00:00&p_phone_number=1002&p_phone_number_operator=INCLUDES

Detailed description of the API request elements:

API request element

Description

Requirements
http://192.168.1.104/verba/gwtCallSearch.doVerba direct HTTP URL.Mandatory
reset=1The system will delete the user's current ("default") search parameters from the database,and create a new one according to the additional parameters,described below. Basically, this parameter flags that the system should act differently than in case of a normal call search.Optional
autoplay=1If there is only 1 call in the results, the system will automatically start playing the call back.Optional
p_date_from=2011-07-10 23:59:59

Start date and time for the query.

Date format is: yyyy-mm-dd hh24:mi:ss.

The time part can be omitted, so 2011-07-10 is a valid format too, in this case time will be set to 00:00:00

If the parameter is missing it will default to today at 00:00:00.
p_date_to=2011-07-11 21:00:00

End date and time for the query.

Date format is: yyyy-mm-dd hh24:mi:ss

If the time part omitted, it will default to 23:59:59.

If the parameter is missing it will default to today at 23:59:59.
p_date=2011-07-11 21:00:00

This is an alternative date search option. If this is used, p_date_from and p_date_to is ignored.

Date format is: yyyy-mm-dd hh24:mi:ss

If the parameter is missing it will default to 10 minutes.

p_date_window=10

The resulting search will show a time interval from (p_date - p_date_window) to (p_date + p_date_window).

Time is given in minutes.

 

p_date_last_days=30If defined the search results will show calls from the last X daysIf defined, no other date related information is required.
p_phone_number=1002Phone Number (Caller or Called Party) filter.Optional
p_phone_number_operator=INCLUDES

Operator to be used when filtering for Phone Number.

The following valid values apply:

  • =
  • !=
  • IN
  • NOT_IN
  • EXISTS
  • DOES_NOT_EXIST
  • STARTS_WITH
  • ENDS_WITH
  • INCLUDES
  • LIKE
  • BETWEEN

The default operation is "equals" (=).If the operator is IN or NOT_IN, the values should be separated by commas.

Optional
p_direction=incoming,outgoing

Call direction filter.

The following valid values apply:

  • internal
  • incoming
  • outgoing
  • inter-tenant
  • undefined
Optional
p_direction_operator=IN

Operator to be used when filtering for Call Direction.

The following valid values apply:

  • =
  • !=
  • IN
  • NOT_IN
  • EXISTS
  • DOES_NOT_EXIST
  • STARTS_WITH
  • ENDS_WITH
  • INCLUDES
  • LIKE
  • BETWEEN

The default operation is "equals" (=).If the operator is IN or NOT_IN, the values should be separated by commas.

Optional
p_caller=1005Caller Party Phone Number filterOptional
p_caller_operator=LIKEOperator to be used when filtering for Caller Party Phone NumberOptional
p_called=236783Called Party Phone Number filterOptional
p_called_operator=LIKE

Operator to be used when filtering for Called Party Phone Number.

The following valid values apply:

  • =
  • !=
  • IN
  • NOT_IN
  • EXISTS
  • DOES_NOT_EXIST
  • STARTS_WITH
  • ENDS_WITH
  • INCLUDES
  • LIKE
  • BETWEEN

The default operation is "equals" (=).If the operator is IN or NOT_IN, the values should be separated by commas.

Optional
p_caller_name=James WoodsCaller Party Name filterOptional
p_caller_name_operator=LIKE

Operator to be used when filtering for Caller Party Name.

The following valid values apply:

  • =
  • !=
  • IN
  • NOT_IN
  • EXISTS
  • DOES_NOT_EXIST
  • STARTS_WITH
  • ENDS_WITH
  • INCLUDES
  • LIKE
  • BETWEEN

The default operation is "equals" (=).If the operator is IN or NOT_IN, the values should be separated by commas.

Optional
p_called_name=Richard DreyfusCalled Party Name filterOptional
p_called_name_operator=LIKE

Operator to be used when filtering for Called Party Name.

The following valid values apply:

  • =
  • !=
  • IN
  • NOT_IN
  • EXISTS
  • DOES_NOT_EXIST
  • STARTS_WITH
  • ENDS_WITH
  • INCLUDES
  • LIKE
  • BETWEEN

The default operation is "equals" (=).If the operator is IN or NOT_IN, the values should be separated by commas.

Optional
p_server=NYREC-SERVERRecording Server filter.This field corresponds to the hostname of the recording server.Optional
p_server_operator=LIKE

Operator to be used when filtering for Recording Server.

The following valid values apply:

  • =
  • !=
  • IN
  • NOT_IN
  • EXISTS
  • DOES_NOT_EXIST
  • STARTS_WITH
  • ENDS_WITH
  • INCLUDES
  • LIKE
  • BETWEEN

The default operation is "equals" (=).If the operator is IN or NOT_IN, the values should be separated by commas.

Optional
p_duration=120-150Duration filter in seconds.Optional
p_duration_operator=BETWEENOperator to be used when filtering for Duration.

The following valid values apply:

  • BETWEEN
Optional
p_normalize=1If this is set to 1, the p_local_prefix and p_country_prefix parameters will be used to add additional phone number search variants.
Normalization is not happening on SIP addresses.
Optional
p_local_prefix=0If a phone number starts with this p_local_prefix, normalization will add a search variant, where this part is removed and p_default_country is added
Example: if p_local_prefix=0 and p_default_country=44, then 012345678 will be normalized to +4412345678
Optional
p_country_prefix=+46
(deprecated - see p_default_country)
If a phone number starts with this p_local_prefix, normalization will add a search variant, where this is removed and p_country_prefix is addedDeprecated
p_default_country=44This country code will be added when numbers are found in non-international formats (non-E.164 formatss)
See p_local_prefix, p_external_prefix and p_international_prefix.
Optional
p_external_prefix=9

If a phone number starts with this p_external_prefix, normalization will add a search variant, where this part is removed and the number is normalized based on p_local_prefix and p_international_prefix
Example: if p_external_prefix=0, p_local_prefix=0 and p_default_country=44, then 9012345678 will be normalized to +4412345678

Optional
p_international_prefix=00

If a phone number starts with this p_international_prefix, normalization will replace that with a +
Example: if p_international_prefix=00 then 004612345678 will be normalized to +4612345678

Optional

Phone number normalization rules

...

Based on p_default_country=44, p_external_prefix=9 and p_international_prefix=00:

TypeSource numberNormalizedRule
E.164 numbers+<intl_number>+<intl_number>start with + -> no change
local numbers0<local_number>+44<local_number>leading 0 replaced with +44
numbers with international dialing prefix00<intl_number>+<intl_number>leading 00 replaced with +
external dialing of local number90<local_number>+44<local_number>leading 9 and 0 replaced with +
external dialing of international number900<intl_number>+<intl_number>leading 9 and 00 replaced with +
various numbers with extension numberse.g. 0<local_number> (ext 12)+44<local_number>extension number is removed
SIP URIuser@domain.comuser@domain.comNo normalization will run on SIP URIs.

Response

The system opens the web application at the search and list interface displaying the results according to the filters defined in the request.