Open in
फंक्शन टूल्स
तुमच्या AI एजंटना संभाषणादरम्यान बाह्य API कॉल करणारी फंक्शन टूल्स द्या — ग्राहक डेटा मिळवा, अपॉइंटमेंट बुक करा, नोंदी अपडेट करा — टाइप केलेल्या पॅरामीटर्ससह.
फंक्शन टूल्स तुमच्या AI एजंटना फोन कॉलदरम्यान बाह्य API वापरण्याची परवानगी देतात. ग्राहक डेटा शोधण्यासाठी, उपलब्धता तपासण्यासाठी, भेटी बुक करण्यासाठी किंवा तुमचे बॅकएंड समर्थित असलेली कोणतीही कृती करण्यासाठी त्यांचा वापर करा.
हे कसे कार्य करते
- तुम्ही स्कीमासह टूल्स परिभाषित करता (टूल कोणते आर्ग्युमेंट स्वीकारते)
- तुम्ही
endpointकॉन्फिगरेशन देता (ThunderPhone तुमच्या API ला कुठे कॉल करते) — किंवा तुमच्या ऑर्ग वेबहुकवर टूल कॉल प्राप्त करण्यासाठी ते वगळा - कॉलदरम्यान, संभाषणाच्या आधारावर टूल कधी वापरायचे हे AI ठरवते
- ThunderPhone टूल आर्ग्युमेंटसह तुमच्या एंडपॉइंटला कॉल करते
- संभाषण सुरू ठेवण्यासाठी तुमचा API प्रतिसाद AI कडे परत पाठवला जातो
| क्षमता | ते कुठे चालते | सेटअप |
|---|---|---|
| अंगभूत टूल्स | ThunderPhone | prompt सूचना; काही टूल्सना एजंट सेटिंग देखील आवश्यक असते |
| अॅप कनेक्शन | ThunderPhone आणि कनेक्ट केलेला प्रदाता | खाते कनेक्ट करा आणि मंजूर कृती जोडा |
| API कनेक्शन आणि फंक्शन टूल्स | तुमचे HTTP API | एंडपॉइंट आणि स्कीमा परिभाषित करा किंवा वेबहुकद्वारे फंक्शन कॉल प्राप्त करा |
| MCP सर्व्हर | रिमोट MCP सर्व्हर | सर्व्हर जोडा, त्याची टूल्स शोधा आणि ते एजंटला जोडा |
टूल स्कीमा
प्रत्येक टूल ही रचना अनुसरते:
{
"type": "function",
"function": {
"name": "search_appointments",
"description": "Find available appointment slots for a given date",
"parameters": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Date in YYYY-MM-DD format"
},
"service": {
"type": "string",
"description": "Type of service (e.g., 'consultation', 'follow-up')"
}
},
"required": ["date"]
}
},
"endpoint": {
"url": "https://api.example.com/appointments/search",
"method": "POST",
"headers": {
"X-Api-Key": "your-api-key"
}
},
"timeout": 120
}टूल कॉन्फिगरेशन
| फील्ड | प्रकार | आवश्यक | वर्णन |
|---|---|---|---|
timeout | संख्या | नाही | सेकंदांमधील कमाल अंमलबजावणी वेळ (डीफॉल्ट: 20, कमाल: 180, किंवा wait_mode: "hold" सह 600) |
wait_mode | स्ट्रिंग | नाही | टूल चालू असताना कॉलरला काय ऐकू येते: updates (डीफॉल्ट), लहान बोललेली अद्यतने; किंवा hold, होल्ड संगीत. दीर्घ प्रतीक्षा: होल्ड मोड आणि नंतर उत्तर द्या पहा |
call_start | ऑब्जेक्ट | नाही | प्रत्येक फोन कॉलच्या सुरुवातीला, अभिवादनापूर्वी, टूल आपोआप चालवा. कॉलच्या सुरुवातीला टूल चालवा पहा |
फंक्शन परिभाषा
| फील्ड | प्रकार | आवश्यक | वर्णन |
|---|---|---|---|
name | स्ट्रिंग | होय | टूलसाठीचा ओळखकर्ता, एका कॉलमधील टूल्समध्ये अद्वितीय. वेगवेगळ्या एजंटकडे एकाच नावाचे स्वतःचे टूल असू शकते |
description | स्ट्रिंग | होय | हे टूल कधी वापरायचे ते AI ला समजावते |
parameters | ऑब्जेक्ट | होय | टूल आर्ग्युमेंट्ससाठी JSON Schema |
एंडपॉइंट कॉन्फिगरेशन
| फील्ड | प्रकार | आवश्यक | वर्णन |
|---|---|---|---|
url | स्ट्रिंग | होय | तुमच्या API एंडपॉइंटची URL |
method | स्ट्रिंग | नाही | HTTP पद्धत (डीफॉल्ट: POST) |
headers | ऑब्जेक्ट | नाही | समाविष्ट करण्यासाठी सानुकूल हेडर्स |
दोन इनव्होकेशन मार्ग
तुमच्या सर्व्हरला कोणती विनंती मिळते हे टूलकडे
endpoint आहे की नाही यावर अवलंबून असते:
endpoint असलेले टूल | endpoint नसलेले टूल | |
|---|---|---|
| विनंती कुठे जाते | थेट endpoint.url वर | तुमच्या संस्थेच्या लेगसी webhook URL वर |
| मुख्य भाग | निवडलेले विनंती स्वरूप (डीफॉल्टनुसार केवळ आर्ग्युमेंट्स) | telephony.tool / web.tool एन्व्हलप |
| हेडर्स | तुमचे endpoint.headers + X-ThunderPhone-Call-ID + X-ThunderPhone-Signature-V2 + X-ThunderPhone-Signature, तसेच फोन कॉलवरील कॉलचे क्रमांक | Content-Type + X-ThunderPhone-Signature-V2 + X-ThunderPhone-Signature |
| स्वाक्षरी की | संस्थेचे webhook गुपित | संस्थेचे webhook गुपित |
दोन्ही मार्ग अवरोधक आहेत — AI वाक्याच्या मध्यात परिणामाची वाट पाहत असते. डीफॉल्ट टाइमआउट 20 s आहे; अधिक वेळ चालणारी कार्यवाही अनुमत करण्यासाठी, प्लॅटफॉर्मच्या कमाल 180 s पर्यंत, टूलचा सर्वोच्च-स्तरीय timeout सेट करा. हँडलर जलद ठेवा. व्यक्तीची किंवा मंद प्रक्रियेची वाट पाहण्यासाठी,
होल्ड मोड वापरा. मिश्र वापर योग्य आहे:
ज्या संस्थेकडे webhook URL आहे अशा कॉलमध्ये, endpoint असलेली टूल्स थेट कॉल केली जातात आणि उर्वरित टूल्स webhook कडे परत जातात.
थेट endpoint कॉल्स
जेव्हा AI endpoint असलेले टूल वापरते, तेव्हा ThunderPhone तुमच्या URL ला
विनंती पाठवते:
विनंती हेडर्स
POST /appointments/search HTTP/1.1
Host: api.example.com
Content-Type: application/json
X-ThunderPhone-Signature-V2: t=1767225600,v1=5f2c...
X-ThunderPhone-Signature: abc123...
X-ThunderPhone-Call-ID: 987654321
X-ThunderPhone-From-Number: +14155550199
X-ThunderPhone-To-Number: +14155550100
X-ThunderPhone-Call-Direction: inbound
X-Api-Key: your-api-keyतुमच्या endpoint.headers मधील सानुकूल हेडर्स नेहमी
जसेच्या तसे समाविष्ट केले जातात, तसेच हे ThunderPhone नेमस्पेसमधील हेडर्स:
X-ThunderPhone-Signature-V2— तुमच्या org webhook secret सह की केलेला मेथड, पाथ, क्वेरी आणि मुख्य मजकुरावरील टाइमस्टॅम्पयुक्त HMAC-SHA256. याची पडताळणी करा आणि 5 मिनिटांपेक्षा जुन्या विनंत्या नाकारा; पाहा webhook स्वाक्षऱ्यांची पडताळणी कराX-ThunderPhone-Signature— अचूक विनंती-मुख्य-मजकूर बाइट्सचा लेगसी HMAC-SHA256, तीच की; विद्यमान पडताळकांसाठी अजूनही पाठवला जातोX-ThunderPhone-Call-ID— सध्याचा कॉल IDX-ThunderPhone-From-NumberआणिX-ThunderPhone-To-Number— कॉलचे E.164 मधील From आणि To क्रमांक. त्यांचा अर्थfrom_numberआणिto_numberयांसारखाच आहेtelephony.completeमध्ये: आउटबाउंड कॉलमध्ये, From हा तुमच्या एजंटचा क्रमांक असतो आणि To हा कॉल केलेल्या व्यक्तीचा क्रमांक असतो. कॉलर ID लपवलेला असल्यास किंवा तो फोन क्रमांक नसल्यास क्रमांक वगळला जातोX-ThunderPhone-Call-Direction—inboundकिंवाoutbound, त्यामुळे ग्राहकाचा क्रमांक कोणता आहे हे तुम्ही ओळखू शकता
कॉल-क्रमांक हेडर्स केवळ फोन कॉलवर पाठवले जातात. वेब, विजेट,
रिअलटाइम आणि ब्राउझर Talk चाचण्यांमध्ये फोन क्रमांक नसतो आणि ते हेडर्स वगळले जातात. एजंट एडिटरमधील चाचणी कॉल आणि AI सिम्युलेशनमध्ये
अनुकरण केलेल्या कॉलरचा क्रमांक असतो. स्वाक्षऱ्या
हेडर्स समाविष्ट करत नाहीत: V2 टाइमस्टॅम्प, मेथड, पाथ, क्वेरी आणि मुख्य मजकुरावर स्वाक्षरी करते. जर
तुम्हाला क्रमांकांवर स्वाक्षरी हवी असेल, तर त्याऐवजी ते मुख्य मजकुरातून वाचा:
retell विनंती स्वरूपात तिन्ही असतात, आणि vapi मध्ये
ग्राहकाचा क्रमांक असतो.
तुमचे endpoint.headers ते ओव्हरराइड करत नसल्यास Content-Type: application/json
सेट केले जाते — कस्टम Content-Type ला प्राधान्य मिळते.
विनंती स्वरूप
प्रत्येक API कनेक्शनमध्ये request_format सेटिंग असते. इम्पोर्ट केलेल्या टूलने त्या प्लॅटफॉर्मसाठी तयार केलेल्या एंडपॉइंटला कॉल करणे सुरू ठेवायचे असल्यास vapi किंवा
retell निवडा. नवीन आणि विद्यमान कनेक्शनसाठी डीफॉल्ट standard आहे.
POST / PUT / PATCH साठी, ThunderPhone निवडलेल्या
एन्व्हलपचे कॅनॉनिकल पद्धतीने सिरिअलायझेशन करते (क्रमबद्ध की, संक्षिप्त विभाजक). दोन्ही स्वाक्षऱ्या
या अचूक बाइट्सना कव्हर करतात.
Standard
standard कोणत्याही रॅपरशिवाय फक्त टूलचे आर्ग्युमेंट्स पाठवते. हे
डीफॉल्ट आहे आणि ThunderPhone चे मूळ रिक्वेस्ट बॉडी बाइट-टू-बाइट जसेच्या तसे राखते:
{"date":"2025-01-02","service":"consultation"}Vapi
vapi Vapi ने दस्तऐवजीकरण केलेल्या स्वरूपात Vapi चा tool-calls सर्व्हर संदेश
पाठवते. call.id हा ThunderPhone कॉल ID आहे.
फोन कॉलवर, call.customer.number हा Vapi च्या कॉल ऑब्जेक्टप्रमाणे समोरील पक्षाचा क्रमांक असतो:
इनबाउंड कॉलवरील कॉलर किंवा आउटबाउंड कॉलवरील ज्याला कॉल केला आहे ती व्यक्ती. तो क्रमांक लपवलेला असल्यास किंवा
फोन क्रमांक नसल्यास तो वगळला जातो. टूल-कॉल id हा इनव्होकेशनसाठी अद्वितीय असतो आणि
एंडपॉइंटच्या निकालाशी जुळवण्यासाठी पुन्हा वापरला जातो. कॉल toolCallList आणि
toolWithToolCallList दोन्हीमध्ये दिसतो, ज्यामध्ये function.arguments हा JSON ऑब्जेक्ट असतो:
{
"message": {
"type": "tool-calls",
"timestamp": 1725000000123,
"call": { "id": "987654321" },
"toolCallList": [
{
"id": "call_00112233445566778899aabbccddeeff",
"type": "function",
"function": {
"name": "search_appointments",
"arguments": { "date": "2025-01-02", "service": "consultation" }
}
}
],
"toolWithToolCallList": [
{
"type": "function",
"function": { "name": "search_appointments" },
"toolCall": {
"id": "call_00112233445566778899aabbccddeeff",
"type": "function",
"function": {
"name": "search_appointments",
"arguments": { "date": "2025-01-02", "service": "consultation" }
}
}
}
]
}
}assistant, artifact आणि पूर्ण call ऑब्जेक्टसारखी फक्त Vapi साठीची फील्ड्स
पाठवली जात नाहीत.
जुळणाऱ्या टूल-कॉल आयडीसह Vapi चे प्रतिसाद एन्व्हलप परत करा:
{
"results": [
{
"toolCallId": "call_00112233445566778899aabbccddeeff",
"result": "{\"available_slots\":[\"9:00 AM\",\"2:00 PM\"]}"
}
]
}ThunderPhone AI ला अनरॅप केलेली result स्ट्रिंग देते. आधीपासून JSON व्हॅल्यू परत करणाऱ्या एंडपॉइंटशी सुसंगततेसाठी ते
JSON व्हॅल्यू देखील स्वीकारते. result ऐवजी असलेली error AI कडे टूल त्रुटी म्हणून परत केली जाते. जर
एंडपॉइंटने चुकीचे स्वरूप असलेले किंवा न जुळणारे Vapi एन्व्हलप परत केले, तर ThunderPhone
इशारा लॉग करते आणि कॉल अयशस्वी करण्याऐवजी त्याच्या मानक प्रतिसाद पार्सिंगकडे परत जाते.
Retell
retell Retell कस्टम
फंक्शन साठी दस्तऐवजीकरण केलेली विनंती पाठवते:
{
"name": "search_appointments",
"call": {
"call_id": "987654321",
"from_number": "+14155550199",
"to_number": "+14155550100",
"direction": "inbound"
},
"args": { "date": "2025-01-02", "service": "consultation" }
}फोन कॉलमध्ये, call ऑब्जेक्टमध्ये call_id, from_number,
to_number आणि direction (inbound किंवा outbound) असतात—ही
Retell च्या फोन कॉल ऑब्जेक्टमध्ये वापरली जाणारी फील्ड नावे आहेत. ती कॉल-क्रमांक
हेडर्सशी जुळतात आणि हेडर्सच्या विपरीत, दोन्ही स्वाक्षऱ्यांद्वारे संरक्षित असतात. लपवलेला
किंवा फोन नंबर नसलेला नंबर वगळला जातो. वेब, विजेट,
रिअलटाइम आणि ब्राउझर Talk चाचण्यांमध्ये त्यात फक्त call_id असते. ThunderPhone
पाठवताना विश्वासार्हपणे पुरवू शकत नसलेली Retell-विशिष्ट फील्ड समाविष्ट करत नाही,
जसे की agent_id, transcript, transcript_object, metadata, किंवा डायनॅमिक
व्हेरिएबल्स. Retell कोणतेही प्रतिसाद बॉडी स्वीकारते; ThunderPhone मानक प्रतिसाद हाताळणी वापरून ते पुढे पाठवते.
GET / DELETE साठी, आर्ग्युमेंट्स क्वेरी पॅरामीटर्स म्हणून पाठवले जातात
आणि request_format कसेही असले तरी बॉडी रिकामी असते. V2 स्वाक्षरी
पाठवल्याप्रमाणे क्वेरी स्ट्रिंगला कव्हर करते; लेगसी स्वाक्षरी रिकाम्या बाइट स्ट्रिंगवर गणली जाते. पहा
वेबहुक स्वाक्षऱ्या पडताळा.
प्रतिसाद
टूलच्या निकालासह JSON प्रतिसाद परत करा:
{
"available_slots": ["9:00 AM", "2:00 PM", "4:30 PM"],
"timezone": "America/Los_Angeles"
}संभाषण सुरू ठेवण्यासाठी प्रतिसाद फॉरमॅट करून AI ला दिला जातो. JSON नसलेले
प्रतिसाद {"data": "<text>"} मध्ये रॅप केले जातात; टाइमआउट्स आणि कनेक्शन
अयशस्वी होणे AI ला त्रुटी म्हणून कळवले जाते, त्यामुळे एजंट थांबून राहण्याऐवजी
माफी मागून पुढे जाऊ शकतो.
Webhook-मोड डिस्पॅच
endpoint नसलेली टूल्स तुमच्या संस्थेच्या लेगसी webhook URL वर साइन केलेली
telephony.tool (फोन कॉल्स) किंवा web.tool (वेब कॉल्स) विनंती म्हणून डिस्पॅच
केली जातात. एक्झिक्यूशननंतर webhook endpoints वर पाठवल्या जाणाऱ्या
ऑडिट सूचनांपेक्षा वेगळे म्हणजे, ही विनंती हेच
एक्झिक्यूशन आहे — तुमचा HTTP प्रतिसाद हाच टूलचा निकाल असतो.
{
"type": "telephony.tool",
"data": {
"call_id": 987654321,
"tool_name": "search_appointments",
"arguments": { "date": "2026-04-21" },
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}web.tool मध्ये from_number /
to_number ऐवजी origin_domain असते. टूलचा परिणाम JSON म्हणून प्रतिसादात द्या — थेट endpoint कॉल्सप्रमाणेच
प्रतिसाद करार. प्रत्येक इतर webhook प्रमाणे, विनंतीवर संस्थेच्या
webhook secret ने दोन्ही स्वाक्षरी headers सह स्वाक्षरी केलेली असते.
दीर्घ प्रतीक्षा: होल्ड मोड आणि नंतर उत्तर द्या
काही टूल्स एखाद्या व्यक्तीची वाट पाहतात: सवलत मंजूर करणारा व्यवस्थापक, Slack मध्ये प्रश्नाचे उत्तर देणारा मालक. अशा टूल्सवर wait_mode ला "hold" सेट करा.
wait_mode: "updates" (डीफॉल्ट) | wait_mode: "hold" | |
|---|---|---|
| कॉलरला काय ऐकू येते | टूल सुरू होण्याची ओळ, त्यानंतर सुमारे 12 से नंतर एक छोटी "अजून काम सुरू आहे" ओळ आणि दर 15 से च्या आसपास आणखी एक | टूल सुरू होण्याची ओळ, त्यानंतर निकाल येईपर्यंत होल्ड संगीत |
timeout कमाल मर्यादा | 180 से | 600 से |
| प्रलंबित उत्तरे | निकाल म्हणून एजंटला पाठवली जातात | तुम्ही निकाल देईपर्यंत टूल उघडे राहते |
होल्ड मोडमध्ये टूल सुरू होताना एजंट एक ओळ बोलतो (त्याच्या स्वतःच्या शब्दांत किंवा एजंटवर सेट केलेली टूल-सुरू होण्याची ओळ), त्यानंतर कॉलरला होल्ड संगीत ऐकू येते. एजंट निकाल बोलण्यापूर्वी संगीत हळूहळू बंद होते. एक-दोन सेकंदांत उत्तर देणाऱ्या टूलसाठी संगीत अजिबात वाजत नाही. एजंट फोन मेनू किंवा व्हॉइसमेल बॉक्सशी बोलत असल्यास, तो त्याऐवजी बोललेली अद्यतने वापरतो, कारण संगीत उत्तरासारखे ऐकू येऊ शकते. होल्डमध्ये असताना मेनू किंवा मेलबॉक्स असल्याचे आढळलेल्या कॉलमध्येही हेच होते: संगीत थांबते आणि बोललेली अद्यतने सुरू होतात. संगीत वाजू शकत नसलेल्या कॉलसाठीही असेच होते.
होल्डदरम्यान कॉलर बोलल्यास, संगीत सुरूच राहते आणि एजंट अद्याप उत्तर देत नाही. कॉलरने काय म्हटले ते तो ऐकतो आणि निकालासोबत त्याला उत्तर देतो. कॉल बंद केल्यास कॉल आणि उघडे टूल समाप्त होते.
नंतर उत्तर द्या
तुमच्या एंडपॉइंटचा स्वतःचा प्रतिसाद तरीही 180 से च्या आत यायला हवा. कॉलरला अधिक वेळ होल्डवर ठेवण्यासाठी, प्रलंबित निकालासह लगेच उत्तर द्या:
{ "status": "pending", "request_id": "ask-4471" }request_id ही तुमच्या बाजूने या विनंतीची ओळख करणारी, जास्तीत जास्त 200 वर्णांची कोणतीही स्ट्रिंग आहे. तुम्ही यासाठीचा निकाल
POST /v1/calls/{call_id}/tool-results
वापरून देईपर्यंत कॉलर होल्डवर राहतो. call_id हे टूल विनंतीच्या X-ThunderPhone-Call-ID हेडरमध्ये असते.
curl -X POST https://api.thunderphone.com/v1/calls/987654321/tool-results \
-H "Authorization: Bearer sk_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"request_id": "ask-4471",
"result": { "answer": "Yes, book Tuesday at 10." }
}'एजंट result ला टूलचे उत्तर म्हणून वाचतो, जसे तुमच्या एंडपॉइंटने ते परत केले असते. टूलला कॉल केल्यापासून मोजलेल्या timeout पूर्वी कोणताही निकाल न आल्यास, एजंटला उत्तर परत आले नाही असे सांगितले जाते आणि तो कॉलरला पुढील पर्याय सुचवतो, जसे संदेश घेणे.
तुमचा प्रलंबित प्रतिसाद ThunderPhone पर्यंत पोहोचण्यापूर्वीही तुम्ही हवे तेव्हा निकाल पोस्ट करू शकता. 202 म्हणजे विनंतीने तो स्वीकारला: एखाद्या उघड्या विनंतीने तो घेतला आहे किंवा टूलची स्वतःची विनंती अजूनही प्रक्रियेत आहे आणि तिचे प्रलंबित उत्तर त्याच्याशी जोडले जाईल. ज्या निकालाशी कोणतीही विनंती कधीही जोडली जात नाही (तुमच्या एंडपॉइंटने त्या request_id साठी नंतर प्रलंबित व्यतिरिक्त काहीतरी उत्तर दिले), तो टाकून दिला जातो.
कनेक्शनमध्ये रिस्पॉन्स ट्रान्सफॉर्म असल्यास (एजंटला दिसण्यापूर्वी तुमच्या एंडपॉइंटचे उत्तर पुन्हा लिहिणारा कोड), ThunderPhone प्रलंबित उत्तर तपासण्यापूर्वी तो ट्रान्सफॉर्म तुमच्या एंडपॉइंटच्या स्वतःच्या उत्तरावर चालतो, त्यामुळे त्याने प्रलंबित उत्तरात status आणि request_id ठेवणे आवश्यक आहे. तुम्ही नंतर पोस्ट केलेल्या निकालावर तो चालत नाही: एजंटला तो निकाल तुम्ही पाठवता तसाच मिळतो.
फुल-डुप्लेक्स एजंटकडे होल्ड संगीत किंवा अद्यतन ओळी नसतात, त्यामुळे त्याच्या कॉलवर होल्ड टूल updates टूलप्रमाणे वागते: प्रलंबित उत्तर टूलचा निकाल म्हणून एजंटपर्यंत पोहोचते.
updates मोडमधील टूलचा प्रलंबित प्रतिसाद उघडा ठेवला जात नाही: एजंटला तो टूलचा निकाल म्हणून मिळतो.
स्वाक्षरी पडताळणी
थेट टूल कॉल्सना वेबहुकप्रमाणेच, तुमच्या संस्थेच्या वेबहुक सीक्रेटचा वापर करून स्वाक्षरीत केले जाते:
X-ThunderPhone-Signature-V2पाठवलेला टाइमस्टॅम्प, मेथड, पाथ आणि क्वेरी तसेच अचूक बॉडी बाइट्स स्वाक्षरीत करतो. तुमच्या घड्याळाच्या वेळेपेक्षा टाइमस्टॅम्पमध्ये 5 मिनिटांहून अधिक फरक असलेल्या विनंत्या नाकारा.X-ThunderPhone-Signature(लेगसी) फक्त बॉडी बाइट्सना स्वाक्षरीत करतो,GET/DELETEसाठी रिकामी बाइट स्ट्रिंग. तो अजूनही अपरिवर्तित पाठवला जातो.
SDK हेल्पर्स 5 मिनिटांच्या कालमर्यादेसह V2 हेडर तपासतात:
import json
from fastapi import FastAPI, HTTPException, Request
from thunderphone import verify_signature
app = FastAPI()
@app.post("/appointments/search")
async def search_appointments(request: Request):
body = await request.body()
query = request.scope.get("query_string", b"").decode("latin-1")
path = request.url.path + (f"?{query}" if query else "")
if not verify_signature(
request.headers.get("X-ThunderPhone-Signature-V2"),
secret=WEBHOOK_SECRET,
method=request.method,
path=path,
body=body,
):
raise HTTPException(status_code=401)
data = json.loads(body)
date = data["date"]
# Look up availability
slots = await get_available_slots(date)
return {"available_slots": slots}import express from "express";
import { verifySignature } from "@thunderphone/sdk";
app.post('/appointments/search', express.raw({type: 'application/json'}), (req, res) => {
const ok = verifySignature({
header: req.header('X-ThunderPhone-Signature-V2'),
secret: WEBHOOK_SECRET,
method: req.method,
path: req.originalUrl,
body: req.body,
});
if (!ok) return res.status(401).send('Invalid signature');
const { date, service } = JSON.parse(req.body);
// Look up availability
const slots = getAvailableSlots(date, service);
res.json({ available_slots: slots });
});स्वाक्षरीत स्ट्रिंग, पूर्ण उदाहरण, SDK शिवायचा कोड, GET / DELETE प्रकरण आणि सीक्रेट नसतानाची सूचना यांसह संपूर्ण तपशील वेबहुक स्वाक्षऱ्या पडताळा मध्ये आहेत.
उदाहरण: संपूर्ण बुकिंग फ्लो
संपूर्ण अपॉइंटमेंट बुकिंग सिस्टमसाठी टूलचा संच येथे आहे:
{
"tools": [
{
"type": "function",
"function": {
"name": "search_appointments",
"description": "Find available appointment slots",
"parameters": {
"type": "object",
"properties": {
"date": { "type": "string", "description": "YYYY-MM-DD" },
"service": { "type": "string" }
},
"required": ["date"]
}
},
"endpoint": {
"url": "https://api.example.com/appointments/search",
"method": "POST",
"headers": { "X-Api-Key": "key" }
}
},
{
"type": "function",
"function": {
"name": "book_appointment",
"description": "Book an appointment at a specific time",
"parameters": {
"type": "object",
"properties": {
"date": { "type": "string", "description": "YYYY-MM-DD" },
"time": { "type": "string", "description": "HH:MM format" },
"customer_name": { "type": "string" },
"customer_phone": { "type": "string" }
},
"required": ["date", "time", "customer_name"]
}
},
"endpoint": {
"url": "https://api.example.com/appointments/book",
"method": "POST",
"headers": { "X-Api-Key": "key" }
}
},
{
"type": "function",
"function": {
"name": "cancel_appointment",
"description": "Cancel an existing appointment",
"parameters": {
"type": "object",
"properties": {
"confirmation_number": { "type": "string" }
},
"required": ["confirmation_number"]
}
},
"endpoint": {
"url": "https://api.example.com/appointments/cancel",
"method": "POST",
"headers": { "X-Api-Key": "key" }
}
}
]
}कॉलच्या सुरुवातीला टूल चालवा
प्रत्येक फोन कॉलच्या सुरुवातीला, एजंट त्याचा पहिला शब्द बोलण्यापूर्वी, टूल आपोआप चालू शकते, त्यामुळे अभिवादनासाठी त्याचा निकाल वापरता येतो. कॉलरच्या नंबरवरून CRM शोध घेणे हे याचे नेहमीचे उदाहरण आहे: "पुन्हा स्वागत आहे, आरती! तुम्हाला तुमची नेहमीची ऑर्डर हवी आहे का?"
डॅशबोर्डमध्ये API कनेक्शन उघडा आणि ते कधी चालते हे प्रत्येक फोन कॉलच्या सुरुवातीला असे सेट करा, नंतर प्रत्येक पॅरामीटरला मिळणारे मूल्य भरा. API द्वारे, इंटिग्रेशनचे trigger call_start आणि त्याचे call_start_arguments
(API कनेक्शन) असे सेट करा किंवा इनलाइन टूलमध्ये call_start
ब्लॉक जोडा:
{
"type": "function",
"function": {
"name": "get_contact_by_phone",
"description": "Look up a customer by phone number.",
"parameters": {
"type": "object",
"properties": {
"business_id": {"type": "string"},
"phone_number": {"type": "string"}
},
"required": ["business_id", "phone_number"]
}
},
"endpoint": {"url": "https://crm.example.com/contacts/lookup"},
"call_start": {
"arguments": {
"business_id": "a0a81c23",
"phone_number": "{{caller_number}}"
}
}
}प्रत्येक आवश्यक पॅरामीटरसाठी arguments मध्ये मूल्य असणे आवश्यक आहे, कारण कॉलच्या सुरुवातीला कोणीही काही भरत नाही. मूल्ये स्ट्रिंग्स, संख्या किंवा बूलियन असतात. ती साधा मजकूर म्हणून संग्रहित आणि परत केली जातात व एजंटला दिसतात, म्हणून API कीसारखी गुपिते येथे न ठेवता कनेक्शनच्या headers मध्ये ठेवा. स्ट्रिंग्समध्ये हे प्लेसहोल्डर वापरता येतात:
| प्लेसहोल्डर | मूल्य |
|---|---|
{{caller_number}} | E.164 स्वरूपातील कॉलवरील दुसरी व्यक्ती, उदा. +61402122887: इनबाउंड कॉलवरील कॉलर, आउटबाउंड कॉलवरील ज्या व्यक्तीला कॉल केला आहे ती |
{{caller_number_national}} | रिकाम्या जागांशिवाय त्या देशाच्या राष्ट्रीय स्वरूपातील तोच नंबर, उदा. 0402122887 |
{{agent_number}} | एजंटचा स्वतःचा नंबर |
ते कसे कार्य करते:
- विनंती एजंटच्या स्वतःच्या टूल कॉलद्वारे पाठवल्या जाणाऱ्या विनंतीसारखीच असते (तोच endpoint, headers, विनंती स्वरूप आणि स्वाक्षरी).
- कॉल सुरू झाल्यावर टूल सुरू होते आणि कोणताही कनेक्ट टोन, परिचय किंवा रेकॉर्डिंग सूचना चालू असताना कार्यरत राहते. त्या क्षणापासून अभिवादन त्याची सुमारे 3 सेकंदांपर्यंत वाट पाहते. निकाल उशिरा आल्यास, उर्वरित कॉलसाठी तो येताच एजंटला दिला जातो. आउटबाउंड कॉलमध्ये कॉल लावताना ते सुरू होते, त्यामुळे कोणीही उत्तर न दिलेल्या प्रयत्नांसह प्रत्येक प्रयत्नावर ते चालते.
- ज्या एजंटमध्ये कॉलर आधी बोलतो, तिथे वाट पाहण्यासाठी अभिवादन नसते; निकाल येताच एजंटला तो मिळतो.
- संपूर्ण कॉलसाठी निकाल एजंटला संदर्भ म्हणून दिला जातो. तो कसा वापरायचा हे एजंटला तुमच्या prompt मध्ये सांगा; अन्यथा तो मोठ्याने वाचला जात नाही.
- टूल अयशस्वी झाल्यास किंवा वेळ संपल्यास, एजंट नेहमीप्रमाणे कॉलरचे अभिवादन करतो आणि त्याबद्दल काहीही सांगत नाही.
- एजंट कॉलमध्ये नंतरही स्वतः टूल कॉल करू शकतो.
- हे फोन कॉलवर चालते, ज्यात तुमच्या फोनवरील डॅशबोर्ड चाचणी कॉल आणि सिम्युलेटेड कॉलरचा नंबर तुमच्या endpoint कडे पाठवणारी AI सिम्युलेशन्स यांचा समावेश आहे. कॉलर नंबर नसलेल्या ब्राउझर बोला चाचण्यांमध्ये किंवा वेब विजेट सत्रांमध्ये, कॉलर ID लपवलेल्या कॉलवर किंवा स्टेप्स असलेल्या एजंटवर ते चालत नाही.
- एजंट जास्तीत जास्त तीन कॉल-सुरुवातीची टूल्स एकाच वेळी चालवतो.
एजंटला निकाल कसा वापरायचा हे कळावे म्हणून तुमच्या prompt मध्ये त्याचा उल्लेख करा, उदाहरणार्थ: "कॉलच्या सुरुवातीच्या शोधात कॉलर सापडल्यास, त्यांचे पहिल्या नावाने अभिवादन करा."
सर्वोत्तम पद्धती
स्पष्ट वर्णने लिहा
description फील्ड AI ला टूल केव्हा वापरायचे हे समजण्यास मदत करते. ते काय करते आणि ते केव्हा योग्य आहे याबद्दल स्पष्ट माहिती द्या.
त्रुटी योग्य प्रकारे हाताळा
AI ला समजतील असे त्रुटी संदेश परत करा: सामान्य 500 त्रुटींऐवजी {"error": "No slots available for that date"}.
प्रतिसाद संक्षिप्त ठेवा
संभाषण पुढे सुरू ठेवण्यासाठी AI ला जेवढी गरज आहे तेवढेच परत करा. टूलचा परिणाम संभाषणात राहतो आणि प्रत्येक पुढील टर्नमध्ये पुन्हा वाचला जातो, त्यामुळे मोठा परिणाम उर्वरित कॉलसाठी खर्च आणि विलंब वाढवतो. 100,000 पेक्षा जास्त वर्णांचे परिणाम AI ला अपूर्ण असल्याचे माहीत असलेल्या पूर्वावलोकनापर्यंत कमी केले जातात आणि खूप लांब कॉलमध्ये जुने परिणाम वगळले जाऊ शकतात (AI टूल पुन्हा कॉल करू शकते). एकावेळी एकच आयटम किंवा श्रेणी शोधता यावी यासाठी पॅरामीटर जोडा आणि मेनू किंवा कॅटलॉगसारखी मोठी संदर्भ सामग्री नॉलेज बेस मध्ये ठेवा. डॅशबोर्डमधील चाचणी विनंती पाठवा प्रत्येक परिणामाचा आकार दाखवते आणि तो मोठा असल्यास इशारा देते.
आवश्यक फील्डचा विचारपूर्वक वापर करा
फील्ड खरोखर आवश्यक असतील तेव्हाच त्यांना required म्हणून चिन्हांकित करा. टूल कॉल करण्यापूर्वी AI वापरकर्त्याकडून आवश्यक माहिती विचारेल.
संबंधित
एंडपॉइंट परिभाषित न करता प्लॅटफॉर्म-व्यवस्थापित कॉल कृतींसाठी prompt द्या.
HubSpot, Salesforce, Google Calendar, Google Sheets आणि Cal.com साठी प्लॅटफॉर्म-व्यवस्थापित साधने — एंडपॉइंटची गरज नाही.
MCP सर्व्हर जोडा आणि एजंटला त्याची साधने कॉल करू द्या.
एजंटना जोडता येतील अशी पुनर्वापरयोग्य REST एकत्रीकरणे.
वेबहुक आणि टूल कॉलसाठी एक सत्यापन सहाय्यक.