MetadataAdd

Owned by Kiss, Mate
May 24, 2022
1 min read


Description

Adds metadata to the ongoing call at current time in call.

Syntaxhttp://<host>:<apiport>/MetadataAdd
Parameters

pass = API passcode (optional)

field = field of custom metadata template

value = value of the field

Example

http://localhost:10100/dev/MetadataAdd?field=customerId&value=894562

(above call will insert metadata "customerId" with value "894562" to the current recording session)

Return value

Positive result:

  • 'OK'
    • only two letters are returned

Failure result:

  • 'ERROR:<code>:<description>'
    • the first 5 characters of the response are 'ERROR'
    • followed by a ':' (colon)
    • <code> is a 4 character error code
    • followed by a ':' (colon)
    • <description> textual description of the error

Defined error codes:

  • 'NOON' - no ongoing call found
  • 'LONG' - parameter too long
  • 'AUTH' - request authentication error