Obtiene detalles de una llamada

curl --request GET \
  --url https://{your-prod-endpoint}/api/v1/calls/{id} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://{your-prod-endpoint}/api/v1/calls/{id}', 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://{your-prod-endpoint}/api/v1/calls/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$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://{your-prod-endpoint}/api/v1/calls/{id}"

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

	req.Header.Add("X-Api-Key", "<api-key>")

	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://{your-prod-endpoint}/api/v1/calls/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "call": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "apiKeyId": "<string>",
      "endUserId": "<string>",
      "questionnaireInstanceId": "<string>",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "schedulingWindow": {
        "date": "<string>",
        "startTime": "<string>",
        "endTime": "<string>",
        "allowedDaysOfWeek": [
          3
        ]
      },
      "transcription": [
        {
          "content": "<string>",
          "time": "2023-11-07T05:31:56Z"
        }
      ],
      "summary": "<string>",
      "transferReason": "<string>",
      "userIntent": "<string>",
      "callResult": "<string>"
    }
  }
}

{
  "status": "error",
  "code": 123,
  "error_code": "<string>",
  "message": "<string>"
}

GET

api

calls

{id}

Obtiene detalles de una llamada

curl --request GET \
  --url https://{your-prod-endpoint}/api/v1/calls/{id} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://{your-prod-endpoint}/api/v1/calls/{id}', 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://{your-prod-endpoint}/api/v1/calls/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$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://{your-prod-endpoint}/api/v1/calls/{id}"

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

	req.Header.Add("X-Api-Key", "<api-key>")

	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://{your-prod-endpoint}/api/v1/calls/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "call": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "apiKeyId": "<string>",
      "endUserId": "<string>",
      "questionnaireInstanceId": "<string>",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "schedulingWindow": {
        "date": "<string>",
        "startTime": "<string>",
        "endTime": "<string>",
        "allowedDaysOfWeek": [
          3
        ]
      },
      "transcription": [
        {
          "content": "<string>",
          "time": "2023-11-07T05:31:56Z"
        }
      ],
      "summary": "<string>",
      "transferReason": "<string>",
      "userIntent": "<string>",
      "callResult": "<string>"
    }
  }
}

{
  "status": "error",
  "code": 123,
  "error_code": "<string>",
  "message": "<string>"
}

Autorizaciones

X-Api-Key

string

header

requerido

API Key proporcionada por Omniloy. La misma key se usa para llamadas entrantes y salientes.

Parámetros de ruta

string<uuid>

requerido

Respuesta

Datos de la llamada

success

boolean

data

object

Show child attributes

Eventos e integraciones

Referencia de API

Obtiene detalles de una llamada

Autorizaciones

Parámetros de ruta

Respuesta