Skip to main content
POST
/
v1
/
calls
Create a call
curl --request POST \
  --url https://api.eu.volubile.ai/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipient": {
    "phone": "+33612345678",
    "context": {
      "firstName": "firstname",
      "lastName": "lastname",
      "orderNumber": "5HZ99FRT"
    },
    "segmentationTags": [
      "reg:aura",
      "client:165265",
      "existing-customer"
    ]
  },
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

url = "https://api.eu.volubile.ai/v1/calls"

payload = {
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient": {
"phone": "+33612345678",
"context": {
"firstName": "firstname",
"lastName": "lastname",
"orderNumber": "5HZ99FRT"
},
"segmentationTags": ["reg:aura", "client:165265", "existing-customer"]
},
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipient: {
phone: '+33612345678',
context: {firstName: 'firstname', lastName: 'lastname', orderNumber: '5HZ99FRT'},
segmentationTags: ['reg:aura', 'client:165265', 'existing-customer']
},
campaignId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};

fetch('https://api.eu.volubile.ai/v1/calls', 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.eu.volubile.ai/v1/calls",
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([
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipient' => [
'phone' => '+33612345678',
'context' => [
'firstName' => 'firstname',
'lastName' => 'lastname',
'orderNumber' => '5HZ99FRT'
],
'segmentationTags' => [
'reg:aura',
'client:165265',
'existing-customer'
]
],
'campaignId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.eu.volubile.ai/v1/calls"

payload := strings.NewReader("{\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"phone\": \"+33612345678\",\n \"context\": {\n \"firstName\": \"firstname\",\n \"lastName\": \"lastname\",\n \"orderNumber\": \"5HZ99FRT\"\n },\n \"segmentationTags\": [\n \"reg:aura\",\n \"client:165265\",\n \"existing-customer\"\n ]\n },\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

req.Header.Add("X-Api-Key", "<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.eu.volubile.ai/v1/calls")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"phone\": \"+33612345678\",\n \"context\": {\n \"firstName\": \"firstname\",\n \"lastName\": \"lastname\",\n \"orderNumber\": \"5HZ99FRT\"\n },\n \"segmentationTags\": [\n \"reg:aura\",\n \"client:165265\",\n \"existing-customer\"\n ]\n },\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.eu.volubile.ai/v1/calls")

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

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipient\": {\n \"phone\": \"+33612345678\",\n \"context\": {\n \"firstName\": \"firstname\",\n \"lastName\": \"lastname\",\n \"orderNumber\": \"5HZ99FRT\"\n },\n \"segmentationTags\": [\n \"reg:aura\",\n \"client:165265\",\n \"existing-customer\"\n ]\n },\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}
{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"message": "<string>",
"errors": [
{
"field": "<string>",
"rejectedValue": {},
"message": "<string>"
}
]
}
{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"message": "<string>",
"errors": [
{
"field": "<string>",
"rejectedValue": {},
"message": "<string>"
}
]
}
{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"message": "<string>",
"errors": [
{
"field": "<string>",
"rejectedValue": {},
"message": "<string>"
}
]
}

Authorizations

X-Api-Key
string
header
required

Your API key.

Body

application/json
agentId
string<uuid>
required

Unique identifier of the OUTBOUND agent to use for the call

recipient
object
required

Recipient to call

campaignId
string<uuid>

Unique identifier of a callback campaign

Response

Created