Open in
telephony.incoming / web.incoming
બ્લોકિંગ webhook જે આવનારા કૉલનું કન્ફિગરેશન વાસ્તવિક સમયમાં આકાર આપે છે.
જ્યારે આવનારો ફોન કૉલ એવા નંબર પર પહોંચે કે જેમાં કોઈ એજન્ટ
સોંપાયેલો નથી (તમારા જનાર કૉલ્સ પરત કરતા કૉલર્સ માટે કૉલબૅક્સ જુઓ), અથવા વેબ વિજેટ સત્ર પ્રકાશિત કરી શકાય તેવી કી પર
mode="webhook" માં શરૂ થાય, ત્યારે ThunderPhone તમારા
લેગસી webhook URL પર બ્લોકિંગ
telephony.incoming / web.incoming વિનંતી મોકલે છે
અને રૂપરેખાંકન પ્રતિભાવની રાહ જુએ છે: ફોન કૉલ માટે 13 સેકન્ડ સુધી,
જેમાં એક પુનઃપ્રયાસ શામેલ છે, અને વિજેટ સત્ર માટે 10 સેકન્ડ સુધી
(સમયસમાપ્તિઓ અને પુનઃપ્રયાસો જુઓ). દરેક કૉલ માટે prompt, અવાજ અને સાધનો ગતિશીલ રીતે પસંદ કરવા માટે આ
આદાનપ્રદાનનો ઉપયોગ કરો —
શરૂઆતથી અંત સુધીની પદ્ધતિ માટે ગતિશીલ કૉલ રૂપરેખાંકન માર્ગદર્શિકા
જુઓ.
એજન્ટ સોંપાયેલો હોય તે નંબરનો જવાબ તે એજન્ટ આપે છે. જ્યારે એજન્ટનું પોતાનું કૉલ સેટઅપ webhook હોય, ત્યારે એજન્ટના વેરિએબલ્સ અને કૉલનો સંદર્ભ ભરવા માટે, એ જ અવરોધક વિનિમય સૌપ્રથમ એજન્ટના URL પર થાય છે.
સમયસમાપ્તિ અને પુનઃપ્રયાસો
ઝડપથી જવાબ આપો: તમે નિર્ણય લો છો ત્યારે કૉલર લાઇન પર રાહ જોઈ રહ્યો છે.
ફોન કૉલ (telephony.incoming) માટે:
- પ્રથમ પ્રયાસમાં વધુમાં વધુ 10 સેકન્ડ લાગી શકે છે.
- જો સમયસમાપ્તિ થાય, કનેક્ટ ન થઈ શકે, અથવા
5xx,408કે429પ્રતિસાદ મળે, તો ThunderPhone વધુ એક વાર પ્રયાસ કરે છે. પુનઃપ્રયાસને સમગ્ર વિનિમય માટેના 13-સેકન્ડના બજેટમાંથી જે બાકી હોય તે મળે છે: સમયસમાપ્તિ થયેલા પ્રથમ પ્રયાસ પછી અંદાજે 3 સેકન્ડ, અને ઝડપી નિષ્ફળતા પછી લગભગ બધા 13 સેકન્ડ. જ્યારે 2 સેકન્ડથી ઓછો સમય બાકી હોય ત્યારે પુનઃપ્રયાસ થતો નથી. - અન્ય કોઈપણ
4xxપ્રતિસાદ, કદ મર્યાદા કરતાં મોટો પ્રતિસાદ, અથવા જેનું બૉડી માન્ય કૉન્ફિગરેશન ન હોય એવો2xxપ્રતિસાદ અંતિમ ગણાય છે અને તેનો પુનઃપ્રયાસ થતો નથી. - બંને પ્રયાસો એક જ બૉડી, એક જ
X-ThunderPhone-Signature, અને એક જX-ThunderPhone-Idempotency-Keyહેડર (telephony-incoming-<call_id>) મોકલે છે, જેથી આડઅસરો ધરાવતો હેન્ડલર પુનઃપ્રયાસને ઓળખી શકે.
જો કોઈ ઉપયોગી કન્ફિગરેશન ન મળે, તો કૉલરને શાંત લાઇન પર રાખવાને બદલે કૉલ તરત જ સમાપ્ત કરવામાં આવે છે. તે કૉલ
ઇતિહાસમાં end_reason
inbound_config_webhook_failed સાથે નિષ્ફળ, બિલ ન કરાયેલ કૉલ તરીકે દેખાય છે, અને સામાન્ય
telephony.complete ઇવેન્ટ મોકલવામાં આવે છે. ડેશબોર્ડમાં કૉલનું
પૃષ્ઠ અને GET /v1/calls/{call_id}માં config_webhook_failure
તમારા વેબહુકે શું કર્યું તે દર્શાવે છે: {kind, attempts, http_status, host, source}, જેમાં kind હોઈ શકે છે
http_error, timeout, connection, dns, tls, response_too_large,
blocked_url, other, invalid_json, non_object_json અથવા
invalid_config, host એ તમારા વેબહુકનું હોસ્ટ નામ છે, અને source એ
number (આ વેબહુક) અથવા agent_setup (એજન્ટનો કૉલ સેટઅપ વેબહુક) છે.
invalid_config માટે, reason જણાવે છે કે જવાબનો ઉપયોગ કેમ થઈ શક્યો નહીં અને
fields તે સંબંધિત ફીલ્ડનાં નામ આપે છે: no_agent (ન તો agent_id ન તો
prompt; fields અવગણવામાં આવેલી કીઝની સૂચિ આપે છે, જેમ કે ખોટી જોડણીવાળું
agentId), agent_not_found, agent_id_not_integer, unexpected_fields
(agent_idની સાથે variables, context, timezone અને language સિવાયની
કીઝ), invalid_variables, invalid_context, invalid_language,
unsupported_language, invalid_config_fields અથવા agent_settings_invalid.
અન્યથા reason null હોય છે અને fields ખાલી હોય છે. એકમાત્ર
અપવાદ એ છે કે જ્યારે એક્સચેન્જ પોતે નિષ્ફળ ગયું હોય ત્યારે કૉલર તમારા આઉટબાઉન્ડ કૉલમાંથી કોઈ એકનો જવાબ આપે: કૉલબૅક્સ જુઓ.
વિજેટ સેશન (web.incoming) ને વધુમાં વધુ 10 સેકન્ડનો એક જ પ્રયાસ મળે છે.
જો તે નિષ્ફળ જાય, તો સેશન વિનંતી 502 અથવા 422 સાથે નિષ્ફળ જાય છે.
વિનંતી પેલોડ
ફોન કૉલ માટે (telephony.incoming):
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}| ફીલ્ડ | પ્રકાર | વર્ણન |
|---|---|---|
call_id | પૂર્ણાંક | કૉલ આઈડી — આ કૉલ માટેની તમામ ઇવેન્ટ્સમાં સ્થિર |
from_number | સ્ટ્રિંગ | E.164 કૉલર નંબર |
to_number | સ્ટ્રિંગ | E.164 ગંતવ્ય (તમારા ThunderPhone નંબરોમાંથી એક) |
returning_call | ઑબ્જેક્ટ | આ નંબરએ છેલ્લા 30 દિવસમાં કૉલરને કૉલ કર્યો હોય ત્યારે જ હાજર. કૉલબૅક્સ જુઓ |
sip_headers | ઑબ્જેક્ટ | X-* અથવા User-to-User SIP હેડર્સ સાથે મેન્યુઅલ SIP કનેક્શન પર કૉલ આવ્યો હોય ત્યારે જ હાજર: નાના અક્ષરોમાં હેડરનું નામ → મૂલ્ય. SIP હેડર્સ જુઓ |
વેબ વિજેટ સત્રો માટે (web.incoming), data ફોન નંબરોના બદલે
એમ્બેડિંગ પેજને ઓળખે છે:
{
"type": "web.incoming",
"data": {
"call_id": 987654322,
"origin_domain": "https://example.com",
"publishable_key_prefix": "pk_live_a1b2"
}
}| ફીલ્ડ | પ્રકાર | વર્ણન |
|---|---|---|
call_id | પૂર્ણાંક | કૉલ ID |
origin_domain | સ્ટ્રિંગ | બ્રાઉઝરે મોકલ્યો હોય તે મુજબ, વિજેટ હોસ્ટ કરતા પેજનો ઓરિજિન. બિન-બ્રાઉઝર ક્લાયન્ટ કોઈપણ મૂલ્ય મોકલી શકે છે, તેથી તેને વિનંતી ક્યાંથી આવી તેનો પુરાવો માનશો નહીં |
publishable_key_prefix | સ્ટ્રિંગ | સત્ર ખોલનાર publishable key ના પ્રારંભિક અક્ષરો |
language, primary_language | સ્ટ્રિંગ | વિજેટ સત્રે ભાષા ઓવરરાઇડની વિનંતી કરી હોય ત્યારે હાજર |
voice | સ્ટ્રિંગ | વિજેટ સત્રે વૉઇસ ઓવરરાઇડની વિનંતી કરી હોય ત્યારે હાજર |
website_context | સ્ટ્રિંગ | વિજેટે પ્રતિ-સત્ર પેજ સંદર્ભ મોકલ્યો હોય ત્યારે હાજર |
ઓવરરાઇડ ફીલ્ડ્સ (language, voice, website_context, અને કોઈપણ
બ્રાઉઝર variables) માત્ર ત્યારે જ આવે છે જ્યારે publishable key તેના
browser overrides માં તેમની મંજૂરી આપે છે. કી જેની મંજૂરી આપતી નથી એવો કોઈ ઓવરરાઇડ ધરાવતી સત્ર વિનંતી આ વેબહૂક કૉલ થાય તે પહેલાં નકારી દેવામાં આવે છે.
પ્રતિસાદ સ્કીમા
આ કૉલ માટે એજન્ટ કન્ફિગરેશનનું વર્ણન કરતું JSON ઑબ્જેક્ટ પરત કરો.
prompt અને voice આવશ્યક છે; બાકીનું બધું વૈકલ્પિક છે.
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}| ક્ષેત્ર | પ્રકાર | જરૂરી | વર્ણન |
|---|---|---|---|
prompt | સ્ટ્રિંગ | હા | એજન્ટને ચલાવતો સિસ્ટમ prompt |
voice | સ્ટ્રિંગ | હા | GET /v1/voices માંથી વૉઇસ ID, ઉદાહરણ તરીકે john. voice_name ઉપનામ તરીકે સ્વીકારવામાં આવે છે. અજાણ્યા વૉઇસ માન્યતા નિષ્ફળ બનાવે છે અને કૉલ નકારે છે |
product | સ્ટ્રિંગ | ના | bolt મોકલો. મૂળભૂત spark છે, જે જૂનું મૂલ્ય હોવા છતાં storm-base, storm-base-with-ack, storm-extra અને storm-extra-with-ack સાથે હજુ સ્વીકારવામાં આવે છે |
thinking_level | સ્ટ્રિંગ | ના | minimal, base (મૂળભૂત), અથવા extra. જૂના storm-* પ્રોડક્ટ મૂલ્યોમાં, storm-extra* extra ફરજિયાત કરે છે અને અન્ય storm-* base ફરજિયાત કરે છે |
audio_context_mode | સ્ટ્રિંગ | ના | full (મૂળભૂત) અથવા reduced |
watchdog_enabled | બુલિયન | ના | આ કૉલ માટે દેખરેખ સક્ષમ કરો. મૂળભૂત false |
additional_audio_context | બુલિયન | null | ના | માત્ર સૌથી તાજેતરના વળાંકને બદલે કૉલર ઑડિયોના છેલ્લા થોડા વળાંક શામેલ કરો, જેથી નાની વિલંબ/ખર્ચ વધારાની કિંમતે સુધારાઓ અને જોડણી/નંબર-પ્રધાન ડેટા સંગ્રહ સુધરે. ઇનબાઉન્ડ સત્રો માટે મૂળભૂત રીતે ચાલુ અને આઉટબાઉન્ડ ફોન કૉલ્સ માટે બંધ છે; null મૂળભૂત જાળવે છે |
storm_feedback_mode | સ્ટ્રિંગ | ના | none, acknowledgement (મૂળભૂત), અથવા tick: જ્યારે audio_tier plus અથવા max હોય ત્યારે ધીમો જવાબ તૈયાર થતો હોય તે દરમિયાન કૉલર શું સાંભળે છે |
language | સ્ટ્રિંગ | ના | primary_language માટે સંક્ષિપ્ત સ્વરૂપ. agent_id ની બાજુમાં પણ માન્ય છે, જ્યાં તે આ કૉલ જે ભાષામાં શરૂ થાય છે તે ભાષા છે અને તેના માટે એજન્ટના વૉઇસમાં બોલાય છે; દરેક કૉલ માટે ભાષા સેટ કરો જુઓ |
primary_language | સ્ટ્રિંગ | ના | ભાષા કોડ, સામાન્યકૃત (મૂળભૂત en). ઉકેલી ન શકાય તેવા કોડ કૉલ નકારે છે |
has_additional_languages | બુલિયન | ના | મૂળભૂત false |
additional_languages | સ્ટ્રિંગનો એરે | ના | એજન્ટ જે વધારાની ભાષાઓમાં બદલી શકે છે |
native_voice_switching | બુલિયન | ના | મૂળભૂત false. કૉલ બીજી ભાષામાં બદલાય ત્યારે, રૂપરેખાંકિત વૉઇસ જાળવવાને બદલે તે ભાષાના મૂળ વક્તાનો વૉઇસ (લિંગ મુજબ મેળ ખાતો) અપનાવો |
language_switching | સ્ટ્રિંગ | null | ના | ask_first (મૂળભૂત) અથવા follow_caller; null એ ask_first જેવું જ છે. બહુભાષી એજન્ટ તેની અન્ય ભાષાઓમાંથી કોઈ એકમાં અન્ય વ્યક્તિ બોલે ત્યારે કેવી રીતે વર્તે છે. તેઓ ભાષા માંગે અથવા તેમાં સંપૂર્ણ વાક્ય બોલે ત્યારે ask_first તરત બદલે છે, અને "હા" જેવી ટૂંકી વાત પછી તેમાં ચાલુ રાખવું કે નહીં તે પૂછે છે. follow_caller તેઓ બોલે તે કોઈપણ રૂપરેખાંકિત ભાષામાં બદલે છે, એક શબ્દ માટે પણ. ફક્ત additional_languages સેટ હોય ત્યારે લાગુ પડે છે |
audio_tier | સ્ટ્રિંગ | null | ના | ફક્ત product: "bolt". સાંભળવાની ગુણવત્તા: એજન્ટ કૉલરને કેટલી કાળજીપૂર્વક સાંભળે છે. standard (મૂળભૂત; "" અને null નો એક જ અર્થ છે) મોટાભાગના કૉલ્સ માટે યોગ્ય છે (PHI પ્રક્રિયા કરતા કૉલ્સ ફક્ત BAA-આવરી લેવાયેલા પ્રદાતાઓનો ઉપયોગ કરે છે). lite સૌથી સસ્તું છે અને વધુ વાર ખોટું સાંભળે છે. plus મુશ્કેલ વળાંકો પર વધુ ધ્યાનથી સાંભળે છે, જેમાં લગભગ 1–2 સેકંડ વધુ લાગે છે. max સૌથી મુશ્કેલ ઑડિયો અને દુર્લભ ભાષાઓ માટે છે; દરેક જવાબમાં 3–4 સેકંડ લાગે છે અને કૉલ pro ઇન્ટેલિજન્સ ચલાવે છે (intelligence અવગણવામાં આવે છે). max સામાન્ય રીતે ઉપલબ્ધ નથી: જે સંસ્થા માટે તે સક્ષમ નથી, તેના માટે કૉલ plus અને તમે જણાવેલ intelligence ચલાવે છે (તે સાથેની આઉટબાઉન્ડ કૉલ વિનંતી 400 સાથે નકારવામાં આવે છે). જૂના મૂલ્યો lean (લાઇટ), hearing (પ્લસ) અને deep_hearing (મેક્સ) હજુ સ્વીકારવામાં આવે છે. અન્ય પ્રોડક્ટ્સ તેને અવગણે છે |
endpointing | સ્ટ્રિંગ | null | ના | faster (200 ms), fast (300 ms), normal (500 ms, મૂળભૂત) અથવા patient (800 ms); null એ normal જેવું જ છે. કૉલર બોલવાનું બંધ કરે પછી જવાબ માટે મોડલને પૂછતાં પહેલાં Bolt v2 એજન્ટ કેટલો સમય રાહ જુએ છે. ઓછી રાહથી વહેલો જવાબ મળી શકે છે, પરંતુ કૉલરના પછીના શબ્દો જે વિનંતીઓને જૂની બનાવે છે એવી વધુ વિનંતીઓ મોકલાય છે, જે મોડલ ખર્ચ વધારે છે. અન્ય પ્રોડક્ટ્સ તેને અવગણે છે |
eagerness | સ્ટ્રિંગ | null | ના | નિવૃત્ત: 19 ઑક્ટોબર, 2026 સુધી endpointing નું નામ, હજુ વાંચવામાં આવે છે. endpointing સેટ હોય ત્યારે અવગણવામાં આવે છે |
intelligence | સ્ટ્રિંગ | null | ના | core અથવા pro (મૂળભૂત); null એ pro જેવું જ છે. Bolt v2 પાઇપલાઇન પરનો bolt એજન્ટ તેની સૂચનાઓને કેટલી વિશ્વસનીયતાથી અનુસરે છે. core પહેલા શબ્દ સુધી ~700 ms લે છે, સૌથી સસ્તું અને થોડું ઓછું વિશ્વસનીય છે (PHI તરીકે ગણાતા કૉલ્સમાં ~900 ms અને ઓછું વિશ્વસનીય); pro ~900 ms છે; ફક્ત ટૂલ કૉલ કરતા Core જવાબો Pro ને સોંપવામાં આવે છે. જૂના મૂલ્યો lite (કોર) અને standard (પ્રો) હજુ સ્વીકારવામાં આવે છે, અને નિવૃત્ત plus અને max pro પર ચાલે છે. audio_tier max હોય ત્યારે અવગણવામાં આવે છે. અન્ય પ્રોડક્ટ્સ તેને અવગણે છે |
faster_replies | બુલિયન | null | ના | ઝડપ વધારો. મૂળભૂત true. Bolt v2 પાઇપલાઇન પરના bolt એજન્ટમાં જવાબો થોડા વધુ ખર્ચે થોડા વહેલા શરૂ થાય છે. false તેને બંધ કરે છે. અન્ય પ્રોડક્ટ્સ તેને અવગણે છે |
background_track | સ્ટ્રિંગ | null | ના | આસપાસના ઑડિયોનો ID અથવા null |
acknowledgement_prompt_mode | સ્ટ્રિંગ | ના | auto (મૂળભૂત) અથવા manual (જૂના -with-ack પ્રોડક્ટ મૂલ્યો) |
acknowledgement_prompt | સ્ટ્રિંગ | ના | acknowledgement_prompt_mode="manual" હોય ત્યારે વપરાય છે |
silence_interval_seconds | પૂર્ણાંક | null | ના | 5–120. ચેક-ઇન પહેલાં કૉલરની મૌનાવસ્થાની સેકંડ |
silence_max_checkins | પૂર્ણાંક | null | ના | 1–10 |
silence_checkins_enabled | બુલિયન | ના | મૂળભૂત true |
silence_final_action | સ્ટ્રિંગ | ના | છેલ્લા ચેક-ઇન પછી: hang_up (મૂળભૂત) અથવા silence_transfer_destination પર transfer |
silence_transfer_destination | સ્ટ્રિંગ | ના | આ રૂપરેખાંકનના transfer_destinations માંની એન્ટ્રીનું નામ; transfer સાથે આવશ્યક. transfer_destinations વિના ટ્રાન્સફર કરી શકાતું નથી અને એજન્ટ કૉલ બંધ કરે છે |
silence_final_message | સ્ટ્રિંગ | ના | ≤ 300 અક્ષરો, જેમ લખેલું હોય તેમ વાંચવામાં આવે છે; "" (મૂળભૂત) મૂળભૂત પંક્તિ વાપરે છે |
connect_tone_enabled | બુલિયન | ના | મૂળભૂત false |
pronunciation_dicts | બુલિયન | null | ના | મૂળભૂત false; null એ false જેવું જ છે. true હોય ત્યારે, કૉલનું Cartesia ભાષણ કૉલની ભાષા માટે ઉપલબ્ધ હોય ત્યાં ThunderPhone નો ઉચ્ચાર શબ્દકોશ વાપરે છે. ફોન અને વિજેટ કૉલ્સ માટે કાર્ય કરે છે. ફક્ત ThunderPhone ના પોતાના Cartesia વૉઇસ માટે લાગુ પડે છે, તમારી પોતાની Cartesia API કી પરના વૉઇસ માટે નહીં. agent_id સાથે ઉપયોગ થતો નથી, જ્યાં સાચવેલા એજન્ટની સેટિંગ્સ લાગુ પડે છે |
words | એરે | null | ના | એજન્ટ ચોક્કસ શબ્દો કેવી રીતે બોલે છે, support સિવાય એજન્ટના words જેવી જ એન્ટ્રીઓ. language વિનાની એન્ટ્રી આ રૂપરેખાંકનની ભાષા અપનાવે છે. null અને [] નો અર્થ કોઈ નથી. agent_id સાથે ઉપયોગ થતો નથી, જ્યાં સાચવેલા એજન્ટના શબ્દો લાગુ પડે છે |
voicemail_action | સ્ટ્રિંગ | ના | prompt (મૂળભૂત), hangup, અથવા message |
voicemail_message | સ્ટ્રિંગ | ના | voicemail_action="message" હોય ત્યારે વપરાય છે |
agent_name | સ્ટ્રિંગ | ના | ડેશબોર્ડ અને વિજેટને જણાવાતું પ્રદર્શન નામ |
org_name | સ્ટ્રિંગ | ના | એજન્ટના વ્યક્તિત્વ માટે સંસ્થાનું પ્રદર્શન નામ |
tools | એરે | ના | ઇનલાઇન ફંક્શન-ટૂલ સ્કીમા (ફંક્શન ટૂલ્સ જુઓ) |
transfer_destinations | ઑબ્જેક્ટનો એરે | null | ના | આ કૉલ જે મહત્તમ 50 {name, number} એન્ટ્રીઓ પર ટ્રાન્સફર કરી શકે છે, જે એજન્ટના ટ્રાન્સફર નંબરો જેવી રીતે માન્ય કરાય છે. એજન્ટ નામ દ્વારા અને ફક્ત આ પર જ ટ્રાન્સફર કરે છે; [] નો અર્થ કોઈ ટ્રાન્સફર નથી. એજન્ટને તે પસંદ કરેલા નંબરે ટ્રાન્સફર કરવા દેવા માટે તેને છોડો અથવા null મોકલો |
timezone | સ્ટ્રિંગ | ના | આ કૉલ માટે IANA સમય ઝોન, જેમ કે America/Chicago. એજન્ટ પોતાના સમય ઝોન કરતાં આમાં તારીખ અને સમય જણાવે છે. agent_id ની બાજુમાં પણ માન્ય છે. IANA ઝોન ન હોય તેવા મૂલ્યો અવગણવામાં આવે છે. દરેક કૉલ માટે સમય ઝોન સેટ કરો જુઓ |
context | સ્ટ્રિંગ | null | ના | આ કૉલ માટે મુક્ત-સ્વરૂપ લખાણ, જેમ કે તમારી સિસ્ટમે એકત્રિત કરેલી નોંધો, મહત્તમ 20,000 અક્ષરો. prompt પછી સીમાંકિત બ્લોકમાં ઉમેરવામાં આવે છે અને ટેમ્પલેટ તરીકે રેન્ડર થતું નથી. agent_id ની બાજુમાં પણ માન્ય છે. સ્ટ્રિંગ ન હોય, અથવા વધુ લાંબું હોય એવું મૂલ્ય કૉલ નકારે છે. કૉલ વેરિએબલ્સ અને સંદર્ભ જુઓ |
call_id | પૂર્ણાંક | ના | વિનંતીના કૉલ ID નો વૈકલ્પિક ઇકો; અવગણવામાં આવે છે |
prompt અને voice જરૂરી હોવાથી, {} અથવા માન્યતા ચકાસણીમાં નિષ્ફળ જતો કોઈપણ પ્રતિસાદ પરત કરવાથી કૉલ નકારવામાં આવે છે: સમયસમાપ્તિ અને ફરી પ્રયાસોમાં વર્ણવ્યા મુજબ ફોન કૉલ સમાપ્ત થાય છે અને વિજેટ સત્રની વિનંતી 422 સાથે નિષ્ફળ જાય છે. આ પાછા કૉલ કરનારા માટે પણ લાગુ પડે છે: તમારું વેબહૂક જે કોઈ JSON ઑબ્જેક્ટ પરત કરે છે તે તેનો જવાબ છે, અને {} કૉલ નકારવાનો માર્ગ છે.
એજન્ટ કૉલ સેટઅપ વેબહૂક
એજન્ટનો પોતાનો કૉલ સેટઅપ વેબહૂક હોઈ શકે છે: તેની સેટિંગ્સમાં કૉલ સેટઅપ વેબહૂક
ફીલ્ડ, અથવા APIમાં call_setup_webhook_url।
એજન્ટને નંબર પર સોંપો, અને એજન્ટ જે તે નંબર પરની દરેક ઇનબાઉન્ડ કૉલનો જવાબ આપે તે પહેલાં,
ThunderPhone તે કૉલના વેરિએબલ્સ અને સંદર્ભ માટે વેબહૂકને પૂછે છે. નંબર પોતાનો એજન્ટ જાળવી રાખે છે,
તેથી ફોન નંબરોનું પેજ અને એજન્ટનું પેજ દર્શાવે છે કે તેનો જવાબ કયો એજન્ટ આપે છે.
આ એજન્ટની અન્ય સેટિંગ્સ જેવી જ સેટિંગ છે: ડ્રાફ્ટ તરીકે સ્ટેજ કરવામાં આવે છે, ડિપ્લૉય પર પ્રકાશિત
થાય છે અને વર્ઝન ઇતિહાસમાં રાખવામાં આવે છે. કોઈ નંબર જે
જૂના વર્ઝન પર પિન કરાયેલ હોય
તે વર્ઝનનો URL પૂછે છે. વિનંતીઓ પર એજન્ટના પોતાના
call_setup_webhook_signing_secret દ્વારા સહી થાય છે (સંસ્થાના વેબહૂક
સિક્રેટથી નહીં), અને ઉપર મુજબ એ જ X-ThunderPhone-Signature હેડર,
સમયસમાપ્તિ, ફરી પ્રયાસ અને આઇડેમ્પોટન્સી કીનો ઉપયોગ થાય છે. સિક્રેટ ફક્ત લખવા માટે છે:
તમારું એન્ડપોઇન્ટ તપાસે તેવો સિક્રેટ સેટ કરો (એજન્ટની સેટિંગ્સમાં અથવા
PATCH /v1/agents/{id} સાથે); કોઈ પણ રીડ તેને પરત કરતું નથી, અને
call_setup_webhook_signing_secret_set જણાવે છે કે કોઈ સેટ છે કે નહીં.
વિનંતી ઉપરના telephony.incoming પેલોડ સાથે તેમાં ભરવામાં આવતા એજન્ટની છે:
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567",
"variables": null,
"agent": {
"id": 12,
"name": "Front desk",
"version": 7,
"version_pinned": false
}
}
}| ફીલ્ડ | પ્રકાર | વર્ણન |
|---|---|---|
agent.id | પૂર્ણાંક | નંબર પર સોંપાયેલ એજન્ટ |
agent.name | સ્ટ્રિંગ | તેનું નામ |
agent.version | પૂર્ણાંક | null | જવાબ આપનારા વર્ઝનનો નંબર: નંબરનું પિન કરાયેલ વર્ઝન, નહીં તો એજન્ટનું સૌથી તાજેતરનું પ્રકાશિત વર્ઝન (તેનું કોઈ ન હોય તો null) |
agent.version_pinned | બૂલિયન | નંબર તે વર્ઝન પર પિન થયેલ છે કે નહીં |
કૉલને જે જરૂરી હોય તે સાથે જવાબ આપો. આમાંથી કોઈપણ નંબરના વર્ઝન પર સોંપાયેલ એજન્ટને ભરી દે છે:
{"variables": {...}},{"context": "..."}, અથવા બંને- સોંપાયેલ એજન્ટના id પર
"agent_id"સેટ કરીને એ જ {}: એજન્ટ કંઈપણ ભર્યા વિના જવાબ આપે છે
agent_id ની બાજુમાં હોય તેમ timezone અને language
પણ માન્ય છે. વેરિએબલ્સ એજન્ટના {{placeholders}} ભરે છે; સંદર્ભ prompt પછી ઉમેરવામાં આવે છે.
અથવા કૉલનો નિર્ણય તમે જાતે લો. બીજા એજન્ટનો agent_id, અથવા prompt સાથેનું
સંપૂર્ણ કૉન્ફિગરેશન, સોંપાયેલ એજન્ટ (અને તેના પિન કરાયેલા વર્ઝન)ને બદલે આ એક કૉલનો જવાબ આપે છે.
કૉલ વિગતો દરેક કિસને call_setup_webhookમાં લેબલ કરે છે:
assigned_agent, other_agent અથવા inline_config. જે જવાબનો ઉપયોગ ન થઈ શકે
(અજાણ્યો agent_id, variablesની બાજુમાં અન્ય કીઝ, વેલિડેશનમાં નિષ્ફળ થતું કૉન્ફિગરેશન)
તે નંબરના વેબહૂકની જેમ કૉલ સમાપ્ત કરે છે.
વેબહૂકે ક્યારે જવાબ આપવો જરૂરી છે. એજન્ટને તેના વેબહૂકની જરૂર પડે છે જ્યારે તેની
સેટિંગ્સમાં ડિફૉલ્ટ વિનાનું {{variable}} વપરાય છે: તેનો prompt અથવા ફરી વાપરી શકાય તેવી
સૂચનાઓ, સ્ટેપ સૂચનાઓ અથવા લાઇન્સ, સ્વીકૃતિ prompt, વૉઇસમેઇલ સંદેશ, સંમતિ જાહેરાત,
અથવા ટ્રાન્સફર નંબર તરીકેનું {{variable}}. એજન્ટના call_setup_webhook_variables તેમની યાદી આપે છે.
- તેને વેબહૂકની જરૂર છે: જ્યારે વેબહૂકનો સમય સમાપ્ત થાય, તેના સુધી પહોંચી ન શકાય,
અથવા તે એરર સાથે જવાબ આપે અથવા JSON ઑબ્જેક્ટ ન હોય એવું બોડી આપે, ત્યારે કૉલ શરૂ થતો નથી,
ભલે કૉલમાં તેમાંથી કોઈ એક વેરિએબલ માટે પહેલેથી મૂલ્ય હોય. તે સમાપ્ત થાય છે અને
સમયસમાપ્તિ અને ફરી પ્રયાસોમાં વર્ણવ્યા મુજબ ચોક્કસ રીતે નોંધાય છે (
end_reasoninbound_config_webhook_failed, બિલ ન કરવામાં આવેલ). - તેને કંઈ જ જરૂરી નથી (કોઈ વેરિએબલ્સ નથી, અથવા દરેકમાં
{{first_name|there}}જેવું ડિફૉલ્ટ છે): વેબહૂક હજી પણ ચાલે છે, પરંતુ તે નિષ્ફળ જાય ત્યારે એજન્ટ તેના વિના જવાબ આપે છે, અને કૉલ વિગતો શું ખોટું થયું તે સાથેwebhook_failedદર્શાવે છે.
માત્ર કોલ કોન્ટેક્સ્ટ વેબહૂકને ક્યારેય આવશ્યક બનાવતું નથી: એજન્ટની સેટિંગ્સમાં એવું કંઈ નથી જે કહે કે તેને કોન્ટેક્સ્ટની જરૂર છે. જો તમારા વેબહૂકના જવાબ વિના કોલ શરૂ ન થવો જોઈએ, તો ડિફૉલ્ટ વિનાનો વેરિઅબલ વાપરો.
સોંપણી અને ડિપ્લોયમેન્ટ. જે એજન્ટને તેના વેબહૂકની જરૂર હોય તેને વેબહૂક વિનાના નંબરને સોંપી શકાતો નથી: વેરિઅબલોનાં નામ ધરાવતા સંદેશ સાથે સોંપણી નકારવામાં આવે છે. નંબરનું વર્ઝન બદલાય ત્યારે પણ આ જ તપાસ થાય છે, જેમાં પિન કરાયેલો નંબર ફરી નવીનતમ પર જતો હોય તે પણ સામેલ છે. એજન્ટ તેની
પ્રકાશિત સેટિંગ્સ સાથે નંબરનો જવાબ આપતો હોય ત્યારે, વેબહૂક વિનાનો આવો વેરિઅબલ ઉમેરતો ડિપ્લોયમેન્ટ
(અથવા વેબહૂક દૂર કરતો ડિપ્લોયમેન્ટ) એ જ રીતે નકારવામાં આવે છે. ડ્રાફ્ટ સાચવવાની હંમેશા મંજૂરી છે, અને એજન્ટની warningsમાં
સમસ્યા ઉકેલાય ત્યાં સુધી call_setup_webhook_needed રહે છે.
એજન્ટનો વેબહૂક ફક્ત તેને સોંપાયેલા નંબરો પર આવતા ફોન કોલ્સ માટે ચાલે છે. આઉટબાઉન્ડ કોલ્સ, વેબ વિજેટ સત્રો, SIP સરનામાંઓ, સિમ્યુલેશન્સ અને ડેશબોર્ડ પરીક્ષણ વાતચીતો તેને કૉલ કરતી નથી; તેઓ પહેલાની જેમ વિનંતીમાંથી તેમના વેરિઅબલ્સ લે છે.
સાચવેલા નમૂનાઓ સાથે પરીક્ષણ. ચોક્કસ જવાબ સાથે તમારો એજન્ટ શું કરે છે તેનું પરીક્ષણ કરવા માટે
(ફરીથી કૉલ કરનાર, કોઈ રેકોર્ડ ન મળ્યો હોય, સ્પેનિશ બોલનાર), તે જવાબને એજન્ટ પર નમૂના તરીકે સાચવો: તેના variables, context
અને વૈકલ્પિક રીતે language, જાતે ટાઇપ કરીને અથવા ભૂતકાળના કૉલમાંથી કૉપિ કરીને. જ્યારે તમે ડેશબોર્ડ પરીક્ષણ વાતચીત, તમારા ફોન પર પરીક્ષણ કૉલ
અથવા એજન્ટ સામે સિમ્યુલેશન શરૂ કરો ત્યારે તેને પસંદ કરો, અને કૉલ એ રીતે ચાલશે જાણે તમારા webhookએ તે જવાબ આપ્યો હોય. નમૂનાઓ એજન્ટના દરેક વર્ઝન દ્વારા શેર થાય છે.
એકમાં ફેરફાર કરવાથી તેના પહેલાનાં વર્ઝન જળવાઈ રહે છે: જ્યારે એજન્ટમાં ફેરફાર માટે એવો variable જરૂરી હોય જે નમૂનો સેટ કરતો નથી, ત્યારે તેને નમૂનામાં ઉમેરો, અને જૂના એજન્ટ
વર્ઝન નમૂનાનો પહેલાની જેમ ઉપયોગ કરતા રહેશે. ફોન નંબર ડાયલ કરતા સિમ્યુલેશનો તેના બદલે તમારો વાસ્તવિક webhook ચલાવે છે.
જે નંબરોને કોઈ એજન્ટ સોંપાયેલો નથી તેઓ ઉપર મુજબ નંબરના અથવા સંસ્થાના વેબહૂકનો ઉપયોગ ચાલુ રાખે છે.
કૉલબૅક્સ
લોકો ઘણી વાર તેમને કૉલ કરનાર નંબર પર પાછો કૉલ કરે છે, ઉદાહરણ તરીકે તમારા એજન્ટે વૉઇસમેઇલ છોડ્યો હોય પછી. જ્યારે છેલ્લા 30 દિવસમાં એ જ નંબર પર કૉલ કરવામાં આવ્યો હોય તેવી કોઈ વ્યક્તિનો ફોન કૉલ આવે છે, ThunderPhone આવો સૌથી તાજેતરનો આઉટબાઉન્ડ કૉલ શોધે છે (જેમાં તેમના ફોન પર રિંગ વાગી હતી) અને તેનો ત્રણ રીતે ઉપયોગ કરે છે:
-
વિનંતીમાં
returning_call. ઉપરોક્ત અવરોધક વિનંતી અને એન્ડપૉઇન્ટ સૂચના, તેને ધરાવે છે, જેથી તમારું હૅન્ડલર કૉલરને રૂટ કરી શકે:{ "type": "telephony.incoming", "data": { "call_id": 987654321, "from_number": "+14155550199", "to_number": "+15551234567", "returning_call": { "call_id": 987650001, "agent_id": 13, "started_at": "2026-10-21T19:05:12.402Z", "outcome": "voicemail" } } }ફીલ્ડ પ્રકાર વર્ણન call_idપૂર્ણાંક અગાઉનો આઉટબાઉન્ડ કૉલ agent_idપૂર્ણાંક | null કૉલ કરનાર એજન્ટ; ઇનલાઇન કૉન્ફિગ સાથે કરવામાં આવેલા કૉલ માટે અથવા જેનો એજન્ટ કાઢી નાખવામાં આવ્યો હોય તેવા કૉલ માટે nullstarted_atસ્ટ્રિંગ તે ક્યારે શરૂ થયો હતો (ISO 8601, UTC) outcomeસ્ટ્રિંગ no_answer(રિંગ પૂર્ણ થઈ ગઈ, વ્યસ્ત હતું અથવા નકારવામાં આવ્યો હતો),voicemail(વૉઇસમેઇલનો જવાબ મળ્યો અથવા કોઈએ એજન્ટ સાથે વાત કરી નહીં),conversation(કોઈએ એજન્ટ સાથે વાત કરી) અથવાanswered(કૉલ ઉપાડવામાં આવ્યો; કોણે જવાબ આપ્યો તે હજુ જાણીતું નથી) -
એજન્ટ માટેની પૃષ્ઠભૂમિ. જે એજન્ટ જવાબ આપે છે તેને તેના prompt ના અંતે ટૂંકી નોંધ મળે છે: અગાઉનો કૉલ ક્યારે કરવામાં આવ્યો હતો, કયા એજન્ટ દ્વારા અને તેનું પરિણામ. એજન્ટને તે મોટેથી ન વાંચવાનું કહેવામાં આવે છે અને, કૉલર ID બનાવટી હોઈ શકે છે તેથી, અગાઉ નંબર પર કૉલ કરવામાં આવ્યો હતો તે સિવાય તે કૉલ વિશે કંઈપણ શેર ન કરવાનું કહેવામાં આવે છે.
-
ફૉલબૅક એજન્ટ. જ્યારે નંબરમાં કોઈ ઇનબાઉન્ડ એજન્ટ ન હોય અને કોઈ વેબહૂક URL ન હોવાને કારણે અથવા તમારા વેબહૂકે જવાબ ન આપ્યો હોવાને કારણે કોઈ કૉન્ફિગ્યુરેશન ન આવે (તે સમયસમાપ્તિ પામ્યું, પહોંચી શકાયું નહીં, અથવા બંને પ્રયાસોમાં
5xx,408અથવા429જવાબ આપ્યો), ત્યારે કૉલ સમાપ્ત થવાને બદલે અગાઉનો કૉલ કરનાર એજન્ટ પાસે જાય છે, જો તે એજન્ટ હજી પણ તમારા સંગઠનમાં અસ્તિત્વમાં હોય. તે એજન્ટની ડિપ્લોય કરેલી સેટિંગ્સ સાથે ચાલે છે. તમારું વેબહૂક જે પણ જવાબ આપે તે હજુ પણ નિર્ણય કરે છે: બીજું4xx, JSON ઑબ્જેક્ટ ન હોય તેવું બૉડી,{}, અથવા માન્યતા ચકાસણીમાં નિષ્ફળ જતો કૉન્ફિગ પહેલાની જેમ કૉલ સમાપ્ત કરે છે. નંબર પરનો ઇનબાઉન્ડ એજન્ટ હંમેશા જવાબ આપે છે.
અગાઉના કૉલની વિગતો શેર કરવી. કૉલર ID બનાવટી હોઈ શકે છે, તેથી
ડિફૉલ્ટ રૂપે અગાઉના કૉલની સામગ્રીમાંથી કંઈપણ નવા કૉલ સુધી પહોંચતું
નથી. સંગઠનનો એડમિન સંગઠન → સામાન્ય → કૉલબૅક્સ હેઠળ અગાઉના કૉલની વિગતો શેર કરો
ચાલુ કરી શકે છે (અથવા
callback_context_details_enabled સેટ કરી શકે છે).
તે ચાલુ હોય ત્યારે, એજન્ટની નોંધ અગાઉના કૉલનો સારાંશ પણ ઉદ્ધૃત કરે છે,
અને અગાઉનો કૉલ કરનાર એજન્ટ તરફ રૂટ કરાયેલ કૉલ તે કૉલના variables
(જેમ કે સંપર્કનું નામ) સાથે ચાલે છે. આ વિગતો તે નંબર પરથી કૉલ કરનાર
કોઈપણ વ્યક્તિ સાથે શેર કરવી સુરક્ષિત હોય તો જ તેને ચાલુ કરો. તે ચાલુ
હોય તો પણ, સુરક્ષિત આરોગ્ય માહિતી ધરાવતો હોઈ શકે એવો કૉલ તેનો સારાંશ
અથવા variables એવા કૉલને ક્યારેય આપતો નથી જે PHI પ્રક્રિયા કરવા માટે
નિયુક્ત ન હોય.
કૉલ વિગતોમાં. અગાઉના કૉલ સાથે મેળ ખાતા ઇનબાઉન્ડ કૉલમાં GET /v1/calls/{call_id} માં
callback ઑબ્જેક્ટ હોય છે:
ઉપરનું returning_call, routed_as_callback (ફૉલબૅકે તેનો જવાબ આપ્યો હતો કે નહીં),
અને config_webhook_failure (જ્યારે તમારા વેબહુકે કોઈ જવાબ ન આપ્યો હોય અને ફૉલબૅકે
કૉલ લીધો હોય ત્યારે {kind, attempts, http_status, host}, અન્યથા null), જેથી
કૉલનો જવાબ આપવામાં આવ્યો હોય તો પણ વેબહુકમાં ખામી દેખાતી રહે છે.
પ્રતિસાદ કદ મર્યાદા
ઉદાહરણ હેન્ડલર
import hashlib
import hmac
import json
import os
from fastapi import FastAPI, HTTPException, Request
app = FastAPI()
WEBHOOK_SECRET = os.environ["THUNDERPHONE_WEBHOOK_SECRET"]
def verify(body: bytes, signature: str) -> bool:
expected = hmac.new(WEBHOOK_SECRET.encode(), body, hashlib.sha256).hexdigest()
return hmac.compare_digest(expected, signature or "")
@app.post("/thunderphone-webhook")
async def webhook(request: Request):
body = await request.body()
if not verify(body, request.headers.get("X-ThunderPhone-Signature", "")):
raise HTTPException(status_code=401)
event = json.loads(body)
if event["type"] == "telephony.incoming":
caller = event["data"]["from_number"]
prompt = (
"Greet the caller as a San Francisco local…"
if caller.startswith("+1415")
else "You are a friendly customer support agent…"
)
return {
"prompt": prompt,
"voice": "john",
"product": "spark",
}
if event["type"] == "web.incoming":
return {
"prompt": "You are the website's helpful voice assistant…",
"voice": "john",
"product": "spark",
}
return {}import crypto from "node:crypto";
import express from "express";
const app = express();
const SECRET = process.env.THUNDERPHONE_WEBHOOK_SECRET;
function verify(body, signature) {
const expected = crypto
.createHmac("sha256", SECRET)
.update(body)
.digest("hex");
return signature &&
crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature));
}
app.post(
"/thunderphone-webhook",
express.raw({ type: "application/json" }),
(req, res) => {
if (!verify(req.body, req.header("X-ThunderPhone-Signature"))) {
return res.sendStatus(401);
}
const event = JSON.parse(req.body.toString("utf8"));
if (event.type === "telephony.incoming" || event.type === "web.incoming") {
const caller = event.data.from_number || "web";
const prompt = caller.startsWith("+1415")
? "Greet the caller as a San Francisco local…"
: "You are a friendly customer support agent…";
return res.json({
prompt,
voice: "john",
product: "spark",
});
}
res.json({});
},
);ફંક્શન ટૂલ્સ સાથેનો પ્રતિસાદ
AI વાતચીત દરમિયાન તમારી API કૉલ કરી શકે તે માટે ટૂલ્સ જોડો:
{
"prompt": "You are a booking assistant. Use the available tools to help customers schedule appointments.",
"voice": "john",
"product": "spark",
"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": "your-key"
}
}
}
]
}સેટિંગ્સ ઝડપી સંદર્ભ
product: "bolt" મોકલો અને આ ક્ષેત્રો વડે કૉલને સુનિશ્ચિત કરો. જૂના
product મૂલ્યો (spark અને storm-* મૂલ્યો) હજુ પણ સ્વીકારવામાં આવે છે.
| ક્ષેત્ર | મૂલ્યો | તે શું સંતુલિત કરે છે |
|---|---|---|
intelligence | core, pro (ડિફૉલ્ટ) | Core સસ્તું છે અને વહેલા જવાબ આપવાનું શરૂ કરે છે; Pro લાંબા promptને વધુ વિશ્વસનીય રીતે અનુસરે છે |
audio_tier | lite, standard (ડિફૉલ્ટ), plus, max | ઉચ્ચ ટિયર્સ વધુ સારી રીતે સાંભળે છે અને વધુ ખર્ચાળ છે; Plus કેટલાક વારોમાં 1–2 સેકન્ડ ઉમેરે છે, દરેક Max જવાબમાં 3–4 સેકન્ડ લાગે છે (Max સામાન્ય રીતે ઉપલબ્ધ નથી) |
endpointing | faster, fast, normal (ડિફૉલ્ટ), patient | ઓછો રાહ સમય વહેલા જવાબ આપે છે અને વધુ ખર્ચાળ છે |
faster_replies | true (ડિફૉલ્ટ), false | ઝડપમાં વધારો: જવાબો થોડા વહેલા, થોડા વધુ ખર્ચે |
સંબંધિત
કૉલ સમાપ્ત થવાની નોન-બ્લોકિંગ ઇવેન્ટ.
tools[] માટે સંપૂર્ણ JSON સ્કીમા અને સહી કરેલ એન્ડપોઇન્ટ કરાર.
telephony.incoming / web.incoming માટે અનેક URLs સબ્સ્ક્રાઇબ કરો.
દરેક કૉલર માટેના prompts, ટૂલ્સ અને A/B પરીક્ષણો માટેની પેટર્ન્સ.