Skip to main content
POST
/
v1
/
voice-agents
/
web-tool
/
version-check
Check for newer versions of Web Tools.
curl --request POST \
  --url https://api.tryhamsa.com/v1/voice-agents/web-tool/version-check \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webToolIds": [
    "d949f13f-40d2-4e48-ac86-b66633070603",
    "a123b456-78cd-9012-ef34-56789abcdef0"
  ]
}
'
import requests

url = "https://api.tryhamsa.com/v1/voice-agents/web-tool/version-check"

payload = { "webToolIds": ["d949f13f-40d2-4e48-ac86-b66633070603", "a123b456-78cd-9012-ef34-56789abcdef0"] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
webToolIds: ['d949f13f-40d2-4e48-ac86-b66633070603', 'a123b456-78cd-9012-ef34-56789abcdef0']
})
};

fetch('https://api.tryhamsa.com/v1/voice-agents/web-tool/version-check', 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.tryhamsa.com/v1/voice-agents/web-tool/version-check",
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([
'webToolIds' => [
'd949f13f-40d2-4e48-ac86-b66633070603',
'a123b456-78cd-9012-ef34-56789abcdef0'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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://api.tryhamsa.com/v1/voice-agents/web-tool/version-check"

payload := strings.NewReader("{\n \"webToolIds\": [\n \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"a123b456-78cd-9012-ef34-56789abcdef0\"\n ]\n}")

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

req.Header.Add("Authorization", "<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://api.tryhamsa.com/v1/voice-agents/web-tool/version-check")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webToolIds\": [\n \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"a123b456-78cd-9012-ef34-56789abcdef0\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.tryhamsa.com/v1/voice-agents/web-tool/version-check")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webToolIds\": [\n \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"a123b456-78cd-9012-ef34-56789abcdef0\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Success",
  "data": [
    {
      "webToolId": "d949f13f-40d2-4e48-ac86-b66633070603",
      "currentVersion": "1.0.0",
      "latestVersion": "1.2.0",
      "hasUpdate": true
    }
  ]
}
{
"code": 123,
"message": "<string>"
}
{
"code": 123,
"message": "<string>"
}
{
"code": 123,
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json
webToolIds
string<uuid>[]
required

Array of web tool UUIDs to check for version updates.

Example:
[
"d949f13f-40d2-4e48-ac86-b66633070603",
"a123b456-78cd-9012-ef34-56789abcdef0"
]

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"Success"

data
object[]