Create Video Request Link

Generates a unique video request link with an empty request body or external parameters

POST /api/v1/video_request_links

Create Video Request Link

cURL

curl --request POST \
  --url https://app.videosupport.io/api/v1/video_request_links \
  --header 'Access-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://app.videosupport.io/api/v1/video_request_links"

payload = {}
headers = {
    "Access-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Access-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://app.videosupport.io/api/v1/video_request_links', 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://app.videosupport.io/api/v1/video_request_links",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Access-Token: <api-key>",
    "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://app.videosupport.io/api/v1/video_request_links"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Access-Token", "<api-key>")
	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://app.videosupport.io/api/v1/video_request_links")
  .header("Access-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.videosupport.io/api/v1/video_request_links")

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

request = Net::HTTP::Post.new(url)
request["Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

200

{
  "video_request_link": {
    "url": "https://app.videosupport.io/r/abd-def-ghi",
    "external_key": "abc-def-ghi",
    "external_parameters": {},
    "id": "f98a1fae-6a4c-43c3-bf16-example12345"
  },
  "api_version": "v1"
}

{
  "errors": [
    "Error message 1",
    "Error message 2"
  ]
}

This endpoint generates a unique video request link. The reponse contains the link.

You can also add external_parameters to the body of the POST request (such as conversation ID, user ID, e-mail, etc.). Those will be fetched and added to the webhook notification once a video has been recorded.

Authorizations

Access-Token · string · header · required

Body

application/json

Empty request body to create a video request link

The body is of type object.

Response

200

application/json

Video request link successfully created