Create a meeting session

Creates a new meeting session. When an idempotency_key is supplied in the request body, replay lookup is scoped to the authenticated account and compares only the key; the request payload is not fingerprinted or compared. If a session with that key already exists for the account, the existing session is replayed (200); otherwise a new session is created (201). Supports bring-your-own-key (BYOK) configuration. The session may enter asynchronous states (e.g. joining, waiting_for_admission) before becoming active. Optional camera_image input is write-only and applies only when no Avatar or Assistant webpage output takes precedence. An ignored URL is not fetched. An effective URL source is resolved before bot creation; neither the source URL nor image bytes are persisted, returned, or logged. Treat signed URLs as credentials.

POST

meeting_sessions

curl --request POST \
  --url https://api.telnyx.com/v2/meeting_sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "meeting_url": "<string>",
  "bot_name": "<string>",
  "join_at": "2023-11-07T05:31:56Z",
  "voice": "<string>",
  "speak_on_enter": "<string>",
  "barge_in": false,
  "summarize_on_end": false,
  "camera_image": {
    "format": "jpeg",
    "base64_data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k="
  },
  "webhook_url": "<string>",
  "metadata": {},
  "idempotency_key": "<string>"
}
'

import requests

url = "https://api.telnyx.com/v2/meeting_sessions"

payload = {
    "meeting_url": "<string>",
    "bot_name": "<string>",
    "join_at": "2023-11-07T05:31:56Z",
    "voice": "<string>",
    "speak_on_enter": "<string>",
    "barge_in": False,
    "summarize_on_end": False,
    "camera_image": {
        "format": "jpeg",
        "base64_data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k="
    },
    "webhook_url": "<string>",
    "metadata": {},
    "idempotency_key": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    meeting_url: '<string>',
    bot_name: '<string>',
    join_at: '2023-11-07T05:31:56Z',
    voice: '<string>',
    speak_on_enter: '<string>',
    barge_in: false,
    summarize_on_end: false,
    camera_image: {
      format: 'jpeg',
      base64_data: '/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k='
    },
    webhook_url: '<string>',
    metadata: {},
    idempotency_key: '<string>'
  })
};

fetch('https://api.telnyx.com/v2/meeting_sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.telnyx.com/v2/meeting_sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'meeting_url' => '<string>',
    'bot_name' => '<string>',
    'join_at' => '2023-11-07T05:31:56Z',
    'voice' => '<string>',
    'speak_on_enter' => '<string>',
    'barge_in' => false,
    'summarize_on_end' => false,
    'camera_image' => [
        'format' => 'jpeg',
        'base64_data' => '/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k='
    ],
    'webhook_url' => '<string>',
    'metadata' => [
        
    ],
    'idempotency_key' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.telnyx.com/v2/meeting_sessions"

	payload := strings.NewReader("{\n  \"meeting_url\": \"<string>\",\n  \"bot_name\": \"<string>\",\n  \"join_at\": \"2023-11-07T05:31:56Z\",\n  \"voice\": \"<string>\",\n  \"speak_on_enter\": \"<string>\",\n  \"barge_in\": false,\n  \"summarize_on_end\": false,\n  \"camera_image\": {\n    \"format\": \"jpeg\",\n    \"base64_data\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k=\"\n  },\n  \"webhook_url\": \"<string>\",\n  \"metadata\": {},\n  \"idempotency_key\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.telnyx.com/v2/meeting_sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meeting_url\": \"<string>\",\n  \"bot_name\": \"<string>\",\n  \"join_at\": \"2023-11-07T05:31:56Z\",\n  \"voice\": \"<string>\",\n  \"speak_on_enter\": \"<string>\",\n  \"barge_in\": false,\n  \"summarize_on_end\": false,\n  \"camera_image\": {\n    \"format\": \"jpeg\",\n    \"base64_data\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k=\"\n  },\n  \"webhook_url\": \"<string>\",\n  \"metadata\": {},\n  \"idempotency_key\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.telnyx.com/v2/meeting_sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meeting_url\": \"<string>\",\n  \"bot_name\": \"<string>\",\n  \"join_at\": \"2023-11-07T05:31:56Z\",\n  \"voice\": \"<string>\",\n  \"speak_on_enter\": \"<string>\",\n  \"barge_in\": false,\n  \"summarize_on_end\": false,\n  \"camera_image\": {\n    \"format\": \"jpeg\",\n    \"base64_data\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k=\"\n  },\n  \"webhook_url\": \"<string>\",\n  \"metadata\": {},\n  \"idempotency_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "account_id": "<string>",
    "provider": "<string>",
    "status_detail": "<string>",
    "recording": true,
    "meeting_url": "<string>",
    "bot_name": "<string>",
    "config": {
      "voice": "<string>",
      "speak_on_enter": "<string>",
      "barge_in": true,
      "summarize_on_end": true
    },
    "avatar": {
      "provider": "<string>",
      "avatar_id": "<string>"
    },
    "avatar_state_changed_at": "2023-11-07T05:31:56Z",
    "assistant": {
      "id": "<string>"
    },
    "assistant_state_changed_at": "2023-11-07T05:31:56Z",
    "webhook_url": "<string>",
    "metadata": {},
    "failure_reason": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "join_at": "2023-11-07T05:31:56Z",
    "joined_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "<string>",
    "account_id": "<string>",
    "provider": "<string>",
    "status_detail": "<string>",
    "recording": true,
    "meeting_url": "<string>",
    "bot_name": "<string>",
    "config": {
      "voice": "<string>",
      "speak_on_enter": "<string>",
      "barge_in": true,
      "summarize_on_end": true
    },
    "avatar": {
      "provider": "<string>",
      "avatar_id": "<string>"
    },
    "avatar_state_changed_at": "2023-11-07T05:31:56Z",
    "assistant": {
      "id": "<string>"
    },
    "assistant_state_changed_at": "2023-11-07T05:31:56Z",
    "webhook_url": "<string>",
    "metadata": {},
    "failure_reason": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "join_at": "2023-11-07T05:31:56Z",
    "joined_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "webhook_secret": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "request is invalid"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "invalid or missing credentials"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "credential is not permitted"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "request body too large"
  }
}

{
  "error": {
    "code": "unsupported_capability",
    "message": "avatar video is not supported on platform 'unknown'"
  }
}

{
  "error": {
    "code": "auth_overloaded",
    "message": "authentication temporarily overloaded"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "internal server error"
  }
}

{
  "error": {
    "code": "provider_error",
    "message": "meeting provider rejected bot creation"
  }
}

{
  "error": {
    "code": "not_configured",
    "message": "required feature is not configured"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating a new meeting session.

Cross-field rules:

Neither avatar nor assistant can be combined with join_at; both are available only for sessions that join immediately.
assistant cannot be combined with barge_in: true.
The avatar and assistant options take effect at session creation and cannot be modified later.
An effective Avatar or Assistant webpage output takes precedence over camera_image; the static image is ignored and a URL source is not fetched.

meeting_url

string<uri>

required

The meeting URL the bot should join.

bot_name

string

Display name for the bot in the meeting. Defaults to "Meeting Bot".

Required string length: 1 - 100

join_at

string<date-time>

ISO-8601 timestamp in the future at which the bot should join. If omitted, the bot joins immediately.

voice

string

Session-default voice identifier used for speak_on_enter and ordinary speak actions. A voice supplied on an individual speak action overrides this default for that utterance.

Required string length: 1 - 100

speak_on_enter

string

Text the bot speaks when it enters the meeting.

Required string length: 1 - 4000

barge_in

boolean

default:false

When enabled, a human participant speech_on event interrupts and stops the current bot audio; it does not bypass admission or initiate speech. Assistant sessions reject barge_in: true.

summarize_on_end

boolean

default:false

If true, generate a summary artifact when the session ends.

camera_image

MeetingSessionCameraImageBase64Source · object

Write-only static camera-tile image for this session, not a native account or participant profile photo. Supply exactly one JPEG source. When effective, the image is used as the bot's static camera/video output; presentation varies by meeting platform and recording configuration and is not guaranteed in recordings. An effective Avatar or Assistant webpage output takes precedence, so this input is ignored and a URL source is not fetched.

MeetingSessionCameraImageBase64Source
MeetingSessionCameraImageUrlSource

Show child attributes

Example:

{
  "format": "jpeg",
  "base64_data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k="
}

webhook_url

string<uri>

HTTPS endpoint to receive session lifecycle callbacks. Static validation requires HTTPS, rejects embedded credentials and blocked hosts, and enforces egress policy. Validation makes no network request to the endpoint.

metadata

object

Arbitrary key-value metadata attached to the session. The serialized JSON representation must not exceed 16384 characters at runtime.

idempotency_key

string

Client-supplied idempotency key to safely retry creation requests without duplicating sessions. Lookup is scoped to the authenticated account and compares the key only; the request payload is not fingerprinted or compared.

Required string length: 1 - 255

avatar

MeetingSessionAvatarRequest · object

Request options for attaching a bring-your-own-key avatar to the session.

Show child attributes

assistant

MeetingSessionAssistantRequest · object

Request options for attaching a voice assistant to the session. Routing fields (call_control_connection_id, from, and loopback_sip_uri) are used only to establish the assistant call leg and are omitted from response objects. audio_gate is returned with id in the assistant response object.

Show child attributes

Response

Replayed existing meeting session matching the account-scoped idempotency_key. Replay is key-only; the request payload is not fingerprinted or compared.

data

MeetingSession · object

required

Represents a meeting session. All serializer fields are present and required; nullable fields use null when absent. No actor, provider-bot, idempotency, routing, key, or internal fields are exposed.

Show child attributes

⌘I

Create a meeting session

curl --request POST \
  --url https://api.telnyx.com/v2/meeting_sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "meeting_url": "<string>",
  "bot_name": "<string>",
  "join_at": "2023-11-07T05:31:56Z",
  "voice": "<string>",
  "speak_on_enter": "<string>",
  "barge_in": false,
  "summarize_on_end": false,
  "camera_image": {
    "format": "jpeg",
    "base64_data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k="
  },
  "webhook_url": "<string>",
  "metadata": {},
  "idempotency_key": "<string>"
}
'

import requests

url = "https://api.telnyx.com/v2/meeting_sessions"

payload = {
    "meeting_url": "<string>",
    "bot_name": "<string>",
    "join_at": "2023-11-07T05:31:56Z",
    "voice": "<string>",
    "speak_on_enter": "<string>",
    "barge_in": False,
    "summarize_on_end": False,
    "camera_image": {
        "format": "jpeg",
        "base64_data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k="
    },
    "webhook_url": "<string>",
    "metadata": {},
    "idempotency_key": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    meeting_url: '<string>',
    bot_name: '<string>',
    join_at: '2023-11-07T05:31:56Z',
    voice: '<string>',
    speak_on_enter: '<string>',
    barge_in: false,
    summarize_on_end: false,
    camera_image: {
      format: 'jpeg',
      base64_data: '/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k='
    },
    webhook_url: '<string>',
    metadata: {},
    idempotency_key: '<string>'
  })
};

fetch('https://api.telnyx.com/v2/meeting_sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.telnyx.com/v2/meeting_sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'meeting_url' => '<string>',
    'bot_name' => '<string>',
    'join_at' => '2023-11-07T05:31:56Z',
    'voice' => '<string>',
    'speak_on_enter' => '<string>',
    'barge_in' => false,
    'summarize_on_end' => false,
    'camera_image' => [
        'format' => 'jpeg',
        'base64_data' => '/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k='
    ],
    'webhook_url' => '<string>',
    'metadata' => [
        
    ],
    'idempotency_key' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.telnyx.com/v2/meeting_sessions"

	payload := strings.NewReader("{\n  \"meeting_url\": \"<string>\",\n  \"bot_name\": \"<string>\",\n  \"join_at\": \"2023-11-07T05:31:56Z\",\n  \"voice\": \"<string>\",\n  \"speak_on_enter\": \"<string>\",\n  \"barge_in\": false,\n  \"summarize_on_end\": false,\n  \"camera_image\": {\n    \"format\": \"jpeg\",\n    \"base64_data\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k=\"\n  },\n  \"webhook_url\": \"<string>\",\n  \"metadata\": {},\n  \"idempotency_key\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.telnyx.com/v2/meeting_sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meeting_url\": \"<string>\",\n  \"bot_name\": \"<string>\",\n  \"join_at\": \"2023-11-07T05:31:56Z\",\n  \"voice\": \"<string>\",\n  \"speak_on_enter\": \"<string>\",\n  \"barge_in\": false,\n  \"summarize_on_end\": false,\n  \"camera_image\": {\n    \"format\": \"jpeg\",\n    \"base64_data\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k=\"\n  },\n  \"webhook_url\": \"<string>\",\n  \"metadata\": {},\n  \"idempotency_key\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.telnyx.com/v2/meeting_sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meeting_url\": \"<string>\",\n  \"bot_name\": \"<string>\",\n  \"join_at\": \"2023-11-07T05:31:56Z\",\n  \"voice\": \"<string>\",\n  \"speak_on_enter\": \"<string>\",\n  \"barge_in\": false,\n  \"summarize_on_end\": false,\n  \"camera_image\": {\n    \"format\": \"jpeg\",\n    \"base64_data\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAACAAIBAREA/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EAB4QAAAEBwAAAAAAAAAAAAAAAAAEBgcCFic1RVNi/9oACAEBAAA/AH8hGJbWR09TxKW4vhC2qHgf/9k=\"\n  },\n  \"webhook_url\": \"<string>\",\n  \"metadata\": {},\n  \"idempotency_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "account_id": "<string>",
    "provider": "<string>",
    "status_detail": "<string>",
    "recording": true,
    "meeting_url": "<string>",
    "bot_name": "<string>",
    "config": {
      "voice": "<string>",
      "speak_on_enter": "<string>",
      "barge_in": true,
      "summarize_on_end": true
    },
    "avatar": {
      "provider": "<string>",
      "avatar_id": "<string>"
    },
    "avatar_state_changed_at": "2023-11-07T05:31:56Z",
    "assistant": {
      "id": "<string>"
    },
    "assistant_state_changed_at": "2023-11-07T05:31:56Z",
    "webhook_url": "<string>",
    "metadata": {},
    "failure_reason": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "join_at": "2023-11-07T05:31:56Z",
    "joined_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "<string>",
    "account_id": "<string>",
    "provider": "<string>",
    "status_detail": "<string>",
    "recording": true,
    "meeting_url": "<string>",
    "bot_name": "<string>",
    "config": {
      "voice": "<string>",
      "speak_on_enter": "<string>",
      "barge_in": true,
      "summarize_on_end": true
    },
    "avatar": {
      "provider": "<string>",
      "avatar_id": "<string>"
    },
    "avatar_state_changed_at": "2023-11-07T05:31:56Z",
    "assistant": {
      "id": "<string>"
    },
    "assistant_state_changed_at": "2023-11-07T05:31:56Z",
    "webhook_url": "<string>",
    "metadata": {},
    "failure_reason": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "join_at": "2023-11-07T05:31:56Z",
    "joined_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "webhook_secret": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "request is invalid"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "invalid or missing credentials"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "credential is not permitted"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "request body too large"
  }
}

{
  "error": {
    "code": "unsupported_capability",
    "message": "avatar video is not supported on platform 'unknown'"
  }
}

{
  "error": {
    "code": "auth_overloaded",
    "message": "authentication temporarily overloaded"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "internal server error"
  }
}

{
  "error": {
    "code": "provider_error",
    "message": "meeting provider rejected bot creation"
  }
}

{
  "error": {
    "code": "not_configured",
    "message": "required feature is not configured"
  }
}

Meeting (Beta)

Join a Meeting

During the Meeting

After the Meeting

Webhooks

API Reference

WebSocket

For AI Agents

Create a meeting session

Authorizations

Body

Response