API ומפתחים

Build with the Mihu AI Platform

ממשקי REST API, ערכות פיתוח תוכנה (SDK) ו-Webhooks לשילוב סוכני קול והודעות AI באפליקציות שלכם. הפיצו מהר יותר עם תיעוד מקיף ודוגמאות.

צפה בתיעוד מסוף API
99.9%
זמינות API (Uptime)
<100 מילישניות
תגובה
50+
נקודות קצה (Endpoints)
REST API
1# יזום שיחה יוצאת


--request POST \


3  --url https://demo.mindhunters.ai/api/v1/call \


4  --header 'Authorization: Bearer <token>' \


5  --header 'Content-Type: application/json' \


--data


7    "agentId": "32d8fc98-be1e-4d32-...",


8    "participant": {


9      "number": "+1 (415) 555-0123",


10      "about": "Customer John Doe"


11    }


12  }'
requests


2


url =


headers = {


5    "Authorization": "Bearer <token>",


6    "Content-Type": "application/json"


7}


data = {


9    "agentId": "32d8fc98-be1e-4d32-...",


10    "participant": {"number": "+1 (415) 555-0123"}


11}


12response = requests.post(url, headers=headers, json=data)
1const response = await fetch(


2  'https://demo.mindhunters.ai/api/v1/call',


3  {


4    method: 'POST',


5    headers: {


6      'Authorization': 'Bearer <token>',


7      'Content-Type': 'application/json'


8    },


9    body: JSON.stringify({


10      agentId: '32d8fc98-be1e-4d32-...',


11      participant: { number: '+1 (415) 555-0123' }


12    })


13  }


14);
201 Created
התחלה מהירה

פעיל ומוכן בדקות

Get started with the Mihu AI API in three simple steps.

1

קבל את טוקן ה-API שלך

התחברו ללוח המחוונים וצרו טוקן API פרטי עם תפוגה אופציונלית.

: Bearer
2

הגדר Base URL

כל בקשות ה-API מבוצעות לנקודת הקצה המאובטחת שלנו עם ה-bearer token שלכם.

https://demo.mindhunters.ai/api/v1
3

בצע את השיחה הראשונה שלך

יזום שיחה יוצאת עם הסוכן שלך והתחל באוטומציה של שיחות.

POST /call { agentId, participant }
אימות (AUTHENTICATION)

גישה מאובטחת ל-API

Choose between API keys for server-to-server or OAuth 2.0 for user-delegated access.

מפתחות API

צור מפתחות API לאימות הבקשות שלך. צור טוקנים פרטיים עם תאריכי תפוגה אופציונליים לגישה מאובטחת.

הוסף מפתח API
שם מפתח ה-API
הגדר תאריך תפוגה
ללא תפוגה
••••••••••••••••••••••••••••••••
••••••••••••••••••••••••••••••••

OAuth 2.0

הרשאה בסטנדרט תעשייתי לגישה מואצלת משתמש. מושלם לאינטגרציות מרקטפלייס.

1

הפניה לאישור (Authorization)

שלח משתמשים למסך ההסכמה של Mihu

GET /oauth/authorize?client_id=...
2

קבלת קוד אישור

המשתמש מעניק הרשאה, אתה מקבל קוד

?code=abc123&state=xyz
3

החלפה ב-Access Token

החלף את הקוד ב-Access Token

POST /oauth/token
תיעוד API

תיעוד נקודות קצה מקיף

Explore our RESTful API with detailed request/response examples for every endpoint.

תיעוד API
שיחה
post /call
WhatsApp
post /whatsapp/template
פגישות
GET /appointments
post /appointments
אנשי קשר
GET /contacts
post /contacts
משימות
GET /tasks
post /tasks
קמפיינים
GET /campaigns
לוחות זמנים
GET /schedules
תמלילים
GET /transcriptions
post /api/v1/call

יזום שיחה יוצאת

יוזם שיחה יוצאת באמצעות סוכן AI שצוין. הסוכן יתקשר למספר המשתתף ויפעל לפי הוראות ההנחיה המוגדרות.

פרמטרים של בקשה

פרמטר סוג חובה תיאור
agentId string חובה UUID של סוכן ה-AI לשימוש בשיחה
participant.number string חובה מספר טלפון להתקשרות (פורמט E.164)
participant.about string אופציונלי הקשר לגבי המשתתף עבור ה-AI
prompt.content string אופציונלי הנחיה מותאמת אישית לעקיפת ברירת המחדל של הסוכן
prompt.overwrite boolean אופציונלי האם לעקוף את הנחית ברירת המחדל
message.start string אופציונלי הודעת פתיחה בעת חיבור השיחה

בקשה לדוגמה

POST /api/v1/call
application/json 
{
  "agentId": "32d8fc98-be1e-4d32-a12e-146f397fb1cb",
  "prompt": {
    "overwrite": true,
    "content": "You are Michael from the support team..."
  },
  "participant": {
    "number": "+1 (415) 555-0123",
    "about": "Customer named John Doe. Order #12345."
  },
  "message": {
    "start": "Hello! This is Michael from support."
  }
}

תגובה

200 OK
application/json 
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "callId": "call_abc123def456",
    "status": "initiated"
  }
}
WEBHOOKS

התראות אירועים בזמן אמת

Set up Webhooks to trigger actions on external services in real-time. Stay informed on updates and changes to ensure seamless integration.

תצורת Webhooks
עדכון שיחה
דוח סיום שיחה
סטטוס שיחה
Intent Call
הערכת טקסט
הערכה קולית
תצורת Webhook נוכחית
URL: https://integration.mihu.ai/webhook/422ffbc1-5068-4e83-bbbb-297d53f09ce3
אירועים פעילים: דוח סיום שיחה, הערכת טקסט, הערכה קולית
Payload לדוגמה conversation.end_report 
{
  "event": "conversation.end_report",
  "timestamp": "2024-01-15T14:32:18Z",
  "data": {
    "conversation_id": "conv_abc123def456",
    "agent_id": "32d8fc98-be1e-4d32-a12e-146f397fb1cb",
    "direction": "outbound",
    "participant": {
      "number": "+1 (415) 555-0123",
      "name": "John Doe"
    },
    "duration_seconds": 187,
    "status": "completed",
    "transcript_url": "https://...",
    "recording_url": "https://...",
    "sentiment": "positive",
    "summary": "לקוח שאל לגבי סטטוס הזמנה..."
  }
}

מוכנים להתחיל לבנות?

קבלו את מפתח ה-API שלכם והשיקו את האינטגרציה הראשונה שלכם תוך דקות. המסלול החינמי כולל 1,000 קריאות API בחודש.

קבל מפתח API קרא את התיעוד