jaxl-python 0.0.52__tar.gz → 0.0.54__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (306) hide show
  1. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/.gitignore +1 -0
  2. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/PKG-INFO +203 -5
  3. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/README.md +201 -4
  4. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/README.md +13 -0
  5. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/_sdk.py +2 -0
  6. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/_scm_version.py +2 -2
  7. jaxl_python-0.0.52/jaxl/api/client/api/v1/v1_calls_transfer_create.py → jaxl_python-0.0.54/jaxl/api/client/api/v1/v1_calls_dtmf_create.py +23 -9
  8. jaxl_python-0.0.54/jaxl/api/client/api/v1/v1_calls_transfer_create.py +191 -0
  9. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/__init__.py +18 -0
  10. jaxl_python-0.0.54/jaxl/api/client/models/call_dtmf_request_request.py +67 -0
  11. jaxl_python-0.0.54/jaxl/api/client/models/call_transfer_rejected.py +95 -0
  12. jaxl_python-0.0.54/jaxl/api/client/models/call_transfer_rejected_errors.py +53 -0
  13. jaxl_python-0.0.54/jaxl/api/client/models/cashfree_checkout_auth_request_request.py +79 -0
  14. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/failure_reason_enum.py +4 -0
  15. jaxl_python-0.0.54/jaxl/api/client/models/go_kwik_checkout_auth_request_request.py +78 -0
  16. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/integrations_properties_request.py +112 -0
  17. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/integrations_request_provider_enum.py +3 -0
  18. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/patched_phone_number_update_request.py +44 -0
  19. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/phone_number.py +38 -0
  20. jaxl_python-0.0.54/jaxl/api/client/models/ringing_order_enum.py +18 -0
  21. jaxl_python-0.0.54/jaxl/api/client/models/shiprocket_delivery_auth_request_request.py +78 -0
  22. jaxl_python-0.0.54/jaxl/api/client/models/twilio_call_auth_request_request.py +74 -0
  23. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/apps.py +52 -0
  24. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/calls.py +33 -4
  25. jaxl_python-0.0.54/jaxl/api/resources/integrations.py +374 -0
  26. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl_python.egg-info/PKG-INFO +203 -5
  27. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl_python.egg-info/SOURCES.txt +12 -1
  28. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl_python.egg-info/requires.txt +1 -0
  29. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/setup.cfg +1 -0
  30. jaxl_python-0.0.54/tests/test_streaming_watchdog.py +74 -0
  31. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/.github/workflows/sdk.yml +0 -0
  32. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/.isort.cfg +0 -0
  33. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/.pylintrc +0 -0
  34. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/.vscode/settings.json +0 -0
  35. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/LICENSE.md +0 -0
  36. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/SPECIFICATION.md +0 -0
  37. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/calls_add_unset.patch +0 -0
  38. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/campaign_upload_request.patch +0 -0
  39. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/docs.sh +0 -0
  40. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/__init__.py +0 -0
  41. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/prompts/example.txt +0 -0
  42. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/py.typed +0 -0
  43. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/request_and_confirm_code_then_send_to_phone.py +0 -0
  44. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/request_code_and_send_to_phone.py +0 -0
  45. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/send_to_phone.py +0 -0
  46. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/streaming_aiagent.py +0 -0
  47. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/streaming_audio_chunks.py +0 -0
  48. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/streaming_speech_segments.py +0 -0
  49. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/streaming_transcriptions.py +0 -0
  50. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/examples/streaming_wav_file.py +0 -0
  51. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/index.md +0 -0
  52. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/ivr_options.patch +0 -0
  53. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/__init__.py +0 -0
  54. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/_client.py +0 -0
  55. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/base.py +0 -0
  56. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/cli.py +0 -0
  57. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/__init__.py +0 -0
  58. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/__init__.py +0 -0
  59. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/__init__.py +0 -0
  60. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_app_organizations_list.py +0 -0
  61. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_app_organizations_providers_list.py +0 -0
  62. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_appusers_me_retrieve.py +0 -0
  63. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_add_create.py +0 -0
  64. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_audio_retrieve.py +0 -0
  65. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_hangup_retrieve.py +0 -0
  66. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_list.py +0 -0
  67. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_messages_create.py +0 -0
  68. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_metadata_create.py +0 -0
  69. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_report_retrieve.py +0 -0
  70. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_reschedule_create.py +0 -0
  71. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_retrieve.py +0 -0
  72. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_schedule_create.py +0 -0
  73. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_schedule_destroy.py +0 -0
  74. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_tags_create.py +0 -0
  75. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_token_create.py +0 -0
  76. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_tts_create.py +0 -0
  77. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_calls_usage_retrieve.py +0 -0
  78. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_campaign_list.py +0 -0
  79. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_campaign_upload_create.py +0 -0
  80. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_customer_consumables_retrieve.py +0 -0
  81. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_devices_attest_create.py +0 -0
  82. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_devices_list.py +0 -0
  83. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_integrations_create.py +0 -0
  84. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_ivr_create.py +0 -0
  85. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_ivr_list.py +0 -0
  86. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_ivr_options_create.py +0 -0
  87. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_ivr_options_list.py +0 -0
  88. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_ivr_options_partial_update.py +0 -0
  89. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_kyc_list.py +0 -0
  90. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_messages_list.py +0 -0
  91. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_org_kb_create.py +0 -0
  92. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_phonenumbers_list.py +0 -0
  93. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_phonenumbers_partial_update.py +0 -0
  94. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v1/v1_phonenumbers_search_retrieve.py +0 -0
  95. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v2/__init__.py +0 -0
  96. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v2/v2_app_organizations_employees_list.py +0 -0
  97. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v2/v2_app_organizations_groups_list.py +0 -0
  98. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v3/__init__.py +0 -0
  99. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/api/v3/v3_orders_subscriptions_list.py +0 -0
  100. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/client.py +0 -0
  101. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/errors.py +0 -0
  102. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/address_provider.py +0 -0
  103. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/address_provider_status_enum.py +0 -0
  104. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/analytic.py +0 -0
  105. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/app_price.py +0 -0
  106. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/app_user.py +0 -0
  107. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/available_phone_number.py +0 -0
  108. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/available_phone_number_capabilities.py +0 -0
  109. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/available_phone_number_provider_enum.py +0 -0
  110. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call.py +0 -0
  111. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_add_request_request.py +0 -0
  112. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_audio_reason.py +0 -0
  113. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_cost.py +0 -0
  114. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_location_epoch.py +0 -0
  115. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_message_request_request.py +0 -0
  116. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_message_request_type_enum.py +0 -0
  117. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_metadata.py +0 -0
  118. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_report.py +0 -0
  119. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_report_reason.py +0 -0
  120. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_report_status_enum.py +0 -0
  121. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_reschedule_request.py +0 -0
  122. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_schedule_request.py +0 -0
  123. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_tag_request.py +0 -0
  124. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_tag_response.py +0 -0
  125. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_token_request.py +0 -0
  126. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_token_response.py +0 -0
  127. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_transfer_request_request.py +0 -0
  128. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_tts_request_request.py +0 -0
  129. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_type_enum.py +0 -0
  130. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_usage_by_currency_response.py +0 -0
  131. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_usage_response.py +0 -0
  132. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/call_usage_stats_response.py +0 -0
  133. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign.py +0 -0
  134. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_metadata.py +0 -0
  135. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_metadata_metadata.py +0 -0
  136. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_response.py +0 -0
  137. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_response_status_enum.py +0 -0
  138. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_stats.py +0 -0
  139. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_tag.py +0 -0
  140. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_upload_request.py +0 -0
  141. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_upload_request_options.py +0 -0
  142. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_upload_type_enum.py +0 -0
  143. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/campaign_window_request.py +0 -0
  144. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/can_user_resubscribe_plan.py +0 -0
  145. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/canceled_by_enum.py +0 -0
  146. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/capabilities.py +0 -0
  147. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/connection.py +0 -0
  148. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/content_type_enum.py +0 -0
  149. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/country.py +0 -0
  150. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/cta.py +0 -0
  151. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/cta_request.py +0 -0
  152. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/cta_type_enum.py +0 -0
  153. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/currency_enum.py +0 -0
  154. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/customer_consumable_total.py +0 -0
  155. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/customer_order_subscriptions_serializer_v2.py +0 -0
  156. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/customer_order_subscriptions_serializer_v2_status_enum.py +0 -0
  157. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/customer_provider_serializer_v2.py +0 -0
  158. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/device.py +0 -0
  159. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/device_attestation_error.py +0 -0
  160. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/device_attestation_error_reason_enum.py +0 -0
  161. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/device_attestation_response.py +0 -0
  162. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/dh_message.py +0 -0
  163. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/dh_message_attachment.py +0 -0
  164. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/dh_message_reaction.py +0 -0
  165. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/dh_message_type_enum.py +0 -0
  166. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/direction_enum.py +0 -0
  167. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/emoji.py +0 -0
  168. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/emoji_reaction.py +0 -0
  169. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/exotel_auth_request_request.py +0 -0
  170. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/id_enum.py +0 -0
  171. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/integrations_error_response.py +0 -0
  172. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/integrations_request_request.py +0 -0
  173. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/integrations_response.py +0 -0
  174. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/intent_enum.py +0 -0
  175. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/invalid_provider_request.py +0 -0
  176. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/iso_country_enum.py +0 -0
  177. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/item.py +0 -0
  178. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_collection.py +0 -0
  179. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_collection_request.py +0 -0
  180. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_menu_request.py +0 -0
  181. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_menu_request_settings.py +0 -0
  182. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_menu_response.py +0 -0
  183. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_menu_response_settings.py +0 -0
  184. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_menu_response_status_enum.py +0 -0
  185. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_options_invalid_response.py +0 -0
  186. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_options_request.py +0 -0
  187. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ivr_options_response.py +0 -0
  188. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kb_search_mode_enum.py +0 -0
  189. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kb_search_request.py +0 -0
  190. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kb_sse_event.py +0 -0
  191. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kind_enum.py +0 -0
  192. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kwik_engage_auth_request_request.py +0 -0
  193. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kyc.py +0 -0
  194. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kyc_status_enum.py +0 -0
  195. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/kyc_upload_metadata.py +0 -0
  196. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/location.py +0 -0
  197. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/next_or_cta_request.py +0 -0
  198. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/nimbus_post_auth_request_request.py +0 -0
  199. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/order_status_enum.py +0 -0
  200. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization.py +0 -0
  201. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization_employee.py +0 -0
  202. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization_employee_preferences.py +0 -0
  203. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization_employee_status_enum.py +0 -0
  204. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization_group_inline.py +0 -0
  205. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization_group_response.py +0 -0
  206. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization_preferences.py +0 -0
  207. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/organization_provider.py +0 -0
  208. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_call_list.py +0 -0
  209. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_campaign_response_list.py +0 -0
  210. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_customer_order_subscriptions_serializer_v2_list.py +0 -0
  211. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_device_list.py +0 -0
  212. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_dh_message_list.py +0 -0
  213. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_ivr_menu_response_list.py +0 -0
  214. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_ivr_options_response_list.py +0 -0
  215. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_kyc_list.py +0 -0
  216. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_organization_employee_list.py +0 -0
  217. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_organization_group_response_list.py +0 -0
  218. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_organization_list.py +0 -0
  219. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_organization_provider_list.py +0 -0
  220. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/paginated_phone_number_list.py +0 -0
  221. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/patched_ivr_options_update_request.py +0 -0
  222. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/patched_phone_number_update_request_frontdesk.py +0 -0
  223. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/payment_gateway_fees_info.py +0 -0
  224. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/period_enum.py +0 -0
  225. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/phone_number_attributes.py +0 -0
  226. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/phone_number_capabilities.py +0 -0
  227. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/phone_number_frontdesk.py +0 -0
  228. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/phone_number_provider_enum.py +0 -0
  229. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/phone_number_search_response.py +0 -0
  230. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/phone_number_status_enum.py +0 -0
  231. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan.py +0 -0
  232. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan_cancel_info.py +0 -0
  233. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan_expiry_timestamp.py +0 -0
  234. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan_expiry_timestamp_type_enum.py +0 -0
  235. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan_extra_details.py +0 -0
  236. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan_item.py +0 -0
  237. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan_type.py +0 -0
  238. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/plan_type_cycle.py +0 -0
  239. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/platform_enum.py +0 -0
  240. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/product_group.py +0 -0
  241. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/proof.py +0 -0
  242. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/proof_status_enum.py +0 -0
  243. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/provider_status_enum.py +0 -0
  244. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/reaction_by.py +0 -0
  245. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/rental_currency_enum.py +0 -0
  246. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/resource_enum.py +0 -0
  247. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/ringing_strategy_enum.py +0 -0
  248. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/sales_max_auth_request_request.py +0 -0
  249. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/shopify_auth_request_request.py +0 -0
  250. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/stripe_auth_request_request.py +0 -0
  251. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/upload_metadata.py +0 -0
  252. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/user_agent.py +0 -0
  253. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/user_agent_browser.py +0 -0
  254. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/user_agent_device.py +0 -0
  255. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/user_agent_operating_system.py +0 -0
  256. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/user_agent_platform.py +0 -0
  257. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/user_identity.py +0 -0
  258. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_app_organizations_list_status_item.py +0 -0
  259. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_calls_list_direction.py +0 -0
  260. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_calls_metadata_create_json_body.py +0 -0
  261. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_calls_metadata_create_response_200.py +0 -0
  262. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_calls_report_retrieve_date_range.py +0 -0
  263. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_calls_report_retrieve_fields_item.py +0 -0
  264. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_campaign_list_status_item.py +0 -0
  265. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_customer_consumables_retrieve_currency.py +0 -0
  266. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_ivr_list_duration.py +0 -0
  267. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_kyc_list_iso_country.py +0 -0
  268. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_kyc_list_provider_status_item.py +0 -0
  269. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_kyc_list_resource.py +0 -0
  270. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_kyc_list_status.py +0 -0
  271. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_messages_list_types_item.py +0 -0
  272. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_phonenumbers_list_additional_status_item.py +0 -0
  273. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_phonenumbers_list_provider.py +0 -0
  274. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_phonenumbers_list_status.py +0 -0
  275. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_phonenumbers_search_retrieve_intent.py +0 -0
  276. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_phonenumbers_search_retrieve_iso_country_code.py +0 -0
  277. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v1_phonenumbers_search_retrieve_resource.py +0 -0
  278. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v2_app_organizations_employees_list_status_item.py +0 -0
  279. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v3_orders_subscriptions_list_currency.py +0 -0
  280. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/v3_orders_subscriptions_list_status_item.py +0 -0
  281. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/models/why_enum.py +0 -0
  282. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/client/types.py +0 -0
  283. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/py.typed +0 -0
  284. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/__init__.py +0 -0
  285. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/_constants.py +0 -0
  286. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/accounts.py +0 -0
  287. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/campaigns.py +0 -0
  288. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/devices.py +0 -0
  289. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/ivrs.py +0 -0
  290. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/kycs.py +0 -0
  291. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/members.py +0 -0
  292. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/messages.py +0 -0
  293. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/notifications.py +0 -0
  294. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/orgs.py +0 -0
  295. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/payments.py +0 -0
  296. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/phones.py +0 -0
  297. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/silence.py +0 -0
  298. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl/api/resources/teams.py +0 -0
  299. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl_python.egg-info/dependency_links.txt +0 -0
  300. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl_python.egg-info/entry_points.txt +0 -0
  301. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl_python.egg-info/not-zip-safe +0 -0
  302. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/jaxl_python.egg-info/top_level.txt +0 -0
  303. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/mkdocs.yml +0 -0
  304. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/pyproject.toml +0 -0
  305. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/setup.gif +0 -0
  306. {jaxl_python-0.0.52 → jaxl_python-0.0.54}/tests/test_streaming_vad.py +0 -0
@@ -36,3 +36,4 @@ jaxlapi.sh
36
36
  *.py.orig
37
37
  CLAUDE.md
38
38
  CURRENT.md
39
+ run.sh
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: jaxl-python
3
- Version: 0.0.52
3
+ Version: 0.0.54
4
4
  Summary: Official Python SDK and CLI for interfacing with the Jaxl API. Manage calls, messages, IVRs, devices, teams, payments, campaigns, streaming transcriptions and AI Agents. Built on OpenAPI, it offers both generated API clients and Pythonic wrappers for ease of use.
5
5
  Home-page: https://github.com/jaxl-innovations-private-limited/jaxl-python
6
6
  Download-URL: https://github.com/jaxl-innovations-private-limited/jaxl-python/archive/main.zip
@@ -62,6 +62,7 @@ Requires-Dist: pdoc3==0.11.6; extra == "docs"
62
62
  Requires-Dist: mkdocs==1.6.1; extra == "docs"
63
63
  Requires-Dist: mkdocstrings==0.30.1; extra == "docs"
64
64
  Requires-Dist: mkdocstrings-python==1.18.2; extra == "docs"
65
+ Requires-Dist: pymdown-extensions==12.1; extra == "docs"
65
66
  Provides-Extra: types
66
67
  Requires-Dist: types-python-dateutil; extra == "types"
67
68
  Requires-Dist: types-PyYAML==6.0.12.20250915; extra == "types"
@@ -118,6 +119,7 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
118
119
  - [Hold a Participant in an Active Call](#hold-a-participant-in-an-active-call)
119
120
  - [Unhold a Participant in an Active Call](#unhold-a-participant-in-an-active-call)
120
121
  - [Get call details](#get-call-details)
122
+ - [Transfer an Active Call](#transfer-an-active-call)
121
123
  - [Receive Call Events via Webhook IVRs](#receive-call-events-via-webhook-ivrs)
122
124
  - [Realtime Streaming Audio](#realtime-streaming-audio)
123
125
  - [Realtime Streaming Speech Segments](#realtime-streaming-speech-segments)
@@ -125,6 +127,8 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
125
127
  - [AI Agent: Realtime Transcriptions STT ➡️ LLM/MCP ➡️ TTS](#ai-agent-realtime-transcriptions-stt-️-llmmcp-️-tts)
126
128
  - [List Subscriptions Payments](#list-subscriptions-payments)
127
129
  - [List Consumable Payments](#list-consumable-payments)
130
+ - [List Integrations](#list-integrations)
131
+ - [Add an Integration](#add-an-integration)
128
132
  3. [Jaxl Python SDK](#jaxl-python-sdk)
129
133
  - [SDK Example Usage](#sdk-example-usage)
130
134
  4. [JAXL HTTP Webhook Protocol](./SPECIFICATION.md)
@@ -139,17 +143,18 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
139
143
 
140
144
  ```bash
141
145
  jaxl -h
142
- usage: jaxl [-h] {accounts,apps,calls,campaigns,devices,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams} ...
146
+ usage: jaxl [-h] {accounts,apps,calls,campaigns,devices,integrations,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams} ...
143
147
 
144
148
  Jaxl CLI
145
149
 
146
150
  positional arguments:
147
- {accounts,apps,calls,campaigns,devices,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams}
151
+ {accounts,apps,calls,campaigns,devices,integrations,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams}
148
152
  accounts Manage Accounts
149
153
  apps Manage Apps for Webhooks and Streaming audio/speech/transcriptions.
150
154
  calls Manage Calls (Domestic & International Cellular, App-to-App)
151
155
  campaigns Manage Campaigns
152
156
  devices Manage Devices
157
+ integrations Manage Integrations
153
158
  ivrs Manage IVRs (Interactive Voice Response)
154
159
  kycs Manage KYCs
155
160
  members Manage Members
@@ -331,12 +336,16 @@ jaxl calls add --call-id 1234 --email <someone@mycompany.com>
331
336
 
332
337
  ### Remove External Phone Number from an Active Call
333
338
 
339
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
340
+
334
341
  ```bash
335
342
  jaxl calls remove --call-id 1234 --e164 +CC<Mobile Number>
336
343
  ```
337
344
 
338
345
  ### Remove Agent from an Active Call
339
346
 
347
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
348
+
340
349
  ```bash
341
350
  jaxl calls remove --call-id 1234 --email <someone@mycompany.com>
342
351
  ```
@@ -348,8 +357,25 @@ jaxl calls tts --call-id 1234 \
348
357
  --prompt "Hello, this text was injected in the middle of an active call"
349
358
  ```
350
359
 
360
+ > Works on Jaxl-carried (SIP) calls of your own organization. The prompt is split on
361
+ > `.` into sentences and spoken to the call by Jaxl's TTS. Not available on calls
362
+ > carried by a BYO Twilio/Exotel account (the API returns 400).
363
+
364
+ ### Send DTMF Digits into an Active Call
365
+
366
+ Drive the far side's IVR from your app (e.g. "press 1 for sales"):
367
+
368
+ ```bash
369
+ jaxl calls dtmf --call-id 1234 --digits "1"
370
+ jaxl calls dtmf --call-id 1234 --digits "4521#"
371
+ ```
372
+
373
+ > Alphabet `0-9 * # A-D`, at most 32 digits. Jaxl-carried (SIP) calls only.
374
+
351
375
  ### Play Audio File in an Active Call
352
376
 
377
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
378
+
353
379
  ```bash
354
380
  jaxl calls play --call-id 1234 --audio /path/to/a/file/on/local/disk/or/public/url
355
381
  ```
@@ -358,6 +384,8 @@ jaxl calls play --call-id 1234 --audio /path/to/a/file/on/local/disk/or/public/u
358
384
 
359
385
  ### Mute a Participant in an Active Call
360
386
 
387
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
388
+
361
389
  Mute a specific cellular user in a call.
362
390
 
363
391
  ```bash
@@ -372,6 +400,8 @@ jaxl calls mute --call-id 1235 --email <someone@mycompany.com>
372
400
 
373
401
  ### Unmute a Participant in an Active Call
374
402
 
403
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
404
+
375
405
  Unmute a specific cellular user in a call.
376
406
 
377
407
  ```bash
@@ -386,6 +416,8 @@ jaxl calls unmute --call-id 1235 --email <someone@mycompany.com>
386
416
 
387
417
  ### Hold a Participant in an Active Call
388
418
 
419
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
420
+
389
421
  Put a cellular user on-hold in a call
390
422
 
391
423
  ```bash
@@ -400,6 +432,8 @@ jaxl calls hold --call-id 1235 --email <someone@mycompany.com>
400
432
 
401
433
  ### Unhold a Participant in an Active Call
402
434
 
435
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
436
+
403
437
  Unhold a cellular user in a call
404
438
 
405
439
  ```bash
@@ -418,18 +452,68 @@ jaxl calls unhold --call-id 1235 --email <someone@mycompany.com>
418
452
  jaxl calls get --call-id 1234
419
453
  ```
420
454
 
455
+ ### Transfer an Active Call
456
+
457
+ All transfer commands need the call's `--call-id`. Find an active all's ID with:
458
+
459
+ ```bash
460
+ jaxl calls list --active
461
+ ```
462
+
463
+ Transfer to a phone number:
464
+
465
+ ```bash
466
+ jaxl calls transfer --call-id 1234 --phone +CC<Mobile Number>
467
+ ```
468
+
469
+ Transfer to a member by email. `--appusers` takes a Jaxl App User ID, not an email, so resolve it from `jaxl members list` first:
470
+
471
+ ```bash
472
+ jaxl members list | grep -oP "OrganizationEmployee\(id=\d+, user_id=\d+, app_user_id=\d+, email='[^']*'"
473
+ # find the matching member's email in the list, note its app_user_id, then:
474
+ jaxl calls transfer --call-id 1234 --appusers <app_user_id>
475
+ ```
476
+
477
+ Transfer to a team by name. `--teams` takes a Jaxl Team ID, not a name, so resolve it from `jaxl teams list` first:
478
+
479
+ ```bash
480
+ jaxl teams list | grep -oP "OrganizationGroupResponse\(id=\d+, name='[^']*'"
481
+ # find the matching team's name in the list, note its id, then:
482
+ jaxl calls transfer --call-id 1234 --teams <team_id>
483
+ ```
484
+
421
485
  ### Receive Call Events via Webhook IVRs
422
486
 
423
487
  Webhook IVRs can be used to programatically control the lifecycle of incoming and outgoing calls.
424
488
  Jaxl will invoke configured webhook URL for subscribed call events. Handle the webhook request and
425
489
  use Jaxl SDK to continue and customise the call flows.
426
490
 
427
- To create a webhook IVR, use a `https://` URL as `--message` flag e.g.
491
+ To create a webhook IVR, use a `https://` URL as `--message` flag. Jaxl SDK apps
492
+ (`jaxl apps run`) serve the webhook at **`/webhook/`** and the realtime stream at
493
+ **`/stream/`** on the same host, so register the `/webhook/` URL of your app:
428
494
 
429
495
  ```bash
430
- jaxl ivrs create --message "https://example.com/jaxl-webhook-ivr"
496
+ # Plain webhook IVR (call lifecycle events only)
497
+ jaxl ivrs create --message "https://<your-public-host>/webhook/"
498
+
499
+ # Streaming webhook IVR — REQUIRED for the realtime audio / speech /
500
+ # transcription examples below: `?stream` makes Jaxl also open the
501
+ # `/stream/` websocket (derived from your webhook URL) for every call
502
+ jaxl ivrs create --message "https://<your-public-host>/webhook/?stream"
503
+
504
+ # Conversational streaming IVR — your app also SPEAKS back on that
505
+ # websocket (AI agents): add `&conv`
506
+ jaxl ivrs create --message "https://<your-public-host>/webhook/?stream&conv"
507
+
508
+ # Speaker tracks — the stream is NOT mixed and every audio packet names
509
+ # its speaker: add `&tracks` (works with or without `&conv`)
510
+ jaxl ivrs create --message "https://<your-public-host>/webhook/?stream&tracks"
431
511
  ```
432
512
 
513
+ > Without `?stream` no websocket is opened and streaming handlers never fire —
514
+ > silently. Since `jaxl-python` 1.x the SDK app logs a warning when a streaming
515
+ > handler is implemented but no stream arrives for a call.
516
+
433
517
  Next, assign a number to webhook IVR as shown previously under [Assign a Phone Number to IVR by ID](#assign-a-phone-number-to-ivr-by-id). Now, all incoming calls on the number will start with
434
518
  webhook before proceeding further.
435
519
 
@@ -439,20 +523,112 @@ See [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/t
439
523
 
440
524
  ### Realtime Streaming Audio
441
525
 
526
+ > Requires a **streaming** webhook IVR (`?stream`` in the IVR URL — see above).
527
+
442
528
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working streaming audio examples.
443
529
 
444
530
  ### Realtime Streaming Speech Segments
445
531
 
532
+ > Requires a **streaming** webhook IVR (`?stream`` in the IVR URL — see above).
533
+
446
534
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working streaming speech segments examples.
447
535
 
448
536
  ### Realtime Streaming Transcriptions per Speech Segment
449
537
 
538
+ > Requires a **streaming** webhook IVR (`?stream`` in the IVR URL — see above).
539
+
450
540
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working streaming transcription per speech segment examples.
451
541
 
452
542
  ### AI Agent: Realtime Transcriptions STT ➡️ LLM/MCP ➡️ TTS
453
543
 
544
+ > Requires a **streaming** webhook IVR (`?stream`&conv` in the IVR URL — see above).
545
+
454
546
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working AI Agent examples.
455
547
 
548
+ ### Stream Audio Format and Speaker Tracks
549
+
550
+ Audio on the `/stream/` websocket is 16-bit signed PCM, mono, 8 kHz. One packet carries
551
+ 20 ms (320 bytes).
552
+
553
+ By default a call's speakers are mixed into one stream. Add `&tracks` to the IVR URL to
554
+ receive them unmixed. Every packet then says who is speaking in its `meta`:
555
+
556
+ | `meta` field | Value |
557
+ | ------------ | ------------------------------------------------------------------------ |
558
+ | `track` | `customer` (the phone side of the call) or `member` (one of your agents) |
559
+ | `call_id` | Call ID of that speaker's leg |
560
+
561
+ ```python
562
+ async def handle_audio_chunk(self, req, slin16, meta=None):
563
+ who = getattr(meta, "track", None) # "customer" | "member" | None (mixed stream)
564
+ leg = getattr(meta, "call_id", None)
565
+ ```
566
+
567
+ Notes:
568
+
569
+ - `meta` may carry other optional fields (for example `speaker`, `is_speech`). Ignore the
570
+ ones you do not use; new fields can appear.
571
+ - The speech handlers (`handle_speech_detection`, `handle_speech_segment`, transcriptions)
572
+ run one detector per websocket. On a `&tracks` stream, split the audio by `meta.track`
573
+ in `handle_audio_chunk` if you need speech detection per speaker.
574
+ - If you serve `/stream/` without this SDK: a media message is
575
+ `{"event": "media", "media": {"payload": "<base64 PCM>", "meta": {...}}}`.
576
+
577
+ ### Call Handoff: Transferring a Call Out of Your App
578
+
579
+ A conversational app (AI agent) hands its caller to a person with the transfer API
580
+ (`jaxl calls transfer`, see [Transfer an Active Call](#transfer-an-active-call)). The
581
+ transfer is a two-step protocol:
582
+
583
+ 1. **The API response is an acknowledgement, not the outcome.** `200` means the request was
584
+ accepted and the new leg is being placed. The response carries the new leg's Call ID.
585
+ Nobody has answered yet, and your app is still connected to the caller.
586
+ 2. **The outcome arrives on your `/stream/` websocket** as a `handoff` event. The SDK calls
587
+ `handle_handoff(call_id, handoff_call_id, status)`; `handoff_call_id` is the Call ID the
588
+ transfer API returned.
589
+
590
+ | `status` | What happened | What your app should do |
591
+ | ---------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
592
+ | `answered` | The new party picked up and now has the caller. | Stop speaking and finish your bookkeeping. Jaxl stops playing your audio to the caller and closes your stream right after. |
593
+ | `failed` | The transfer was rejected or nobody picked up. | The caller is still with your app. Resume the conversation; you may transfer again. |
594
+
595
+ ```python
596
+ async def handle_handoff(self, call_id: int, handoff_call_id: int, status: str) -> None:
597
+ if status == "answered":
598
+ ... # the human has the caller: stop talking, save the outcome
599
+ else:
600
+ ... # "failed": tell the caller and carry on
601
+ ```
602
+
603
+ Notes:
604
+
605
+ - While the new leg is ringing, your app is still the one talking to the caller.
606
+ - Adding a participant to the call (`jaxl calls add`) is not a handoff: your app stays on the
607
+ call and no `handoff` event is sent.
608
+ - If you serve `/stream/` without this SDK, the message is
609
+ `{"event": "handoff", "handoff": {"status": "answered" | "failed", "call_id": <new leg's Call ID>}}`.
610
+
611
+ ### Listening to Your Team's Calls (Human-Leg Stream)
612
+
613
+ Jaxl can stream the live audio of calls your team members answer or place (no IVR or AI
614
+ agent involved) to one of your streaming webhook IVRs. The stream is listen-only.
615
+
616
+ - Create a streaming webhook IVR for it: `?stream` is required, `&tracks` is recommended,
617
+ `&conv` is not allowed. Ask Jaxl to enable it for your organization with that IVR's ID.
618
+ - It follows the webhook IVR lifecycle. When a member's leg starts, your app receives
619
+ SETUP (`handle_setup`) with the call's state. Answer `200` to accept the call; the
620
+ response body is not used. Any other answer means no stream for that call. When the leg
621
+ ends, your app receives TEARDOWN (`handle_teardown`).
622
+ - The `/stream/` websocket carries that IVR's ID as `ivr_id` and the leg's Call ID as
623
+ `call_id`. It may connect while the call is still ringing; audio starts once a member
624
+ has the call.
625
+ - SETUP is once per call. A member added to a call that is already set up (a conference)
626
+ does not produce another SETUP; their audio arrives on the same stream, tagged with
627
+ their own `call_id`.
628
+ - A call has one stream at a time. While an IVR or AI agent is streaming a call, the
629
+ human-leg stream is not open; after a handoff to a member it opens, and when a member
630
+ transfers the caller to an IVR or AI agent it closes.
631
+
456
632
  ### List Subscriptions Payments
457
633
 
458
634
  ```bash
@@ -465,6 +641,28 @@ jaxl payments subscriptions list
465
641
  jaxl payments consumables total
466
642
  ```
467
643
 
644
+ ### List Integrations
645
+
646
+ ```bash
647
+ jaxl integrations list
648
+ ```
649
+
650
+ ### Add an Integration
651
+
652
+ ```bash
653
+ jaxl integrations create \
654
+ --provider exotel \
655
+ --exotel-api-key "<API Key>" \
656
+ --exotel-api-token "<API Token>" \
657
+ --exotel-tenant-id "<Tenant ID>" \
658
+ --exotel-flow-id 1234
659
+ ```
660
+
661
+ Supported providers are `shopify`, `shiprocket`, `shiprocket_delivery`, `exotel`,
662
+ `twilio`, `stripe`, `stripe_subscription`, `salesmax`, `nimbuspost`, `kwik_engage`,
663
+ `cashfree_checkout` and `gokwik_checkout`.
664
+ Each provider takes its own `--<provider>-...` flags, see `jaxl integrations create -h`.
665
+
468
666
  ## Jaxl Python SDK
469
667
 
470
668
  - Jaxl APIs is built upon [OpenAPI specification](https://www.openapis.org/)
@@ -28,6 +28,7 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
28
28
  - [Hold a Participant in an Active Call](#hold-a-participant-in-an-active-call)
29
29
  - [Unhold a Participant in an Active Call](#unhold-a-participant-in-an-active-call)
30
30
  - [Get call details](#get-call-details)
31
+ - [Transfer an Active Call](#transfer-an-active-call)
31
32
  - [Receive Call Events via Webhook IVRs](#receive-call-events-via-webhook-ivrs)
32
33
  - [Realtime Streaming Audio](#realtime-streaming-audio)
33
34
  - [Realtime Streaming Speech Segments](#realtime-streaming-speech-segments)
@@ -35,6 +36,8 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
35
36
  - [AI Agent: Realtime Transcriptions STT ➡️ LLM/MCP ➡️ TTS](#ai-agent-realtime-transcriptions-stt-️-llmmcp-️-tts)
36
37
  - [List Subscriptions Payments](#list-subscriptions-payments)
37
38
  - [List Consumable Payments](#list-consumable-payments)
39
+ - [List Integrations](#list-integrations)
40
+ - [Add an Integration](#add-an-integration)
38
41
  3. [Jaxl Python SDK](#jaxl-python-sdk)
39
42
  - [SDK Example Usage](#sdk-example-usage)
40
43
  4. [JAXL HTTP Webhook Protocol](./SPECIFICATION.md)
@@ -49,17 +52,18 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
49
52
 
50
53
  ```bash
51
54
  jaxl -h
52
- usage: jaxl [-h] {accounts,apps,calls,campaigns,devices,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams} ...
55
+ usage: jaxl [-h] {accounts,apps,calls,campaigns,devices,integrations,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams} ...
53
56
 
54
57
  Jaxl CLI
55
58
 
56
59
  positional arguments:
57
- {accounts,apps,calls,campaigns,devices,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams}
60
+ {accounts,apps,calls,campaigns,devices,integrations,ivrs,kycs,members,messages,notifications,orgs,payments,phones,teams}
58
61
  accounts Manage Accounts
59
62
  apps Manage Apps for Webhooks and Streaming audio/speech/transcriptions.
60
63
  calls Manage Calls (Domestic & International Cellular, App-to-App)
61
64
  campaigns Manage Campaigns
62
65
  devices Manage Devices
66
+ integrations Manage Integrations
63
67
  ivrs Manage IVRs (Interactive Voice Response)
64
68
  kycs Manage KYCs
65
69
  members Manage Members
@@ -241,12 +245,16 @@ jaxl calls add --call-id 1234 --email <someone@mycompany.com>
241
245
 
242
246
  ### Remove External Phone Number from an Active Call
243
247
 
248
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
249
+
244
250
  ```bash
245
251
  jaxl calls remove --call-id 1234 --e164 +CC<Mobile Number>
246
252
  ```
247
253
 
248
254
  ### Remove Agent from an Active Call
249
255
 
256
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
257
+
250
258
  ```bash
251
259
  jaxl calls remove --call-id 1234 --email <someone@mycompany.com>
252
260
  ```
@@ -258,8 +266,25 @@ jaxl calls tts --call-id 1234 \
258
266
  --prompt "Hello, this text was injected in the middle of an active call"
259
267
  ```
260
268
 
269
+ > Works on Jaxl-carried (SIP) calls of your own organization. The prompt is split on
270
+ > `.` into sentences and spoken to the call by Jaxl's TTS. Not available on calls
271
+ > carried by a BYO Twilio/Exotel account (the API returns 400).
272
+
273
+ ### Send DTMF Digits into an Active Call
274
+
275
+ Drive the far side's IVR from your app (e.g. "press 1 for sales"):
276
+
277
+ ```bash
278
+ jaxl calls dtmf --call-id 1234 --digits "1"
279
+ jaxl calls dtmf --call-id 1234 --digits "4521#"
280
+ ```
281
+
282
+ > Alphabet `0-9 * # A-D`, at most 32 digits. Jaxl-carried (SIP) calls only.
283
+
261
284
  ### Play Audio File in an Active Call
262
285
 
286
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
287
+
263
288
  ```bash
264
289
  jaxl calls play --call-id 1234 --audio /path/to/a/file/on/local/disk/or/public/url
265
290
  ```
@@ -268,6 +293,8 @@ jaxl calls play --call-id 1234 --audio /path/to/a/file/on/local/disk/or/public/u
268
293
 
269
294
  ### Mute a Participant in an Active Call
270
295
 
296
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
297
+
271
298
  Mute a specific cellular user in a call.
272
299
 
273
300
  ```bash
@@ -282,6 +309,8 @@ jaxl calls mute --call-id 1235 --email <someone@mycompany.com>
282
309
 
283
310
  ### Unmute a Participant in an Active Call
284
311
 
312
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
313
+
285
314
  Unmute a specific cellular user in a call.
286
315
 
287
316
  ```bash
@@ -296,6 +325,8 @@ jaxl calls unmute --call-id 1235 --email <someone@mycompany.com>
296
325
 
297
326
  ### Hold a Participant in an Active Call
298
327
 
328
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
329
+
299
330
  Put a cellular user on-hold in a call
300
331
 
301
332
  ```bash
@@ -310,6 +341,8 @@ jaxl calls hold --call-id 1235 --email <someone@mycompany.com>
310
341
 
311
342
  ### Unhold a Participant in an Active Call
312
343
 
344
+ > **Coming soon** — documented ahead of the backend: this command is not in the CLI yet and there is no server-side participant control behind it today (tracked as F-193 in the Jaxl backend). Use `jaxl calls transfer` / `hangup` meanwhile.
345
+
313
346
  Unhold a cellular user in a call
314
347
 
315
348
  ```bash
@@ -328,18 +361,68 @@ jaxl calls unhold --call-id 1235 --email <someone@mycompany.com>
328
361
  jaxl calls get --call-id 1234
329
362
  ```
330
363
 
364
+ ### Transfer an Active Call
365
+
366
+ All transfer commands need the call's `--call-id`. Find an active all's ID with:
367
+
368
+ ```bash
369
+ jaxl calls list --active
370
+ ```
371
+
372
+ Transfer to a phone number:
373
+
374
+ ```bash
375
+ jaxl calls transfer --call-id 1234 --phone +CC<Mobile Number>
376
+ ```
377
+
378
+ Transfer to a member by email. `--appusers` takes a Jaxl App User ID, not an email, so resolve it from `jaxl members list` first:
379
+
380
+ ```bash
381
+ jaxl members list | grep -oP "OrganizationEmployee\(id=\d+, user_id=\d+, app_user_id=\d+, email='[^']*'"
382
+ # find the matching member's email in the list, note its app_user_id, then:
383
+ jaxl calls transfer --call-id 1234 --appusers <app_user_id>
384
+ ```
385
+
386
+ Transfer to a team by name. `--teams` takes a Jaxl Team ID, not a name, so resolve it from `jaxl teams list` first:
387
+
388
+ ```bash
389
+ jaxl teams list | grep -oP "OrganizationGroupResponse\(id=\d+, name='[^']*'"
390
+ # find the matching team's name in the list, note its id, then:
391
+ jaxl calls transfer --call-id 1234 --teams <team_id>
392
+ ```
393
+
331
394
  ### Receive Call Events via Webhook IVRs
332
395
 
333
396
  Webhook IVRs can be used to programatically control the lifecycle of incoming and outgoing calls.
334
397
  Jaxl will invoke configured webhook URL for subscribed call events. Handle the webhook request and
335
398
  use Jaxl SDK to continue and customise the call flows.
336
399
 
337
- To create a webhook IVR, use a `https://` URL as `--message` flag e.g.
400
+ To create a webhook IVR, use a `https://` URL as `--message` flag. Jaxl SDK apps
401
+ (`jaxl apps run`) serve the webhook at **`/webhook/`** and the realtime stream at
402
+ **`/stream/`** on the same host, so register the `/webhook/` URL of your app:
338
403
 
339
404
  ```bash
340
- jaxl ivrs create --message "https://example.com/jaxl-webhook-ivr"
405
+ # Plain webhook IVR (call lifecycle events only)
406
+ jaxl ivrs create --message "https://<your-public-host>/webhook/"
407
+
408
+ # Streaming webhook IVR — REQUIRED for the realtime audio / speech /
409
+ # transcription examples below: `?stream` makes Jaxl also open the
410
+ # `/stream/` websocket (derived from your webhook URL) for every call
411
+ jaxl ivrs create --message "https://<your-public-host>/webhook/?stream"
412
+
413
+ # Conversational streaming IVR — your app also SPEAKS back on that
414
+ # websocket (AI agents): add `&conv`
415
+ jaxl ivrs create --message "https://<your-public-host>/webhook/?stream&conv"
416
+
417
+ # Speaker tracks — the stream is NOT mixed and every audio packet names
418
+ # its speaker: add `&tracks` (works with or without `&conv`)
419
+ jaxl ivrs create --message "https://<your-public-host>/webhook/?stream&tracks"
341
420
  ```
342
421
 
422
+ > Without `?stream` no websocket is opened and streaming handlers never fire —
423
+ > silently. Since `jaxl-python` 1.x the SDK app logs a warning when a streaming
424
+ > handler is implemented but no stream arrives for a call.
425
+
343
426
  Next, assign a number to webhook IVR as shown previously under [Assign a Phone Number to IVR by ID](#assign-a-phone-number-to-ivr-by-id). Now, all incoming calls on the number will start with
344
427
  webhook before proceeding further.
345
428
 
@@ -349,20 +432,112 @@ See [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/t
349
432
 
350
433
  ### Realtime Streaming Audio
351
434
 
435
+ > Requires a **streaming** webhook IVR (`?stream`` in the IVR URL — see above).
436
+
352
437
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working streaming audio examples.
353
438
 
354
439
  ### Realtime Streaming Speech Segments
355
440
 
441
+ > Requires a **streaming** webhook IVR (`?stream`` in the IVR URL — see above).
442
+
356
443
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working streaming speech segments examples.
357
444
 
358
445
  ### Realtime Streaming Transcriptions per Speech Segment
359
446
 
447
+ > Requires a **streaming** webhook IVR (`?stream`` in the IVR URL — see above).
448
+
360
449
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working streaming transcription per speech segment examples.
361
450
 
362
451
  ### AI Agent: Realtime Transcriptions STT ➡️ LLM/MCP ➡️ TTS
363
452
 
453
+ > Requires a **streaming** webhook IVR (`?stream`&conv` in the IVR URL — see above).
454
+
364
455
  Refer to [examples](https://github.com/jaxl-innovations-private-limited/jaxl-python/tree/main/examples) directory for working AI Agent examples.
365
456
 
457
+ ### Stream Audio Format and Speaker Tracks
458
+
459
+ Audio on the `/stream/` websocket is 16-bit signed PCM, mono, 8 kHz. One packet carries
460
+ 20 ms (320 bytes).
461
+
462
+ By default a call's speakers are mixed into one stream. Add `&tracks` to the IVR URL to
463
+ receive them unmixed. Every packet then says who is speaking in its `meta`:
464
+
465
+ | `meta` field | Value |
466
+ | ------------ | ------------------------------------------------------------------------ |
467
+ | `track` | `customer` (the phone side of the call) or `member` (one of your agents) |
468
+ | `call_id` | Call ID of that speaker's leg |
469
+
470
+ ```python
471
+ async def handle_audio_chunk(self, req, slin16, meta=None):
472
+ who = getattr(meta, "track", None) # "customer" | "member" | None (mixed stream)
473
+ leg = getattr(meta, "call_id", None)
474
+ ```
475
+
476
+ Notes:
477
+
478
+ - `meta` may carry other optional fields (for example `speaker`, `is_speech`). Ignore the
479
+ ones you do not use; new fields can appear.
480
+ - The speech handlers (`handle_speech_detection`, `handle_speech_segment`, transcriptions)
481
+ run one detector per websocket. On a `&tracks` stream, split the audio by `meta.track`
482
+ in `handle_audio_chunk` if you need speech detection per speaker.
483
+ - If you serve `/stream/` without this SDK: a media message is
484
+ `{"event": "media", "media": {"payload": "<base64 PCM>", "meta": {...}}}`.
485
+
486
+ ### Call Handoff: Transferring a Call Out of Your App
487
+
488
+ A conversational app (AI agent) hands its caller to a person with the transfer API
489
+ (`jaxl calls transfer`, see [Transfer an Active Call](#transfer-an-active-call)). The
490
+ transfer is a two-step protocol:
491
+
492
+ 1. **The API response is an acknowledgement, not the outcome.** `200` means the request was
493
+ accepted and the new leg is being placed. The response carries the new leg's Call ID.
494
+ Nobody has answered yet, and your app is still connected to the caller.
495
+ 2. **The outcome arrives on your `/stream/` websocket** as a `handoff` event. The SDK calls
496
+ `handle_handoff(call_id, handoff_call_id, status)`; `handoff_call_id` is the Call ID the
497
+ transfer API returned.
498
+
499
+ | `status` | What happened | What your app should do |
500
+ | ---------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
501
+ | `answered` | The new party picked up and now has the caller. | Stop speaking and finish your bookkeeping. Jaxl stops playing your audio to the caller and closes your stream right after. |
502
+ | `failed` | The transfer was rejected or nobody picked up. | The caller is still with your app. Resume the conversation; you may transfer again. |
503
+
504
+ ```python
505
+ async def handle_handoff(self, call_id: int, handoff_call_id: int, status: str) -> None:
506
+ if status == "answered":
507
+ ... # the human has the caller: stop talking, save the outcome
508
+ else:
509
+ ... # "failed": tell the caller and carry on
510
+ ```
511
+
512
+ Notes:
513
+
514
+ - While the new leg is ringing, your app is still the one talking to the caller.
515
+ - Adding a participant to the call (`jaxl calls add`) is not a handoff: your app stays on the
516
+ call and no `handoff` event is sent.
517
+ - If you serve `/stream/` without this SDK, the message is
518
+ `{"event": "handoff", "handoff": {"status": "answered" | "failed", "call_id": <new leg's Call ID>}}`.
519
+
520
+ ### Listening to Your Team's Calls (Human-Leg Stream)
521
+
522
+ Jaxl can stream the live audio of calls your team members answer or place (no IVR or AI
523
+ agent involved) to one of your streaming webhook IVRs. The stream is listen-only.
524
+
525
+ - Create a streaming webhook IVR for it: `?stream` is required, `&tracks` is recommended,
526
+ `&conv` is not allowed. Ask Jaxl to enable it for your organization with that IVR's ID.
527
+ - It follows the webhook IVR lifecycle. When a member's leg starts, your app receives
528
+ SETUP (`handle_setup`) with the call's state. Answer `200` to accept the call; the
529
+ response body is not used. Any other answer means no stream for that call. When the leg
530
+ ends, your app receives TEARDOWN (`handle_teardown`).
531
+ - The `/stream/` websocket carries that IVR's ID as `ivr_id` and the leg's Call ID as
532
+ `call_id`. It may connect while the call is still ringing; audio starts once a member
533
+ has the call.
534
+ - SETUP is once per call. A member added to a call that is already set up (a conference)
535
+ does not produce another SETUP; their audio arrives on the same stream, tagged with
536
+ their own `call_id`.
537
+ - A call has one stream at a time. While an IVR or AI agent is streaming a call, the
538
+ human-leg stream is not open; after a handoff to a member it opens, and when a member
539
+ transfers the caller to an IVR or AI agent it closes.
540
+
366
541
  ### List Subscriptions Payments
367
542
 
368
543
  ```bash
@@ -375,6 +550,28 @@ jaxl payments subscriptions list
375
550
  jaxl payments consumables total
376
551
  ```
377
552
 
553
+ ### List Integrations
554
+
555
+ ```bash
556
+ jaxl integrations list
557
+ ```
558
+
559
+ ### Add an Integration
560
+
561
+ ```bash
562
+ jaxl integrations create \
563
+ --provider exotel \
564
+ --exotel-api-key "<API Key>" \
565
+ --exotel-api-token "<API Token>" \
566
+ --exotel-tenant-id "<Tenant ID>" \
567
+ --exotel-flow-id 1234
568
+ ```
569
+
570
+ Supported providers are `shopify`, `shiprocket`, `shiprocket_delivery`, `exotel`,
571
+ `twilio`, `stripe`, `stripe_subscription`, `salesmax`, `nimbuspost`, `kwik_engage`,
572
+ `cashfree_checkout` and `gokwik_checkout`.
573
+ Each provider takes its own `--<provider>-...` flags, see `jaxl integrations create -h`.
574
+
378
575
  ## Jaxl Python SDK
379
576
 
380
577
  - Jaxl APIs is built upon [OpenAPI specification](https://www.openapis.org/)