Open in
ફંક્શન ટૂલ્સ
તમારા AI એજન્ટોને એવા ફંક્શન ટૂલ્સ આપો જે વાતચીત દરમિયાન બાહ્ય API ને કૉલ કરે — ગ્રાહક ડેટા મેળવે, એપોઇન્ટમેન્ટ બુક કરે, રેકોર્ડ અપડેટ કરે — પ્રકાર-નિર્ધારિત પેરામીટરો સાથે.
ફંક્શન ટૂલ્સ તમારા AI એજન્ટ્સને ફોન કૉલ્સ દરમિયાન બાહ્ય APIs ઇન્વોક કરવાની મંજૂરી આપે છે. ગ્રાહક ડેટા શોધવા, ઉપલબ્ધતા તપાસવા, એપૉઇન્ટમેન્ટ બુક કરવા અથવા તમારું બેકએન્ડ સપોર્ટ કરતું કોઈપણ કાર્ય કરવા માટે તેનો ઉપયોગ કરો.
તે કેવી રીતે કાર્ય કરે છે
- તમે સ્કીમા સાથે ટૂલ્સ વ્યાખ્યાયિત કરો છો (ટૂલ કયા આર્ગ્યુમેન્ટ્સ સ્વીકારે છે)
- તમે
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 પર |
| બોડી | પસંદ કરેલ વિનંતી ફોર્મેટ (ડિફૉલ્ટ રીતે ફક્ત arguments) | 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 છે; વધુ લાંબા એક્ઝિક્યુશનને મંજૂરી આપવા માટે ટૂલનું ટોચના સ્તરનું timeout સેટ કરો, પ્લેટફૉર્મની મહત્તમ 180 s સુધી. હેન્ડલરો ઝડપી રાખો. વ્યક્તિ અથવા ધીમા કાર્યની રાહ માટે હોલ્ડ મોડ વાપરો. મિશ્રણ પણ યોગ્ય છે: જે કૉલની સંસ્થામાં વેબહૂક URL હોય, તેમાં 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— મેથડ, પાથ, ક્વેરી અને બોડી પરનો ટાઇમસ્ટેમ્પવાળો HMAC-SHA256, જેમાં તમારા સંસ્થાના વેબહૂક સિક્રેટનો કી તરીકે ઉપયોગ થાય છે. આને ચકાસો અને 5 મિનિટથી જૂની વિનંતીઓ નકારી કાઢો; જુઓ વેબહૂક સહીઓ ચકાસોX-ThunderPhone-Signature— ચોક્કસ વિનંતિ-બોડી બાઇટ્સનો લેગસી HMAC-SHA256, એ જ કી સાથે, હાલના ચકાસણકારો માટે હજી મોકલાય છેX-ThunderPhone-Call-ID— વર્તમાન કૉલ IDX-ThunderPhone-From-NumberઅનેX-ThunderPhone-To-Number— કૉલના E.164 ફોર્મેટમાં રહેલા From અને To નંબરો. તેનો અર્થtelephony.completeમાંનાfrom_numberઅનેto_numberજેવો જ છે: આઉટબાઉન્ડ કૉલમાં, 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નો tool-calls સર્વર સંદેશ
Vapi દસ્તાવેજીકરણમાં દર્શાવેલા સ્વરૂપમાં મોકલે છે. 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-સંબંધિત ફીલ્ડ્સ
મોકલવામાં આવતા નથી.
મેળ ખાતા ટૂલ-કૉલ ID સાથે 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 ને ભૂલો તરીકે રિપોર્ટ થાય છે, જેથી
એજન્ટ અટકી જવાને બદલે માફી માંગી અને આગળ વધી શકે.
વેબહૂક-મોડ ડિસ્પૅચ
endpoint વિનાના ટૂલ્સ તમારી સંસ્થાના લેગસી
વેબહૂક URL પર સાઇન કરેલી telephony.tool (ફોન કૉલ્સ) અથવા web.tool
(વેબ કૉલ્સ) વિનંતી તરીકે ડિસ્પૅચ થાય છે. એક્ઝિક્યુશન પછી વેબહૂક એન્ડપૉઇન્ટ્સ પર પહોંચાડવામાં આવતી
ઑડિટ સૂચનાઓ કરતાં અલગ, આ વિનંતી જ
એક્ઝિક્યુશન છે — તમારો 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 ની જેમ, વિનંતી org webhook secret વડે બંને signature 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 મોડમાં ટૂલનો બાકી જવાબ ખુલ્લો રાખવામાં આવતો નથી:
એજન્ટ તેને ટૂલના પરિણામ તરીકે મેળવે છે.
સહીની ચકાસણી
સીધા ટૂલ કૉલ્સને વેબહુક્સની જેમ જ સહી કરવામાં આવે છે, જેમાં તમારી સંસ્થાના webhook secretનો ઉપયોગ થાય છે:
X-ThunderPhone-Signature-V2મોકલેલ timestamp, method, path અને query તેમજ ચોક્કસ body bytes પર સહી કરે છે. જે વિનંતીઓનો timestamp તમારી ઘડિયાળ કરતાં 5 મિનિટથી વધુ અલગ હોય તેને નકારી કાઢો.X-ThunderPhone-Signature(લેગસી) ફક્ત body bytes પર સહી કરે છે અનેGET/DELETEમાટે ખાલી byte string પર સહી કરે છે. તે હજી પણ યથાવત્ મોકલવામાં આવે છે.
SDK સહાયક ફંક્શન્સ 5-મિનિટની સમયમર્યાદા સહિત V2 header તપાસે છે:
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 });
});સંપૂર્ણ માર્ગદર્શિકાઓ — સહી કરેલી string, કાર્યરત ઉદાહરણ, SDK વિનાનો કોડ,
GET / DELETE કિસ્સો અને secret ન હોવાની નોંધ — webhook signatures ચકાસો માં ઉપલબ્ધ છે.
ઉદાહરણ: સંપૂર્ણ બુકિંગ ફ્લો
સંપૂર્ણ એપૉઇન્ટમેન્ટ બુકિંગ સિસ્ટમ માટે ટૂલ્સનો આ સમૂહ છે:
{
"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}}"
}
}
}દરેક જરૂરી પેરામીટર માટે આર્ગ્યુમેન્ટ્સમાં મૂલ્ય હોવું જરૂરી છે, કારણ કે કૉલ શરૂ થતાં કોઈ કંઈ ભરતું નથી. મૂલ્યો સ્ટ્રિંગ્સ, સંખ્યાઓ અથવા બુલિયન હોઈ શકે છે. તે સાદા લખાણ તરીકે સંગ્રહિત અને પરત કરવામાં આવે છે અને એજન્ટ તેને જોઈ શકે છે, તેથી API કી જેવા રહસ્યો અહીં નહીં, પરંતુ કનેક્શનના હેડર્સમાં રાખો. સ્ટ્રિંગ્સ આ સ્થાનધારકોનો ઉપયોગ કરી શકે છે:
| સ્થાનધારક | મૂલ્ય |
|---|---|
{{caller_number}} | E.164 ફોર્મેટમાં કૉલ પરની બીજી વ્યક્તિનો નંબર, ઉદાહરણ તરીકે +61402122887: ઇનબાઉન્ડ કૉલમાં કૉલર અને આઉટબાઉન્ડ કૉલમાં જેને કૉલ કરવામાં આવ્યો હોય તે વ્યક્તિ |
{{caller_number_national}} | જગ્યાઓ વિના, તેના દેશના રાષ્ટ્રીય ફોર્મેટમાં એ જ નંબર, ઉદાહરણ તરીકે 0402122887 |
{{agent_number}} | એજન્ટનો પોતાનો નંબર |
તે કેવી રીતે કાર્ય કરે છે:
- વિનંતી એજન્ટના પોતાના ટૂલ કૉલ્સ મોકલે છે તેવી જ હોય છે (સમાન એન્ડપોઇન્ટ, હેડર્સ, વિનંતી ફોર્મેટ અને સહી).
- કૉલ શરૂ થાય ત્યારે ટૂલ શરૂ થાય છે અને કોઈપણ કનેક્ટ ટોન, પરિચય અથવા રેકોર્ડિંગ સૂચના ચાલતી હોય ત્યારે ચાલે છે. તે બિંદુથી અભિવાદન તેના માટે લગભગ 3 સેકન્ડ સુધી રાહ જુએ છે. ધીમું પરિણામ પહોંચતાની સાથે જ કૉલના બાકીના સમય માટે એજન્ટને આપવામાં આવે છે. આઉટબાઉન્ડ કૉલમાં, કૉલ મૂકવામાં આવે ત્યારે તે શરૂ થાય છે, તેથી કોઈ જવાબ ન આપે તેવા પ્રયાસો સહિત દરેક પ્રયાસમાં તે ચાલે છે.
- જે એજન્ટમાં કૉલર પહેલાં બોલે છે તેમાં રાહ જોવા માટે કોઈ અભિવાદન હોતું નથી; પરિણામ પહોંચતાની સાથે જ એજન્ટને મળે છે.
- પરિણામ આખા કૉલ માટે સંદર્ભ તરીકે એજન્ટને આપવામાં આવે છે. તેનો ઉપયોગ કેવી રીતે કરવો તે તમારા promptમાં એજન્ટને જણાવો; અન્યથા તે વાંચીને સંભળાવવામાં આવતું નથી.
- જો ટૂલ નિષ્ફળ જાય અથવા સમયસમાપ્તિ થાય, તો એજન્ટ સામાન્ય રીતે જે રીતે કરે તે રીતે કૉલરને અભિવાદન કરે છે અને તેના વિશે કંઈ કહેતું નથી.
- એજન્ટ કૉલમાં પછી પણ ટૂલને જાતે કૉલ કરી શકે છે.
- તે ફોન કૉલ્સ પર ચાલે છે, જેમાં તમારા ફોન પરના ડેશબોર્ડ ટેસ્ટ કૉલ્સ અને AI સિમ્યુલેશન્સનો સમાવેશ થાય છે, જે સિમ્યુલેટેડ કૉલરનો નંબર તમારા એન્ડપોઇન્ટ પર મોકલે છે. તે બ્રાઉઝર વાતચીત ટેસ્ટ અથવા વેબ વિજેટ સત્રોમાં ચાલતું નથી, જેમાં કૉલર નંબર હોતો નથી, જે કૉલ્સમાં કૉલર ID છુપાવેલ હોય તેમાં, અથવા સ્ટેપ્સ ધરાવતા એજન્ટ્સ પર.
- એક એજન્ટ વધુમાં વધુ ત્રણ કૉલ-સ્ટાર્ટ ટૂલ્સ ચલાવે છે, અને તે બધા એકસાથે ચાલે છે.
તમારા promptમાં પરિણામનો ઉલ્લેખ કરો જેથી એજન્ટને તેનો ઉપયોગ કેવી રીતે કરવો તે ખબર પડે, ઉદાહરણ તરીકે: "જો કૉલ-સ્ટાર્ટ લુકઅપમાં કૉલર મળી જાય, તો તેમને તેમના પહેલા નામથી અભિવાદન કરો."
શ્રેષ્ઠ પદ્ધતિઓ
સ્પષ્ટ વર્ણનો લખો
description ફીલ્ડ AI ને ટૂલનો ઉપયોગ ક્યારે કરવો તે સમજવામાં મદદ કરે છે. તે શું કરે છે અને ક્યારે યોગ્ય છે તે સ્પષ્ટ રીતે જણાવો.
ભૂલોને સુવ્યવસ્થિત રીતે હેન્ડલ કરો
AI સમજી શકે તેવા એરર મેસેજ પરત કરો: સામાન્ય 500 એરરને બદલે {"error": "No slots available for that date"}.
પ્રતિસાદ સંક્ષિપ્ત રાખો
વાતચીત ચાલુ રાખવા માટે AIને જેટલી જરૂર હોય તેટલું જ પરત કરો. ટૂલનું પરિણામ વાતચીતમાં રહે છે અને પછીના દરેક વારમાં ફરી વાંચવામાં આવે છે, તેથી મોટું પરિણામ બાકીના કૉલ માટે ખર્ચ અને વિલંબ વધારશે. 100,000 કરતાં વધુ અક્ષરોના પરિણામોને અધૂરા હોવાનું AI જાણે છે તેવા પૂર્વાવલોકન સુધી ટૂંકાવવામાં આવે છે, અને ખૂબ લાંબા કૉલમાં જૂના પરિણામો દૂર થઈ શકે છે (AI ટૂલને ફરી કૉલ કરી શકે છે). એક સમયે એક આઇટમ અથવા શ્રેણી શોધી શકે તે માટે AI માટે પેરામીટર ઉમેરો, અને મેનુ અથવા કૅટલૉગ જેવી મોટી સંદર્ભ સામગ્રીને જ્ઞાન આધારમાં મૂકો. ડૅશબોર્ડમાં ટેસ્ટ વિનંતી મોકલો દરેક પરિણામનું કદ દર્શાવે છે અને તે મોટું હોય ત્યારે ચેતવણી આપે છે.
જરૂરી ફીલ્ડ્સનો સમજદારીથી ઉપયોગ કરો
ફીલ્ડ્સને required તરીકે માત્ર ત્યારે જ ચિહ્નિત કરો જ્યારે ખરેખર જરૂરી હોય. ટૂલ કૉલ કરતાં પહેલાં AI વપરાશકર્તાને જરૂરી માહિતી પૂછશે.
સંબંધિત
endpoint નિર્ધારિત કર્યા વિના પ્લેટફોર્મ-સંચાલિત કૉલ ક્રિયાઓ માટે prompt કરો.
HubSpot, Salesforce, Google Calendar, Google Sheets અને Cal.com માટે પ્લેટફોર્મ-સંચાલિત ટૂલ્સ — endpoint જરૂરી નથી.
MCP સર્વર જોડો અને એજન્ટને તેના ટૂલ્સ કૉલ કરવા દો.
ફરીથી વાપરી શકાય તેવા REST ઇન્ટિગ્રેશન્સ, જે તમે એજન્ટ્સ સાથે જોડી શકો છો.
webhooks અને ટૂલ કૉલ્સ માટે એક ચકાસણી સહાયક.