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 Request a presigned url endpoint. Use the LIST users endpoint to find the user_uuid to use in this request.

post/calls

Request

  • Base URL: https://public-api.leexi.ai/v1
  • URL: https://public-api.leexi.ai/v1/calls
  • Auth: API key in header Authorization

Request body

custom_fieldsobject

Free-form key/value pairs stored on the call and returned as-is by the LIST calls and GET call endpoints. Only for custom integrations agreed with Leexi: the keys and their meaning must be defined with the Leexi team beforehand, otherwise the values are stored but never used. Values must be scalars (string, number, boolean or null).

descriptionstring
directionstring required

inbound or outbound

emailsstring[]

⚠️ 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).

external_idstring required

the id of the call in your system

localestring

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_uuidsstring[]

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).

performed_atstring required

iso8601 format

raw_phone_numberstring

⚠️ 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).

recording_s3_keystring required

the recording_s3_key returned by the Request a presigned url endpoint

tagsstring[]

an array of tag names

titlestring

The title of the call or meeting

user_uuidstring required

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

Example request

{
  "custom_fields": {
    "siret": "00012345678901"
  },
  "customers": [
    {
      "email": "wei.kemmer@example.com",
      "name": "Wei Kemmer",
      "phone_number": "+1..."
    }
  ]
}

Response

200

messagestring

Example response

{
  "message": "successfully submitted call for creation"
}

Changes

No recorded changes to this operation across all 1 revision of this API.