This article explains how to use Call AI Public Application Programming Interface (API).
The Call AI public API is an application programming interface made publicly available to software developers through GraphQL. It provides programmatic access to the Call AI platform.
GraphQL is an open-source data query and manipulation language for APIs and a runtime environment for fulfilling queries with existing data. GraphQL provides a comprehensive description of the data in your API. It allows you to define the required data structure and returns the same structure from the server.
You can use GraphQL by providing a query and the description of the data you need. For example, in the screenshot below, you can view the data obtained from the recordings query.
A GraphQL playground is a graphical, interactive, and in-browser Integrated Development Environment (IDE). You can write queries and mutations directly on the interface. You can also provide input parameters and obtain data based on them.
The following table provides a description of the supported query, parameters, and fields in Call AI public API:
Fetches details of all the recordings.
(* represents mandatory parameter)
Indicates the number of recordings to fetch.
Indicates the cursor position from where fetching starts (used for paginated results).
Indicates the filters applied while fetching recordings. It accepts a RecordingsV2Filters object with the following properties:
For more information about RecordingsV2Filters objects, see the playground documentation section on the GraphQL interface.
A field to specify the sorting order of the requested data. Pass an array where each element has the following properties:
For more information about the input parameters, see playground documentation section on the GraphQL interface.
The following table provides a description of the fields of the node (which is a nested field of edges) returned by the recordingsV2 query:
A unique numerical identifier of the meeting.
Title of the meeting as present in the calendar event.
Description of the meeting as present in the calendar event.
Scheduled date and timestamp of the meeting, for example, 2021-11-02T09:00:00.000Z.
Time when the participants joined the meeting. It could be a few minutes before or after the scheduled meeting time.
Time when all the participants left the meeting.
Duration of the meeting in seconds, for example, 1385.72.
Name of the user who shared the meeting.
Timestamp when a user shared the meeting.
Names of the internal users (within the organization) with whom you have shared the meeting. It is an array of InternalShareObject where each element represents an internal share and has the following subfields:
Names of the external users (outside the organization) with whom you have shared the meeting. It is an array of ExternalShareUser where each element represents an external share and has the following subfields:
It has the following parameters:
A speaker event that triggers whenever a participant speaks. Hence, multiple events can trigger for the same participant throughout the meeting. It is an array of SpeakerEventV2 containing one element per speaker (participant) who caused at least one event during the meeting.
Each element has the following subfields:
Details of all the participants who joined the meeting. It is an array of ParticipantV2 where each element represents a participant of the meeting and has subfields such as:
It has the following boolean parameters:
Transcript of the meeting. It has the following fields:
Details of all the themes spoken and heard during a meeting. Its value is of type MeetingThemeV2 and has the following subfields:
MeetingThemeDetails has the following subfields:
It is similar to themesV2 field and provides an aggregated view of all the themes that were spoken and heard. It is an array of AggregatedThemes where each element has the following subfields:
Here a theme is a nested object containing information such as id, name, keywords.
It has the following parameters:
Possible values of THEME_TYPE:
For more information about Call AI, see Mindtickle help site documentation.
For more information about GraphQL, see GraphQL documentation.