Outgoing Hangup
Our TeleCMI platform will notify the following sample JSON live event to your web server POST method URL, when an incoming call hit on your user mobile/landline number and got hangup.
Implementation
TeleCMI webhooks implementation in different languages.
- Python
- Node.js
- PHP
- Java
from flask import Flask,request
app = Flask(__name__)
# Receive webhooks from TeleCMI platform when call receive or make
@app.route("/webhook/cdr",methods=['POST'])
def hello():
# Received JSON CDR from TeleCMI Platform
cdr = request.get_json()
print(cdr)
return "got it"
if __name__ == "__main__":
app.run(debug=True, port=5000)
const express = require('express'),
bodyParser = require('body-parser'),
app = express();
// parse application/json
app.use(bodyParser.json());
app.post('/webhook/cdr',(req,res)=>{
//Received CDR JSON Object from TeleCMI platform
var cdr = req.body;
console.log(cdr);
res.send('got it');
})
app.listen(5000);
app.run(debug=True, port=5000)
<?php
use \Psr\Http\Message\ServerRequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;
require 'vendor/autoload.php';
$app = new \Slim\App;
$handler = function (Request $req, Response $res) {
$cdr = $req->getParsedBody();
error_log(print_r($cdr, true));
return $res->withStatus(204);
};
$app->post('/webhook/cdr', $handler);
$app->run();
/*
* This Java source file was generated by the Gradle 'init' task.
*/
package telecmi_example_java;
import static spark.Spark.*;
import com.cedarsoftware.util.io.JsonWriter;
public class App {
public static void main(String[] args) {
port(5000);
post("/webhook/cdr", (req, res) -> {
System.out.println("You got CDR from TeleCMI Platform");
String cmiJSON = JsonWriter.formatJson(req.body());
System.out.println(cmiJSON);
res.status(204);
return "";
});
}
}
To know more about testing webhooks for local development purposes, go to examples.
Sample event response
This is the sample JSON live event, where the TeleCMI platform will notify your web server POST method URL.
{
"type": "event",
"team": "Enquiry_1111113",
"user": "109_1111113",
"conversation_uuid": "7bf5fbab-5a1a-4cde-a0b6-aba843131950",
"cmiuuid": "93fa1889-61a5-4d03-b12d-d78ede2cf1ee",
"direction": "outbound",
"from": 9100000000,
"app_id": 1111113,
"time": 1571122016617,
"status": "hangup"
}
The above sample JSON live event consists of several properties. Each property has a description and take a look at it.
Properties
These are the list of properties and its description
Property | Type | Description |
---|---|---|
type | string | Type of notification from TeleCMI platform it may be cdr or event |
team | string | Name of the team where the call was waited |
user | string | A unique Id of the user(agent) |
conversation_uuid | string | A unique identifier of this overall conversation |
cmiuuid | string | A unique identifier of this call |
direction | string | The direction of this call it may be inbound or outbound |
from | number | The number the call came from |
app_id | number | Your app id |
time | number | Timestamp of this call |
status | string | Status of this call |