State of a channel

# Copy for LLM

Get the state of a channel

Authorization Parameters

No authentication required

key path · string *

channel key

Responses

200

Channel state

Response schema

statestring

Channel state

enum: HANGUP RINGING ANSWERED

example: HANGUP

get https://{username}.voxbi.cloud/api/{version}/calls/channelstate/{key}

Base URL https://{username}.voxbi.cloud/api/{version}

Request sample cURL JavaScript Python PHP

Copy

curl -X GET 'https://{username}.voxbi.cloud/api/{version}/calls/channelstate/{key}'

Copy

const response = await fetch('https://{username}.voxbi.cloud/api/{version}/calls/channelstate/{key}', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Copy

import requests

response = requests.get('https://{username}.voxbi.cloud/api/{version}/calls/channelstate/{key}')
response.raise_for_status()
data = response.json()
print(data)

Copy

<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json",
    ],
]);

$response = file_get_contents('https://{username}.voxbi.cloud/api/{version}/calls/channelstate/{key}', false, $context);
$data = json_decode($response, true);
print_r($data);

Sample response

No example for this status.