Find sample payloads for Call Report Webhook and Live Call. For Call Report Webhook, parameters include SourceNumber, DestinationNumber, DialWhomNumber, CallDuration, coins, Status, StartTime, EndTime, CallSid, CallRecordingUrl, Direction, campid, TalkDur

Test & Validate Webhook

Sample Payload

Edit Webhook

API Integration

Use CallerDesk v2 API's  to configure with your in-house app or with any other 3rd party webapp or mobile applications

Current_Version_API Documentation 

Introduction: API Reference

Authentication

What Is Webhook Event

Setup Live Webhook

Delete Webhook

Webhooks Integration

Setup Postman

CallerDesk <> Postman

Test API via Postman

Add Member

Update Member

Delete Member

Get Members List

Team Members

Create Call Group

Update Call Group

Delete Call Group

Call Group List

Get Group details by id

Get Group Time Schedule

Call Group

Call Report API

Live Call API

Call Routing API

Call Logs- Incoming/Outgoing

Click2Call API ( Normal )

C2C API ( Via member_id )

Click2Call API (with CallGroup)

Reverse C2C API ( B Party=Member Number)

Reverse C2C API ( B Party=Deskphone with CallGroup)

Mobile based single C2C API

Click-to-Call API's

Add contact

Update contact

Delete contact

Get Contact List

DO wise Contact list

Contact notes API

Contact API's

Voice call based OTP

Normal Voice call survey

Normal survey with repeat

Bulk Voice Survey

Bulk Voice Broadcast

Bulk Voice Broadcast Report

Outgoing Voice Brodcast API's

Upload Voice prompt

Get Voice prompt list

Voice Prompt API's

Block Number

Unblock Number

Number Blacklist API's

Add Sender id

Get Sender id

Delete Sender id's

Account Sender id's

Dashboard Summary

Activity Trail History

Profile & Balance

IVR Number List

Account Level API's

Member Analysis Report

Member Break Status

Member Break control

Member Analysis

Notification List

Update Notification

Notification Settings

Parameter	Expected Format	Definition
SourceNumber	99xxxxx	Number of the caller
DestinationNumber	0120xxxx	VN on which the call has been triggered
DialWhomNumber	928xxxxx	Agent number on which call has been answered
CallDuration	18	Total call duration from initiation to end
coins	1	Credit deducted for the call ( for example-1)
Status	ANSWER	End result of call like Agent engaged, busy, abandonment, answered, cancel.
StartTime	yyyy-mm-dd hh:mm:ss	Initiation date & time of the call
EndTime	yyyy-mm-dd hh:mm:ss	End time of the call
CallSid	1672649960.960xxxx	Call Unique Id ( for example-1586420216.7173x)
CallRecordingUrl	https://callrecords.callerdesk.io/incoming/01_2023xxxxxx	Call recording URL if answered
Direction	IVR	Type of Call Direction (For instance, if it's an incoming call, the direction will say "IVR," and if it's an outgoing call, the direction will say "WEBOBD" ).
campid	11387004	Unique campaign id ( for example 9995 ). This will show in case of outgoing call report only
TalkDuration	40	Total talk duration if the call was answered
call_group	TestGroup	Call Group Name of the connected call
receiver_name	Ashish	Name of the team member who answered the phone
error_code	19	It will show error code incase of any error
LegA_Picked_time	2023-01-02 14:32:44	LegA join time i.e once LegA user picked the call.
LegB_Start_time	2023-01-02 14:32:45	LegB Initiation time i.e once call initiate to the LegB user.
LegB_Picked_time	2023-01-02 14:32:54	LegB join time i.e once LegA user picked the call.

Parameter	Expected Format	Definition
SourceNumber	99xxxxx	Number of the caller
DestinationNumber	0120xxxx	VN on which the call has been triggered
DialWhomNumber	928xxxxx	Agent number on which call has been answered
Status	ANSWER	End result of call like Agent engaged, busy, abandonment, answered, cancel.
StartTime	yyyy-mm-dd hh:mm:ss	Initiation date & time of the call
CallSid	1672649960.960xxxx	Call Unique Id ( for example-1586420216.7173x)
Direction	IVR	Type of Call Direction (For instance, if it's an incoming call, the direction will say "IVR," and if it's an outgoing call, the direction will say "WEBOBD" ).
call_group	TestGroup	Call Group Name of the connected call

Sample Payload

Call Report Webhook Sample Payload

Live Call Sample Payload