Inbound Answered

To receive the inbound 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 answered.

Implementation

PIOPIY webhooks implementation in different languages.

from flask import Flask,request
app = Flask(__name__)
# Receive webhooks from PIOPIY platform when call receive or make
@app.route("/webhook/cdr",methods=['POST'])
def hello():
# Received JSON CDR from PIOPIY Platform
cdr = request.get_json()
print(cdr)
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 call detail record(CDR), where the PIOPIY platform will notify your web server POST method URL.

{
to: 440000000000,
appid: 2222222,
time: 1632318511000,
start_time: 1632318510,
end_time: 1632318528,
from: 440000000001,
direction: 'inbound',
duration: 13,
extra_params: "{ 'Name': 'Akil', 'ID':8915726 }",
cmiuuid: '55348d77-c515-425d-b22c-f0c6ecd8d780',
call_rate: '0.450000',
balance: '878.900000',
conversation_uuid: 'c62abd10-1bab-11ec-8e24-ddb7c33510ad',
answer_time: 1632318515,
leg: 'a',
status: 'answered',
type: 'cdr'
}

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

PropertyTypeDescription
tonumberYour incoming DID number
app_idnumberYour app id
timenumberTimestamp of this call
start_timenumberThe start time of this call
end_timenumberThe end time of this call
fromnumberThe number who made a call
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
answer_timenumberThe answer time of this call
calleridnumberThe incoming DID number
legstringDefine the leg of the call either a or b
statusstringStatus of this call
typestringType of notification from PIOPIY platform it may be cdr or event