API Documentation
=================

The platform provides the following APIs:

:doc:`transactions_api/index`  - provides read-only access to call transaction data.

:doc:`network_integration/index` -
supports the replication and synchronization of advertiser, publisher and campaign data between partner platforms.

:doc:`bulk_ringpool_api` -
allocates a dynamic, trackable promo phone number from a RingPool (designed to handle a high volume of requests per second).

:doc:`ringpool` -
allocates a dynamic, trackable promo phone number from a RingPool (no longer recommended).

:doc:`signal_api/index` -
used to report signals that occur on a specific call (transaction).

:doc:`call_api/index` -
used to pull transcript information for a specific call (transcript).

:doc:`call_ingestion_api/index` -
used to ingest calls from external sources for conversation intelligence processing and inclusion in your reports and dashboards.

:doc:`calls_in_progress_api/index` -
used to interact with pre-call insights for live calls as part of PreSense

:doc:`sms_messaging_api/index` -
used for SMS number management, as well as handling incoming/outgoing SMS messages within the Invoca platform

The Transactions API and Network Integration API are accessible using the API credentials generated on the platform. See :doc:`manage_api_credentials` for more information.

The RingPool and Bulk RingPool APIs are accessible using the API keys provided in the RingPool wizard. (Note: the Bulk RingPool API is only available after being enabled by Customer Success. Submit a case via the `Community Case Portal`_ to request the Bulk RingPool API.)

.. _`Community Case Portal`: https://community.invoca.com/t5/crmsupport/page

The RingPool wizard includes a section showing the correct API URL for your organization:

.. raw:: html

  <img src="https://lh6.googleusercontent.com/bPAQy29TdQ_Pljxyv5gh520cLnWHWNWUXyU8_GrN52yLNOdkKlWZPzFLCOKgdE-IejM3XDdJGZyJtQ8EMprqwUSImYfuffWuXMGQAYAFzEbMOxt7Ggtp59Q96AOf6a3BeQ"  class="info-img" width="544px;" height="191px;" style="border-style: none;" alt="RP_API.png" />


.. toctree::
   :maxdepth: 2
   :hidden:

   manage_api_credentials
   network_integration/index
   transactions_api/index
   bulk_ringpool_api
   ringpool
   signal_api/index
   call_api/index
   call_ingestion_api/index
   calls_in_progress_api/index
   sms_messaging_api/index