Webhooks Integration

Sample Payload

3min

Call Report Webhook Sample Payload
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.
Live Call Sample Payload
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
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿

Updated 17 Apr 2023

Did this page help you?

Test & Validate Webhook

Edit Webhook

Docs powered by

Archbee

TABLE OF CONTENTS

Call Report Webhook Sample Payload

Live Call Sample Payload

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.