Outbound Webhooks Missed

To receive the outbound missed webhooks, you must complete the webhooks setup. After completing the webhooks setup, our PIOPIY platform will notify your web server POST method URL with JSON call detail record(CDR) when an incoming call missed.


PIOPIY webhooks implementation in different languages.

from flask import Flask,request
app = Flask(__name__)
# Receive webhooks from PIOPIY platform when call receive or make
def hello():
# Received JSON CDR from PIOPIY Platform
cdr = request.get_json()
return "got it"
if __name__ == "__main__":
app.run(debug=True, port=5000)

To know more about testing webhooks for local development purposes, go to examples.

Sample CDR response

This is the sample JSON live event, where the PIOPIY platform will notify your web server POST method URL.

to: 440000000000,
appid: 2222222,
time: 1632307235000,
start_time: 1632307238,
end_time: 1632307265,
from: 19170000000,
direction: 'outbound',
duration: 0,
extra_params: '{"key":"value"}',
cmiuuid: '1edceb4c-4e2c-402d-81b4-1c2f6fca442d',
call_rate: 0,
balance: '76.349024',
conversation_uuid: 'S9U4Mo29GHBfCJ2uHczcY75QQDri7HcAxXYZuktJLxf',
request_id: 'S9U4Mo29GHBfCJ2uHczcY75QQDri7HcAxXYZuktJLxf',
callerid: 19170000000,
out: true,
api_init: true,
status: 'missed',
leg: 'a',
type: 'cdr'

The above sample JSON live event consists of several properties. Each property has a description and take a look at it.


These are the list of properties and its description

tonumberThe number the call was made to
app_idnumberYour app id
timenumberTimestamp of this call
start_timenumberThe start time of this call
end_timenumberThe end time of this call
fromnumberYour default DID Number
directionstringDirection of this call
durationnumberThe total duration of this call in seconds
extra_paramsstringYour custom parameters
cmiuuidstringA unique identifier of this call
call_ratestringThe billed call rate for this call
balancestringThe total available account balance after this call
conversation_uuidstringA unique identifier of this conversation
request_idstringThe unique request ID for this call
calleridnumberThe incoming DID number
outstringThis call is initiated from API
api_initstringThis call is initiated from API
statusstringStatus of this call
legstringDefine the leg of the call either a or b
typestringType of notification from PIOPIY platform it may be cdr or event