Non-Speech Meta Insertion API
The non-speech metadata insertion provides the below functionalities:
Update existing Non-Speech Metadata value
Non-speech metadata is inserted during the call process or by invoking this API. The API sends a request to update existing non-speech metadata values.
Add new Non-Speech Metadata value
Non-speech metadata is inserted during the call process or by invoking this API. The API sends a request to add additional non-speech metadata.
The key aspects of this API are as follows:
It works only for the already processed contact(s)
It is applicable for contacts across all channels (Chat, Email and Voice)
The tenantName, orgName, and catName that is used for invoking the API must be valid for contactId
It validates the non-speech metadata count of 50 per category and fails if the count exceeds
It supports new insertions and updates. This means that you may insert new key-value pair or update the value of already inserted key
It does not support deletion.
Request
Method: POST
URL: https://<host>/contacts/nsmeta/insertion
Attributes
Name | Description | Data Type | Length | Mandatory/ Optional |
|---|---|---|---|---|
| Name of the Client | String | 128 | Mandatory |
| Name of the Organization | String | 128 | Mandatory |
| Name of Category Name | String | 128 | Mandatory |
| Non speech data of audio file | JSON Object | Mandatory. A maximum of 50 non-Speech metadata keys per category. Refer Restricted Metadata Field List. | |
| callId for a voice, convId for email/chat | String | 256 | Mandatory |