Phone API docs

openchatai · Aug 29, 2024 · bd59fbe · bd59fbe
1 parent f4d2036
commit bd59fbe
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 97 deletions.
diff --git a/docs/api-reference/phone/buy.mdx b/docs/api-reference/phone/buy.mdx
@@ -1,21 +1,3 @@
 ---
-title: 'Buy AI phone number'
-api: 'POST https://api-v2.opencopilot.so/backend/voice-channel/phone-number/buy'
-authMethod: 'bearer'
-description: 'This endpoint allows you to purchase a new phone number for your organization, enabling AI-driven communication. The phone number can be used to automatically answer calls, handle customer complaints, and respond to questions efficiently, leveraging AI to enhance customer support and streamline interactions.'
+openapi: post /phone/buy
 ---
-
-<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>
diff --git a/docs/api-reference/phone/delete.mdx b/docs/api-reference/phone/delete.mdx
@@ -1,11 +1,3 @@
 ---
-title: 'Delete phone number'
-api: 'DELETE https://api-v2.opencopilot.so/backend/voice-channel/phone-number/:phone_number_id'
-authMethod: 'bearer'
-description: 'This endpoint allows you to delete a phone number from your organization'
+openapi: delete /phone/{phone_number_id}
 ---
-
-<ParamField path="phone_number_id" type="string" required>
-  The unique identifier for the phone number you would like to delete from your
-  organization
-</ParamField>
diff --git a/docs/api-reference/phone/get-all-phones.mdx b/docs/api-reference/phone/get-all-phones.mdx
@@ -1,38 +1,3 @@
 ---
-title: 'Get all phone numbers'
-api: 'GET https://api-v2.opencopilot.so/backend/voice-channel/phone-numbers/:organization_id'
-authMethod: 'bearer'
-description: 'This endpoint allows you to list all the phone number of your organization.'
+openapi: get /phone
 ---
-
-<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>
-
-<ResponseExample>
-```json Response
-[
-{
-    "id": "123e4567-e89b-12d3-a456-426614174000",
-        "organization_id": "15ca3add-0b6c-4fca-9829-b13bc8a39bba",
-        "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-12T22:02:40.000Z"
-},
-{    "id": "568e0f1d-f81f-4b31-a8dc-3c19be8a4654",
-        "organization_id": "b492c760-f0c4-43a7-8027-fa6c181f3369",
-        "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>
diff --git a/docs/api-reference/phone/update.mdx b/docs/api-reference/phone/update.mdx
@@ -1,35 +1,3 @@
 ---
-title: 'Update phone number'
-api: 'PUT https://api-v2.opencopilot.so/backend/voice-channel/phone-number/:phone_number_id'
-authMethod: 'bearer'
-description: 'This endpoint allows you to update a phone number from your organization'
+openapi: patch /phone/{phone_number_id}
 ---
-
-<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>