Adds a custom string to a named field in the call log file, that can be used to filter or identify certain calls. This value persists until changed or the call ends.
Function
- LV_TTS_RETURN_CODE LV_TTS_AddFieldToRequest(HTTSCLIENT client_handle, const char * key_name, const char * string_value);
Parameters
client_handle
Handle to the TTS client object.
key_name
Name of the field which is to be added to the call log file.
string_value
String value to be assigned to the new field in the call log file.
Return Values
LV_SUCCESS
No errors; adding the field succeeded.
LV_INVALID_TTS_HANDLE
The input TTS client handle is not a valid one.
LV_INVALID_API_PARAMETER
Either the input key_name or string_value or both are not valid.
LV_EXCEPTION
An exception occurred while processing the request.