curl --request POST \
--url https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "353861234574",
"to": "38761123123",
"agentId": "2010EA93ABC142E812C19F529BCBD22F",
"voiceClientType": "PSTN"
}
'import requests
url = "https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation"
payload = {
"from": "353861234574",
"to": "38761123123",
"agentId": "2010EA93ABC142E812C19F529BCBD22F",
"voiceClientType": "PSTN"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"from\": \"353861234574\",\n \"to\": \"38761123123\",\n \"agentId\": \"2010EA93ABC142E812C19F529BCBD22F\",\n \"voiceClientType\": \"PSTN\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"353861234574\",\n \"to\": \"38761123123\",\n \"agentId\": \"2010EA93ABC142E812C19F529BCBD22F\",\n \"voiceClientType\": \"PSTN\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation",
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([
'from' => '353861234574',
'to' => '38761123123',
'agentId' => '2010EA93ABC142E812C19F529BCBD22F',
'voiceClientType' => 'PSTN'
]),
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;
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: '353861234574',
to: '38761123123',
agentId: '2010EA93ABC142E812C19F529BCBD22F',
voiceClientType: 'PSTN'
})
};
fetch('https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"from": "353861234574",
"to": "38761123333",
"conversationId": "718A037A2FE0D2D5AA2D12A7240ED8C4",
"agentId": "2010EA93ABC142E812C19F529BCBD22F"
}Create outbound call conversation
Use this method to create a conversation associated with an outbound call. Expected usage is to trigger this endpoint and then start a call using the RTC SDK callConversations method. The created conversation ID is required when using the callConversations method to trigger an outbound call. Another option is to use the ID of a previously created call conversation. More info.
Required scope: Enable one of: conversations:manage.
curl --request POST \
--url https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "353861234574",
"to": "38761123123",
"agentId": "2010EA93ABC142E812C19F529BCBD22F",
"voiceClientType": "PSTN"
}
'import requests
url = "https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation"
payload = {
"from": "353861234574",
"to": "38761123123",
"agentId": "2010EA93ABC142E812C19F529BCBD22F",
"voiceClientType": "PSTN"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"from\": \"353861234574\",\n \"to\": \"38761123123\",\n \"agentId\": \"2010EA93ABC142E812C19F529BCBD22F\",\n \"voiceClientType\": \"PSTN\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"353861234574\",\n \"to\": \"38761123123\",\n \"agentId\": \"2010EA93ABC142E812C19F529BCBD22F\",\n \"voiceClientType\": \"PSTN\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation",
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([
'from' => '353861234574',
'to' => '38761123123',
'agentId' => '2010EA93ABC142E812C19F529BCBD22F',
'voiceClientType' => 'PSTN'
]),
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;
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: '353861234574',
to: '38761123123',
agentId: '2010EA93ABC142E812C19F529BCBD22F',
voiceClientType: 'PSTN'
})
};
fetch('https://api.messaging.phonovation.com/ccaas/voice/2/outbound-call-conversation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"from": "353861234574",
"to": "38761123333",
"conversationId": "718A037A2FE0D2D5AA2D12A7240ED8C4",
"agentId": "2010EA93ABC142E812C19F529BCBD22F"
}Authorizations
This is the most secure authorization type and the one with the most flexibility.
API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.
You can manage your API keys from GUI, or programmatically with dedicated API.
API key Authorization header example:
Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
Body
DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint.
Destination number.
Id of the agent originating the call.
Voice client type of the destination number.
PSTN, WEBRTC, WHATSAPP, VIBER, LIVE_CHAT Response
OK
DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint.
Destination number.
Id of the agent originating the call.
Id of the created conversation