Webhook event call

1. Set up Webhook

Partners need to provide Alohub with the following information:

How to register: Contact the Alohub technical team , provide the webhook receiving URL and authentication key. Alohub will configure to send events to your URL.

2. Sample Payload

Each time a call ends, Alohub sends a POST request with the following JSON body:

{
  "call_id": "20240113150030xxxxxx",
  "call_status": "answered",
  "direction": "outbound",
  "caller_number": "03899xxx",
  "destination_number": "888",
  "starttime": "2024-01-13 15:00:30",
  "answertime": "2024-01-13 15:00:35",
  "endtime": "2024-01-13 15:05:30",
  "hangup_by": "customer",
  "hotline": "",
  "total_duration": "300",
  "holding_duration": "0",
  "recording_url": "https://domain:port/IPCCMedia/MP3Export.do?url=file.mp3&source=ipcc",
  "objectId": 1,
  "transactionID": "TRANSID_1111",
  "userName": "adminxxx",
  "eventType": "call"
}

3. Details of data fields

4. Call status codes

Value call_statusin the webhook payload:

5. Handling Webhook on the partner side

Quick response: The endpoint receiving the webhook should return HTTP 200within 5 seconds . If timeout or error, Alohub will retry up to 3 times with increasing intervals.

Sample code for handling webhook

const express = require('express')
const app = express()
app.use(express.json())

app.post('/api/alohub/webhook', (req, res) => {
  const { call_id, call_status, caller_number, direction, recording_url } = req.body

  console.log(`Cuộc gọi ${call_id}: ${call_status}`)
  console.log(`Hướng: ${direction}, SĐT: ${caller_number}`)

  if (recording_url) {
    console.log(`Ghi âm: ${recording_url}`)
  }

  // Xử lý logic nghiệp vụ tại đây
  // VD: cập nhật CRM, gửi notification, lưu DB...

  // Quan trọng: respond 200 ngay lập tức
  res.status(200).json({ received: true })
})

app.listen(3000)

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/api/alohub/webhook', methods=['POST'])
def webhook():
    data = request.json

    call_id = data.get('call_id')
    call_status = data.get('call_status')
    caller_number = data.get('caller_number')
    recording_url = data.get('recording_url')

    print(f"Cuộc gọi {call_id}: {call_status}, SĐT: {caller_number}")

    if recording_url:
        print(f"Ghi âm: {recording_url}")

    # Xử lý logic nghiệp vụ tại đây

    return jsonify({"received": True}), 200

if __name__ == '__main__':
    app.run(port=3000)

6. Important notes

Idempotency: It is possible to receive the same event multiple times (due to retry). Use call_idas a key to check for duplicates before processing.

Security: Verify the header Authorizationin the webhook request matches the key you provided to Alohub. Reject invalid requests.

Best practice: Receive webhook → respond 200 immediately → push to queue (Redis, RabbitMQ...) → process async. Avoid heavy processing in the webhook handler.