Exchange a magic link token for a session

Consumes the one-time portal redirect (magic link) token emailed during bot signup and returns an API session. The token is a UUIDv7 that encodes its creation time; it expires after a configurable validity window (15 minutes by default) and is cleared on first use. Although the action creates a session, the route uses the GET verb because it is opened from an email link. On first use the account is also initialized. For bot signup (freemium) accounts the response is a minimal envelope containing only the api_v2_token; accounts that are permitted to use magic links but are not freemium accounts may instead receive an extended session payload when additional steps (such as two-factor authentication or identity verification) are required. This endpoint is public; the magic link token in the query string is the credential.

GET

bot_sessions

curl --request GET \
  --url https://api.telnyx.com/v2/bot_sessions

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.telnyx.com/v2/bot_sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

{
  "data": {
    "api_v2_token": "KEY0189A1B2C3D4E5F6071829AB3C4D5E_5FhZonmFvcw8Yq0dME27Bg"
  }
}

{
  "errors": [
    {
      "detail": "Account could not be initialized"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Your sign-in link has expired. Please request a new one-time sign-in link."
    }
  ]
}

{
  "errors": [
    {
      "detail": "Your registration cannot be accepted as it does not comply with our security standards. You may contact support for assistance."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "The requested resource or URL could not be found.",
      "source": {
        "pointer": "/"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10005"
      }
    }
  ]
}

Query Parameters

string<email>

required

Email address associated with the magic link token.

Example:

"agent-owner@example.com"

portal_redirect_token

string<uuid>

required

Single-use portal redirect (magic link) token, a UUIDv7 sent to the account owner's email.

Example:

"01890a7e-e2f7-7c3d-8dbb-9a2c5f3d1e0b"

Response

Session created. Bot signup accounts receive a minimal token envelope.

data

object

required

Show child attributes

Exchange a magic link token for a session

curl --request GET \
  --url https://api.telnyx.com/v2/bot_sessions

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.telnyx.com/v2/bot_sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

{
  "data": {
    "api_v2_token": "KEY0189A1B2C3D4E5F6071829AB3C4D5E_5FhZonmFvcw8Yq0dME27Bg"
  }
}

{
  "errors": [
    {
      "detail": "Account could not be initialized"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Your sign-in link has expired. Please request a new one-time sign-in link."
    }
  ]
}

{
  "errors": [
    {
      "detail": "Your registration cannot be accepted as it does not comply with our security standards. You may contact support for assistance."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "The requested resource or URL could not be found.",
      "source": {
        "pointer": "/"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10005"
      }
    }
  ]
}

Account & Billing

Video

SETI

Fax

OAuth

Bot Signup

For AI Agents

Exchange a magic link token for a session

Query Parameters

Response