Versions Compared

Key

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

...

ParameterDescription
catSignal category. For audio masking, this value is always 0x04
typeThe type of signal. Valid values for 0x04-categorysignals are:
  • 0x01 Mute On
  • 0x02 Mute Off
objtypeThe type of object that this signal relates to. This can be one of two values:
  • user (a user object)
  • channel (a channel object)
objidThe unique ID of the object type as specified by the objtypeparameter (above). This is used to locate the object in the Directory

The region of the Directory to search in is specified by the key parameter (below) and governed by the access implied by the placement of the web user whose credentials are used to effect the web requestThe region of the Directory where the search should be performed is specified by the

key parameter (below) and it is governed by the directory access of the web user whose credentials are used to effect the web requestkeySpecifies the key relating to a container object in the directory (or blank, implying the whole directory) whereby a search on the object specified by objtype and objid is performed below

...

ParameterDescription
200The signal was received and stored successfully
400The request was not acceptable / accepted for one of the following reasons:
  • An invalid type parameter was specified. The type parameter is specific to the category specified by the cat parameter. Further, the type value (e.g. 0x01) can be used in multiple categories
  • The objid was missing. Specify the ID of the object you want the signal to relate to
  • The cat and type parameters - category and signal type, respectively - must be specified and cannot be zero
  • The version of TIM Enterprise you are running does not understand the signal.js script
404The object specified by the combination of the objtype and objid parameters - and optionally the key parameter - could not be found
500
Referencemacro
LabelInternal Server Error
prevented the signal from being stored successfully. This may be due to a badly-configured database, or the lack of a 
Referencemacro
Labelsignals
table in the TIM Enterprise database

...