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.
Implementation
PIOPIY webhooks implementation in different languages.
- Python
- Node.js
- PHP
- Java
from flask import Flask,requestapp = 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 Platformcdr = 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 live event, where the PIOPIY platform will notify your web server POST method URL.
- Leg A
- Leg B
{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.
Properties
These are the list of properties and its description
Property | Type | Description |
---|---|---|
to | number | The number the call was made to |
app_id | number | Your app id |
time | number | Timestamp of this call |
start_time | number | The start time of this call |
end_time | number | The end time of this call |
from | number | Your default DID Number |
direction | string | Direction of this call |
duration | number | The total duration of this call in seconds |
extra_params | string | Your custom parameters |
cmiuuid | string | A unique identifier of this call |
call_rate | string | The billed call rate for this call |
balance | string | The total available account balance after this call |
conversation_uuid | string | A unique identifier of this conversation |
request_id | string | The unique request ID for this call |
callerid | number | The incoming DID number |
out | string | This call is initiated from API |
api_init | string | This call is initiated from API |
status | string | Status of this call |
leg | string | Define the leg of the call either a or b |
type | string | Type of notification from PIOPIY platform it may be cdr or event |