|
Anveo Remote Event Notifications
|
|
|
|
Keep your custom billing in sync with Anveo using Remote Event Notification.
|
|
Overview
|
Remote Event Notification is Anveo's messaging service which sends a notification when a call related transaction/event occures. Remote Event Notification can be used for things like call billing automation, sms delivery report notification etc.
Remote Event Notification notifies you about various events which include Call Detail Information and any fees related to the call plus additional information which can help you identify the record.
For example when a call was originated using Anveo API; Remote Event Notification message will include API RESPONSEID and Billing Code from the original API request. In case when a call was originated from Click2Call/ContactMe button the information will include the ID of Click2Call button etc.
You can receive and process Remote Event Notification messages with a script or a programm available as URL on your web server.
|
|
|
Simple HTTP based notification
|
Anveo is using HTTP POST method to sumit Remote Event Notification messages to your server. The message consists of a number of form fields which can be easily retrieved using commom menthods.
Remote Event Notification is designed to be reliable and asynchronous. It means that event messages are sent asynchronous of the event and Anveo tries to redeliver messages if your server is not responding or when your server generats an error while processing the message. Anveo tries to deliver a message up to 5 times with 5 minutes delay. If after 5th attempt your server is still not responding the notification message is canceled.
|
|
|
Remote Event Notification message fields
|
Remote Event Notification message consists of the following set of field groups:
- General Event Notification fields (always present)
- Notification Type Specific fields (if any)
- Source Specific Fields (if any)
- Anveo Internal Fields (always present)
|
|
|
|
General Event Notification Message Fields
|
notification_type - the type of notification. See below for the list of possible values.
source - indicates the source which triggered a given event notification. The possible values are SMS, API, CLICK2CALL, WEBCALL, DID, CALLCAMPAIGN, CALLCONFERENCE, WEB.RECORDMESSAGE, FAXOUT, COMMUNICATOR, SIP and OTHER
source_action - inidicates the reason why even was triggered. Possible values are CALL, TRANSFER and OTHER.
amount - In some cases the amount associated with a gven event message is also included which provides information about the amount deducted from your account for a trasaction associated with given event.
|
|
|
Notification Type Specific Fields
|
|
|
phone_number - phone number called in the following format COUNTRY CODE + AREA CODE + PHONE NUMBER. For example 12157010680 is US phone number.
call_duration - billable call duration in seconds.
|
|
|
|
|
NOTIFICATION.SMS.DELIVERY
|
|
|
|
|
Source Specific Fields
|
|
|
api_requestid - Original API RequestID (API RequestID is returned by Anveo.com when API Request was initiated).
billing_code - Billing code used in the API Request.
|
|
|
|
|
click2call_id - id of the click2call button which originated the call
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
anveo_phone_number - Anveo phone number
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Internal Fields
|
x_notification_ref - reserved for Anveo internal use.
x_transaction_ref - reserved for Anveo internal use
x_extra - reserved for Anveo internal use.
The values from Internal Fields are required when contacting Anveo Support regarding any notification.
|
|
|
Remote Event Notification types
|
- NOTIFICATION.CDR.CALL -
- NOTIFICATION.FEE.CALL.RECORDING -
- NOTIFICATION.FEE.CALLFLOW.PRO -
- NOTIFICATION.FEE.API.REQUEST -
- NOTIFICATION.FEE.CALLERID -
|
|
