Here is a breakdown of the request options for the Telephony API endpoint:
|string||enum([start, stop]) - Start or Stop connection|
|object||Object containing Type of the session - either pstn or sip, phoneNumber which is the meeting number symbl should call with country code prepended and dtmf which is the conference passcode. See endpoint section below.|
|array||actions that should be performed while this connection is active. Currently only one action is supported - sendSummaryEmail. See actions section below.|
|object||Object containing a session object which has a field name corresponding to the name of the meeting. See data section below.|
|array||The first language code in the array is used to specify the session’s language. See languages section below.|
|string||The timezone name which comes from the IANA TZ database. See timezone section below.|
|Yes||enum(["sip", "pstn"])||Defines the type of connection. Only SIP and PSTN supported.|
|Yes||String||Phone number to be used to dial in to in E.164 format i.e. special characters like () or - and leading + or international access codes like 001 or 00 must be omitted. For e.g. - US number should look like 14082924837, whereas UK number should look like 447082924837.|
|No||String||DTMF sequence to be sent after call is received (ex: |
|Yes||enum(["start", "stop"])||Event type on which the action should be performed.|
|Yes||String||Name of the action that needs to be invoked. Only |
|Yes||Object||Object with required input parameter data for invocation of the specified action.|
|Yes||String||An array of emails.|
|No||String||Contains information about the meeting.|
|No||String||The name of the meeting.|
|No||String||Language code in BCP-47 format|
For more information about our supported languages, check here.
|No||String||The timezone name which comes from the IANA TZ database.|
|REST API to push speaker events as the conversation is in progress, to add additional speaker context in the conversation. Example - In an on-going meeting, you can push speaker events|
|Same as eventUrl but over WebSocket. The latency of events is lower with a dedicated WebSocket connection.ct|
|Ephemeral connection identifier of the request, to uniquely identify the telephony connection. Once the connection is stopped using “stop” operation, or is closed due to some other reason, the connectionId is no longer valid|
|Represents the conversation - this is the ID that needs to be used in conversation api to access the conversation|
Language is specified by passing an array of language codes to the language parameter when making a call to the Telephony API endpoint.
Currently, transcription punctuation is not supported for French (
fr-CA) or Dutch (
The following list of languages(with their BCP-47 language-codes) are currently supported:
|English (United States)|
|English (United Kingdom)|
|English (South Africa)|
|Russian (Russian Federation)|
|Spanish (United States)|
|Arabic (Saudi Arabia)|
- If the language is not specified then
en-US(English - United States) is used as the default language.
- Insights like Action items, follow-ups, topics, etc are detected for English language only.
Below is an example of a request payload specifying that the meeting’s language should be in Spanish.
If a language is not specified, it will currently fall back to English (en-US).
Specifying a timezone when initiating a session will result in the Summary UI displaying the meeting start time for that given region.
Below is an example of a request payload which sets the timezone to the Pacific Timezone by passing the TZ database name to the timezone parameter while initiating a session:
If no timezone is specified it will fall back to UTC time zone.