Skip to content

GEOLOC_PROFILE()

Synopsis

Get or Set a field in a geolocation profile

Description

When used to set a parameter on a profile, if the profile doesn't already exist, a new one will be created automatically.

The '${GEOLOCPROFILESTATUS}' channel variable will be set with a return code indicating the result of the operation. Possible values are:

  • 0 - Success
  • -1 - No or not enough parameters were supplied
  • -2 - There was an internal error finding or creating a profile
  • -3 - There was an issue specific to the parameter specified (value not valid or parameter name not found, etc.)

Syntax

GEOLOC_PROFILE(parameter[,options])
Arguments
  • parameter - The profile parameter to operate on. The following fields from the Location and Profile objects are supported.
    • id
    • location_reference
    • method
    • allow_routing_use
    • profile_precedence
    • format
    • pidf_element
    • location_source
    • notes
    • location_info
    • location_info_refinement
    • location_variables
    • effective_location
    • usage_rules
    • confidence Additionally, the 'inheritable' field may be set to 'true' or 'false' to control whether the profile will be passed to the outgoing channel.

  • options

    • a - Append provided value to the specified parameter instead of replacing the existing value. This only applies to variable list parameters like 'location_info_refinement'.

    • r - Before reading or after writing the specified parameter, re-resolve the 'effective_location' and 'usage_rules' parameters using the 'location_variables' parameter and the variables set on the channel in effect at the time this function is called.

Generated Version

This documentation was generated from Asterisk branch 20 using version GIT