Nexiwave Voicemail-to-text Email Gateway service supports live filtering. This feature is a simple HTTP/S based integration method. Nexiwave customers can integrate with this feature to easily control whether a Voicemail-to-text task should be processed by Nexiwave. This check is performed using a pre-shared HTTP/S URL (WebHook).
Currently, a base WebHook URL must be provided to Nexiwave. Nexiwave staff will manually configure this URL into Nexiwave system. A sample WebHook URL can be:
https://api.customer.com/nexiwave/realtime-check?preauth=shared-passwd
Note: The example URL contains a simple pre-shared-passwd security measure. The base WebHook URL, however, can be of any valid HTTP/S URL. It is up to the customer to decide whether to embed some simple security measure in the URL.
When Nexiwave receives an email for the customer, Nexiwave will construct a realtime check URL with these additional parameters:
|
Value |
Type |
Description |
|
fromAddr |
String |
The URL encoded "from" email address |
|
toAddr |
String |
The URL encoded "to" email address |
|
monthlyMsgCountByFrom |
Integer |
Monthly message count used by the "From" address |
|
monthlyMsgCountByTo |
Integer |
Monthly message count used by this "To" address |
An example URL:
https://api.customer.com/nexiwave/realtime-check?preauth=shared-passwd&fromAddr=vm@customer.com&toAddr=john.doe@gmail.com&monthlyMsgCountByFrom=800&monthlyMsgCountByTo=5
Nexiwave expects one of these string values to be returned from the URL:
|
Value |
Description |
|
Process |
The happy path. Nexiwave should go ahead and proceed normally. |
|
RelayOnly |
No voicemail-to-text function should be performed. Nexiwave should just relay the email to its original recipients; |
|
Drop |
Nexiwave should ignore this voicemail message. This voicemail message will be deleted in Nexiwave server. |
For more info, please check the Nexiwave Live Filtering API document.
|
