Async Metadata API

Required: You must have a valid authenticated Api User with the AsyncMetaData role.Tip: To request a bearer token, reference the Token authentication APIarticle.

---

Async Metadata API

Some customers need to add additional metadata along with their call provider’s call metadata to Creovai calls and call groups from an analytics standpoint. For example, a Creovai customer may want to include additional CRM metadata in Creovai App (per call) to match up with call group metadata fields (existing in Creovai) and update all associated calls with new call group metadata.

URL

https://[INSTANCE NAME]/callevent/v1/outofband/event

Request

Attribute	Type	Description
sessionID (optional)	string	The session ID that uniquely identifies a call NOTE: If no sessionID is sent, then contact Creovai support to configure Async Metadata Matching.
eventTime	date	The date and time of the async metadata event
metadata	Json object	Your custom metadata

 

Response Codes

Code	Message	Description
200	OK	Request was successful
400	Bad Request	Request content is invalid
500	Internal Server Error	An internal server error occurred

Example

{
    "SessionId":"abc123",
    "EventTime":"2018/10/15T09:00:00.000Z",
    "Metadata":{
        "my_xpath":"my_xpath_value",
        "event_data_xpath":"2018/10/15T09:00:00.000Z",
        "customerDataField1":"someData",
        "customerProvidedData":"customerData"
    }
}

The "metaData" object can hold any standard Json object.

All data will be stored with the call data and can be made accessible in the UI, Reports, or external data feeds to other systems. An example data object that could be placed here would be an external Customer ID from a CRM platform that was located because of data the customer gave to an IVR, or by the Agent and passed along in the SipRec headers.

Note: The metadata in the example above does not represent any standard or schema that must be used.

Response

200 OK