This repository has been archived by the owner on Jan 5, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 402
add webhook docs #818
Open
OmarMelouk
wants to merge
6
commits into
main
Choose a base branch
from
omar/phone-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
add webhook docs #818
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5d00f27
add webhook docs
OmarMelouk 0991ff0
Merge branch 'main' into omar/phone-docs
OmarMelouk 673daab
change json to typescript
OmarMelouk 4a8af30
Merge branch 'omar/phone-docs' of https://github.com/openchatai/copil…
OmarMelouk 1b057fb
remove phone from api docs
OmarMelouk ef380b6
zapier integration
OmarMelouk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -143,4 +143,104 @@ When a third-party software agent responds to a previously handed-off conversati | |
} | ||
``` | ||
</Accordion> | ||
----- | ||
|
||
`phone.incoming_call_started` | ||
|
||
This event is triggered when an incoming call is initiated, providing details about the call’s origin, state, and participants. | ||
|
||
<Accordion title="Sample Payload"> | ||
```json | ||
{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please format all events and make sure there are no syntax errors |
||
event: "phone.incoming_call_started"; | ||
organization_id: string; | ||
data: { | ||
type: 'AI' | 'human_agent'; | ||
id: string; | ||
direction: 'Incoming'; | ||
call_state: string; | ||
call_timestamp: Date; | ||
duration: number | null; | ||
caller: { name: string | null; number: string }; | ||
called: { name: string | null; number: string }; | ||
}; | ||
} | ||
``` | ||
</Accordion> | ||
|
||
--- | ||
|
||
`phone.outgoing_call_started` | ||
|
||
This event is triggered when an outgoing call is initiated, providing details about the call’s origin, state, and participants. | ||
|
||
<Accordion title="Sample Payload"> | ||
```json | ||
{ | ||
event: "phone.outgoing_call_started"; | ||
organization_id: string; | ||
data: { | ||
type: 'human_agent'; | ||
id: string; | ||
direction: 'Outgoing'; | ||
call_state: string; | ||
call_timestamp: Date; | ||
duration: number | null; | ||
caller: { name: string | null; number: string }; | ||
called: { name: string | null; number: string }; | ||
}; | ||
} | ||
``` | ||
</Accordion> | ||
|
||
------ | ||
|
||
--- | ||
|
||
`phone.incoming_call_ended` | ||
|
||
This event is triggered when an incoming call ends, providing details about the call’s origin, state, and participants. | ||
|
||
<Accordion title="Sample Payload"> | ||
```json | ||
{ | ||
event: "phone.incoming_call_ended"; | ||
organization_id: string; | ||
data: { | ||
type: 'AI' | 'human_agent'; | ||
id: string; | ||
direction: 'Incoming'; | ||
call_state: string; | ||
call_timestamp: Date; | ||
duration: number | null; | ||
caller: { name: string | null; number: string }; | ||
called: { name: string | null; number: string }; | ||
}; | ||
} | ||
``` | ||
</Accordion> | ||
|
||
--- | ||
|
||
`phone.outgoing_call_ended` | ||
|
||
This event is triggered when an outgoing call ends, providing details about the call’s origin, state, and participants. | ||
|
||
<Accordion title="Sample Payload"> | ||
```json | ||
{ | ||
event: "phone.outgoing_call_ended"; | ||
organization_id: string; | ||
data: { | ||
type: 'human_agent'; | ||
id: string; | ||
direction: 'Outgoing'; | ||
call_state: string; | ||
call_timestamp: Date; | ||
duration: number | null; | ||
caller: { name: string | null; number: string }; | ||
called: { name: string | null; number: string }; | ||
}; | ||
} | ||
``` | ||
</Accordion> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be ```typescript