curl --request PUT \
--url https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": {
"enabled": true,
"useDefault": false,
"fileAudioSource": {
"fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage": {
"enabled": true,
"audioSourceType": "TTS",
"ttsAudioSource": {
"text": "You're are being transferred...",
"language": "en",
"voice": {
"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": null,
"repeatInterval": {
"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}
EOFimport requests
url = "https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy"
payload = {
"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": {
"enabled": True,
"useDefault": False,
"fileAudioSource": { "fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb" }
},
"announcementMessage": {
"enabled": True,
"audioSourceType": "TTS",
"ttsAudioSource": {
"text": "You're are being transferred...",
"language": "en",
"voice": {
"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": None,
"repeatInterval": {
"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"id\": \"642bf5f4ff5dd177aeb00889\",\n \"musicOnHold\": {\n \"enabled\": true,\n \"useDefault\": false,\n \"fileAudioSource\": {\n \"fileDescriptor\": \"f829e911-8439-4321-aa25-23b321e1a9cb\"\n }\n },\n \"announcementMessage\": {\n \"enabled\": true,\n \"audioSourceType\": \"TTS\",\n \"ttsAudioSource\": {\n \"text\": \"You're are being transferred...\",\n \"language\": \"en\",\n \"voice\": {\n \"name\": \"Joanna\",\n \"gender\": \"FEMALE\"\n },\n \"speechRate\": 1\n },\n \"fileAudioSource\": null,\n \"repeatInterval\": {\n \"unit\": \"SECONDS\",\n \"value\": 5\n }\n },\n \"createdAt\": \"2023-04-04T10:03:32.729Z\",\n \"updatedAt\": \"2023-04-06T11:22:18.149Z\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.put("https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"642bf5f4ff5dd177aeb00889\",\n \"musicOnHold\": {\n \"enabled\": true,\n \"useDefault\": false,\n \"fileAudioSource\": {\n \"fileDescriptor\": \"f829e911-8439-4321-aa25-23b321e1a9cb\"\n }\n },\n \"announcementMessage\": {\n \"enabled\": true,\n \"audioSourceType\": \"TTS\",\n \"ttsAudioSource\": {\n \"text\": \"You're are being transferred...\",\n \"language\": \"en\",\n \"voice\": {\n \"name\": \"Joanna\",\n \"gender\": \"FEMALE\"\n },\n \"speechRate\": 1\n },\n \"fileAudioSource\": null,\n \"repeatInterval\": {\n \"unit\": \"SECONDS\",\n \"value\": 5\n }\n },\n \"createdAt\": \"2023-04-04T10:03:32.729Z\",\n \"updatedAt\": \"2023-04-06T11:22:18.149Z\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '642bf5f4ff5dd177aeb00889',
'musicOnHold' => [
'enabled' => true,
'useDefault' => false,
'fileAudioSource' => [
'fileDescriptor' => 'f829e911-8439-4321-aa25-23b321e1a9cb'
]
],
'announcementMessage' => [
'enabled' => true,
'audioSourceType' => 'TTS',
'ttsAudioSource' => [
'text' => 'You\'re are being transferred...',
'language' => 'en',
'voice' => [
'name' => 'Joanna',
'gender' => 'FEMALE'
],
'speechRate' => 1
],
'fileAudioSource' => null,
'repeatInterval' => [
'unit' => 'SECONDS',
'value' => 5
]
],
'createdAt' => '2023-04-04T10:03:32.729Z',
'updatedAt' => '2023-04-06T11:22:18.149Z'
]),
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: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '642bf5f4ff5dd177aeb00889',
musicOnHold: {
enabled: true,
useDefault: false,
fileAudioSource: {fileDescriptor: 'f829e911-8439-4321-aa25-23b321e1a9cb'}
},
announcementMessage: {
enabled: true,
audioSourceType: 'TTS',
ttsAudioSource: {
text: 'You\'re are being transferred...',
language: 'en',
voice: {name: 'Joanna', gender: 'FEMALE'},
speechRate: 1
},
fileAudioSource: null,
repeatInterval: {unit: 'SECONDS', value: 5}
},
createdAt: '2023-04-04T10:03:32.729Z',
updatedAt: '2023-04-06T11:22:18.149Z'
})
};
fetch('https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": {
"enabled": true,
"useDefault": false,
"fileAudioSource": {
"fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage": {
"enabled": true,
"audioSourceType": "TTS",
"ttsAudioSource": {
"text": "You're are being transferred...",
"language": "en",
"voice": {
"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": null,
"repeatInterval": {
"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}{
"status": "ERROR",
"message": "Empty or invalid request payload"
}{
"requestError": {
"serviceException": {
"messageId": "UNAUTHORIZED",
"text": "Unauthorized"
}
}
}{
"requestError": {
"serviceException": {
"messageId": "FORBIDDEN",
"text": "Forbidden"
}
}
}{
"requestError": {
"serviceException": {
"messageId": "TOO_MANY_REQUESTS",
"text": "Too many requests"
}
}
}{
"requestError": {
"serviceException": {
"messageId": "GENERAL_ERROR",
"text": "Something went wrong. Please contact support."
}
}
}Update transfer strategy
Use this endpoint to update an already existing Transfer Strategy. More info.
Required scope: Enable one of: conversations:manage.
curl --request PUT \
--url https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": {
"enabled": true,
"useDefault": false,
"fileAudioSource": {
"fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage": {
"enabled": true,
"audioSourceType": "TTS",
"ttsAudioSource": {
"text": "You're are being transferred...",
"language": "en",
"voice": {
"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": null,
"repeatInterval": {
"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}
EOFimport requests
url = "https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy"
payload = {
"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": {
"enabled": True,
"useDefault": False,
"fileAudioSource": { "fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb" }
},
"announcementMessage": {
"enabled": True,
"audioSourceType": "TTS",
"ttsAudioSource": {
"text": "You're are being transferred...",
"language": "en",
"voice": {
"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": None,
"repeatInterval": {
"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"id\": \"642bf5f4ff5dd177aeb00889\",\n \"musicOnHold\": {\n \"enabled\": true,\n \"useDefault\": false,\n \"fileAudioSource\": {\n \"fileDescriptor\": \"f829e911-8439-4321-aa25-23b321e1a9cb\"\n }\n },\n \"announcementMessage\": {\n \"enabled\": true,\n \"audioSourceType\": \"TTS\",\n \"ttsAudioSource\": {\n \"text\": \"You're are being transferred...\",\n \"language\": \"en\",\n \"voice\": {\n \"name\": \"Joanna\",\n \"gender\": \"FEMALE\"\n },\n \"speechRate\": 1\n },\n \"fileAudioSource\": null,\n \"repeatInterval\": {\n \"unit\": \"SECONDS\",\n \"value\": 5\n }\n },\n \"createdAt\": \"2023-04-04T10:03:32.729Z\",\n \"updatedAt\": \"2023-04-06T11:22:18.149Z\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.put("https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"642bf5f4ff5dd177aeb00889\",\n \"musicOnHold\": {\n \"enabled\": true,\n \"useDefault\": false,\n \"fileAudioSource\": {\n \"fileDescriptor\": \"f829e911-8439-4321-aa25-23b321e1a9cb\"\n }\n },\n \"announcementMessage\": {\n \"enabled\": true,\n \"audioSourceType\": \"TTS\",\n \"ttsAudioSource\": {\n \"text\": \"You're are being transferred...\",\n \"language\": \"en\",\n \"voice\": {\n \"name\": \"Joanna\",\n \"gender\": \"FEMALE\"\n },\n \"speechRate\": 1\n },\n \"fileAudioSource\": null,\n \"repeatInterval\": {\n \"unit\": \"SECONDS\",\n \"value\": 5\n }\n },\n \"createdAt\": \"2023-04-04T10:03:32.729Z\",\n \"updatedAt\": \"2023-04-06T11:22:18.149Z\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '642bf5f4ff5dd177aeb00889',
'musicOnHold' => [
'enabled' => true,
'useDefault' => false,
'fileAudioSource' => [
'fileDescriptor' => 'f829e911-8439-4321-aa25-23b321e1a9cb'
]
],
'announcementMessage' => [
'enabled' => true,
'audioSourceType' => 'TTS',
'ttsAudioSource' => [
'text' => 'You\'re are being transferred...',
'language' => 'en',
'voice' => [
'name' => 'Joanna',
'gender' => 'FEMALE'
],
'speechRate' => 1
],
'fileAudioSource' => null,
'repeatInterval' => [
'unit' => 'SECONDS',
'value' => 5
]
],
'createdAt' => '2023-04-04T10:03:32.729Z',
'updatedAt' => '2023-04-06T11:22:18.149Z'
]),
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: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '642bf5f4ff5dd177aeb00889',
musicOnHold: {
enabled: true,
useDefault: false,
fileAudioSource: {fileDescriptor: 'f829e911-8439-4321-aa25-23b321e1a9cb'}
},
announcementMessage: {
enabled: true,
audioSourceType: 'TTS',
ttsAudioSource: {
text: 'You\'re are being transferred...',
language: 'en',
voice: {name: 'Joanna', gender: 'FEMALE'},
speechRate: 1
},
fileAudioSource: null,
repeatInterval: {unit: 'SECONDS', value: 5}
},
createdAt: '2023-04-04T10:03:32.729Z',
updatedAt: '2023-04-06T11:22:18.149Z'
})
};
fetch('https://api.messaging.phonovation.com/ccaas/voice/2/transfer-configs/transfer-strategy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": {
"enabled": true,
"useDefault": false,
"fileAudioSource": {
"fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage": {
"enabled": true,
"audioSourceType": "TTS",
"ttsAudioSource": {
"text": "You're are being transferred...",
"language": "en",
"voice": {
"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": null,
"repeatInterval": {
"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}{
"status": "ERROR",
"message": "Empty or invalid request payload"
}{
"requestError": {
"serviceException": {
"messageId": "UNAUTHORIZED",
"text": "Unauthorized"
}
}
}{
"requestError": {
"serviceException": {
"messageId": "FORBIDDEN",
"text": "Forbidden"
}
}
}{
"requestError": {
"serviceException": {
"messageId": "TOO_MANY_REQUESTS",
"text": "Too many requests"
}
}
}{
"requestError": {
"serviceException": {
"messageId": "GENERAL_ERROR",
"text": "Something went wrong. Please contact support."
}
}
}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
Response
OK
Unique id of the transfer strategy.
File audio source information.
Show child attributes
Show child attributes
File audio source or TTS audio source information with repeat interval.
Show child attributes
Show child attributes
"2023-04-04T10:03:32.729+0000"
"2023-04-06T11:22:18.149+0000"