Create a call

Create a call or meeting asynchronously (creation time is typically a few minutes). You must first finish uploading the recording of the call using a presigned recording url retrieved with the previous endpoint. Use the "LIST users" endpoint to find the user_uuid to use in this request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Participants & customers

Use participating_user_uuids to attach other Leexi users (besides the owner set via user_uuid) to the call. Look them up with the LIST users endpoint.

Use the customers array to describe the external participants of the call. Each entry accepts any of name, email, phone_number and uuid (a single attribute is enough):

{
  "customers": [
    { "name": "Wei Kemmer", "email": "[email protected]" },
    { "phone_number": "+32474000000" },
    { "uuid": "f1a2b3c4-d5e6-7f8a-9b0c-d1e2f3a4b5c6" }
  ]
}
  • When uuid is provided, it links an existing customer and the other attributes are ignored. Unknown uuids are skipped.
  • The name you provide is used to help Leexi identify the speakers in the transcript.
🚧

Deprecated params

emails and raw_phone_number are kept for backward compatibility but are deprecated. Prefer participating_user_uuids (for fellow Leexi users) and the richer customers array (for external participants).

The deprecated params (emails, raw_phone_number) cannot be combined with the new params (customers, participating_user_uuids) in the same request — doing so returns a 400. Use one style or the other.

📘

Requires the write_calls permission scope on the API key.

Body Params
customers
array of objects

The external participants (customers) of the call. An array of objects, each accepting any of name, email, phone_number and uuid (only one attribute is required per object). When uuid is set it links an existing customer and the other attributes are ignored; unknown uuids are skipped. The provided names are used to help identify the speakers in the transcript. Prefer this over the deprecated emails and raw_phone_number params. ⚠️ Cannot be combined with the deprecated emails or raw_phone_number params in the same request (returns a 400).

customers
string
string
required
Defaults to outbound

inbound or outbound

emails
array of strings
deprecated

⚠️ DEPRECATED — kept for backward compatibility only. A list of emails of other participants in the call. Use participating_user_uuids (for fellow Leexi users) and the customers array (for external participants) instead. Cannot be combined with customers or participating_user_uuids in the same request (returns a 400).

emails
string
required
Defaults to 123

the id of the call in your system

string

fr-FR en-US de-DE es-ES nl-NL ar-AE da-DK hi-IN id-ID it-IT ja-JP ko-KR nb-NO pl-PL pt-PT ru-RU sv-SE tr-TR uk-UA zh-CN fr-CA he-IL th-TH bg-BG cs-CZ el-GR et-EE fi-FI hr-HR hu-HU lt-LT lv-LV ro-RO vi-VN en-AU en-GB en-NZ en-IN ca-ES

participating_user_uuids
array of strings

uuids of fellow Leexi users participating in the call (in addition to the owner set via user_uuid). Use the "LIST users" endpoint to find them. ⚠️ Cannot be combined with the deprecated emails or raw_phone_number params in the same request (returns a 400).

participating_user_uuids
string
required
Defaults to 2024-10-18T16:19:22+02:00

iso8601 format

string
deprecated

⚠️ DEPRECATED — kept for backward compatibility only. A string representation of the customer's phone_number. Use the customers array instead (set its phone_number attribute). Cannot be combined with customers or participating_user_uuids in the same request (returns a 400).

string
required
Defaults to leexi/recordings/upload/b969bec6-c572-466b-99cd-37b4bb7d8b4f.mp3

the key returned by the presign_recording_url endpoint

tags
array of strings

an array of tag names

tags
string
Defaults to Meeting XYZ

The title of the call or meeting

string
required
Defaults to ee4c0057-5c1f-45a6-a0ba-8e2356fa137a

The uuid of the user associated to the call, must have an active license.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json