-
Notifications
You must be signed in to change notification settings - Fork 399
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
576895a
commit efa4916
Showing
9 changed files
with
219 additions
and
4 deletions.
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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: 'Buy AI phone number' | ||
api: 'POST https://api-v2.opencopilot.so/backend/voice-channel/phone-number/buy' | ||
description: 'This endpoint allows you to buy a new phone number for a specific organization. The phone number can be used for various telecommunication purposes within the organization.' | ||
--- | ||
|
||
<Warning> | ||
This endpoint is protected by the same JWT that the user uses to call other | ||
APIs. The response will include data for the specified chatbot, along with | ||
other metadata information. | ||
</Warning> | ||
|
||
<ParamField body="organization_id" type="string" required> | ||
The unique identifier for the copilot (organization) you want to create an AI | ||
phone for. This is a required parameter. | ||
</ParamField> | ||
|
||
<ParamField body="area_code" type="string" required> | ||
The area code for the phone number you want to buy. This is a required | ||
parameter. | ||
</ParamField> | ||
|
||
<ParamField body="name" type="string"> | ||
The name to associate with the purchased phone number. If not provided, a | ||
default name will be used. | ||
</ParamField> | ||
|
||
<RequestExample> | ||
```bash | ||
curl --location --request POST 'https://api-v2.opencopilot.so/backend/phone-number/buy' \ | ||
--header 'Authorization: Bearer TOKEN' \ | ||
--header 'Content-Type: application/json' \ | ||
--data-raw '{ | ||
"area_code": "123", | ||
"organization_id": "org_456", | ||
"name": "My AI phone agent that compliments customers" | ||
}' | ||
``` | ||
</RequestExample> | ||
|
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 |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
title: 'Delete phone number' | ||
api: 'DELETE https://api-v2.opencopilot.so/backend/voice-channel/phone-number/:phone_number_id' | ||
description: 'This endpoint allows you to delete a phone number from your organization' | ||
--- | ||
|
||
<Warning> | ||
This endpoint is protected by the same JWT that the user uses to call other | ||
APIs. The response will include data for the specified chatbot, along with | ||
other metadata information. | ||
</Warning> | ||
|
||
<ParamField path="phone_number_id" type="string" required> | ||
The unique identifier for the phone number you would like to delete from your organization | ||
</ParamField> | ||
|
||
|
||
|
||
<RequestExample> | ||
```bash | ||
curl --location --request DELETE 'https://api-v2.opencopilot.so/backend/phone-number/:phone_number_id' \ | ||
--header 'Authorization: Bearer TOKEN' \ | ||
``` | ||
</RequestExample> | ||
|
||
<ResponseExample> | ||
```json Response | ||
[ | ||
{ | ||
"id": "1112234", | ||
"organization_id": "999888123", | ||
"provider_id": "091274", | ||
"phone_number": "+14155690123", | ||
"name": "My AI phone agent that calms down customers", | ||
"base_prompt": "You are phone voice assistant. Always provice a short, to the point, and clear response. Do not engage in conversation with the user. Always ask the user to configure their account on Open CoPilot.", | ||
"initial_message": "Hello, this phone is being managed by Open, how can I help you today?", | ||
"handoff_phone_number": "+15103435446", | ||
"created_at": "2024-08-24T12:01:59.000Z" | ||
}, | ||
{ "id": "123987", | ||
"organization_id": "999888123", | ||
"provider_id": "091274", | ||
"phone_number": "+14155690907", | ||
"name": "My AI phone agent that compliments customers", | ||
"base_prompt": "You are phone voice assistant. Always provice a short, to the point, and clear response. Do not engage in conversation with the user. Always ask the user to configure their account on Open CoPilot.", | ||
"initial_message": "Hello, this phone is being managed by Open, how can I help you today?", | ||
"handoff_phone_number": "+15103435446", | ||
"created_at": "2024-08-24T12:01:59.000Z"} | ||
] | ||
``` | ||
</ResponseExample> |
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 |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: 'Get all phone numbers' | ||
api: 'GET https://api-v2.opencopilot.so/backend/voice-channel/phone-numbers/:organization_id' | ||
description: 'This endpoint allows you to list all the phone number of your organization.' | ||
--- | ||
|
||
<Warning> | ||
This endpoint is protected by the same JWT that the user uses to call other | ||
APIs. The response will include data for the specified chatbot, along with | ||
other metadata information. | ||
</Warning> | ||
|
||
<ParamField path="organization_id" type="string" required> | ||
The unique identifier for the copilot (organization) you want to create an AI | ||
phone for. This is a required parameter. | ||
</ParamField> | ||
|
||
|
||
|
||
<RequestExample> | ||
```bash | ||
curl --location 'https://api-v2.opencopilot.so/backend/phone-number/buy' \ | ||
--header 'Authorization: Bearer TOKEN' \ | ||
``` | ||
</RequestExample> | ||
|
||
<ResponseExample> | ||
```json Response | ||
[ | ||
{ | ||
"id": "1112234", | ||
"organization_id": "999888123", | ||
"provider_id": "091274", | ||
"phone_number": "+14155690123", | ||
"name": "My AI phone agent that calms down customers", | ||
"base_prompt": "You are phone voice assistant. Always provice a short, to the point, and clear response. Do not engage in conversation with the user. Always ask the user to configure their account on Open CoPilot.", | ||
"initial_message": "Hello, this phone is being managed by Open, how can I help you today?", | ||
"handoff_phone_number": "+15103435446", | ||
"created_at": "2024-08-24T12:01:59.000Z" | ||
}, | ||
{ "id": "123987", | ||
"organization_id": "999888123", | ||
"provider_id": "091274", | ||
"phone_number": "+14155690907", | ||
"name": "My AI phone agent that compliments customers", | ||
"base_prompt": "You are phone voice assistant. Always provice a short, to the point, and clear response. Do not engage in conversation with the user. Always ask the user to configure their account on Open CoPilot.", | ||
"initial_message": "Hello, this phone is being managed by Open, how can I help you today?", | ||
"handoff_phone_number": "+15103435446", | ||
"created_at": "2024-08-24T12:01:59.000Z"} | ||
] | ||
``` | ||
</ResponseExample> |
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 |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: 'Update phone number' | ||
api: 'PUT https://api-v2.opencopilot.so/backend/voice-channel/phone-number/:phone_number_id' | ||
description: 'This endpoint allows you to update a phone number from your organization' | ||
--- | ||
|
||
<Warning> | ||
This endpoint is protected by the same JWT that the user uses to call other | ||
APIs. The response will include data for the specified chatbot, along with | ||
other metadata information. | ||
</Warning> | ||
|
||
<ParamField path="phone_number_id" type="string" required> | ||
The unique identifier for the phone number you would like to update from your | ||
organization | ||
</ParamField> | ||
{/* body */} | ||
<ParamField body="name" type="string"> | ||
The name that identifies your AI phone | ||
</ParamField> | ||
|
||
<ParamField body="base_prompt" type="string"> | ||
The base prompt guides the AI's responses when interacting with customers. It | ||
serves as the foundational instruction set for the AI phone, defining how it | ||
should initiate conversations, handle customer inquiries, and respond to | ||
various scenarios. This prompt helps ensure that the AI provides consistent | ||
and relevant responses tailored to the specific needs of the organization and | ||
its customers. | ||
</ParamField> | ||
|
||
<ParamField body="handoff_phone_number" type="string"> | ||
The handoff phone number is the phone number that the AI agent uses to handoff | ||
the conversation with the customer if the customer asks to talk to a human, or | ||
the AI phone agent cannot answer on of the customer's questions | ||
</ParamField> | ||
|
||
<ParamField body="initial_message" type="string"> | ||
The initial message is the first thing that the AI phone agent says when | ||
answering the phone call. | ||
</ParamField> | ||
|
||
<RequestExample> | ||
```bash | ||
curl --location --request PUT 'https://api-v2.opencopilot.so/backend/phone-number/:phone_number_id' \ | ||
--header 'Authorization: Bearer TOKEN' \ | ||
--header 'Content-Type: application/json' \ | ||
--data-raw '{ | ||
"name": "My cool phone", | ||
"base_prompt": "You are an AI phone agent that compliments customers whenever you find a chance", | ||
"handoff_phone_number": "+1XXXXXXXXX", | ||
"initial_message": "Hello! How can I help you today?" | ||
}' | ||
``` | ||
</RequestExample> |
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
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
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: "AI Phone Agent" | ||
icon: "headset" | ||
--- | ||
|
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: "Human Agent" | ||
icon: "user-headset" | ||
--- | ||
|
File renamed without changes.