Handover Providers
Create a Handover Provider
Creates a handover provider in a Project.
POST
/
v2.0
/
handover
/
providers
Create a Handover Provider
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/handover/providers \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"_id": "<string>",
"referenceId": "<string>",
"organisationId": "<string>",
"serviceId": "<string>",
"service": "<string>",
"name": "<string>",
"createdAt": 123,
"lastChangedAt": 123,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"properties": [
{}
],
"settings": {},
"projectId": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/handover/providers"
payload = {
"_id": "<string>",
"referenceId": "<string>",
"organisationId": "<string>",
"serviceId": "<string>",
"service": "<string>",
"name": "<string>",
"createdAt": 123,
"lastChangedAt": 123,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"properties": [{}],
"settings": {},
"projectId": "<string>"
}
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({
_id: '<string>',
referenceId: '<string>',
organisationId: '<string>',
serviceId: '<string>',
service: '<string>',
name: '<string>',
createdAt: 123,
lastChangedAt: 123,
createdBy: '<string>',
lastChangedBy: '<string>',
properties: [{}],
settings: {},
projectId: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/handover/providers', 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-trial.cognigy.ai/new/v2.0/handover/providers",
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([
'_id' => '<string>',
'referenceId' => '<string>',
'organisationId' => '<string>',
'serviceId' => '<string>',
'service' => '<string>',
'name' => '<string>',
'createdAt' => 123,
'lastChangedAt' => 123,
'createdBy' => '<string>',
'lastChangedBy' => '<string>',
'properties' => [
[
]
],
'settings' => [
],
'projectId' => '<string>'
]),
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-trial.cognigy.ai/new/v2.0/handover/providers"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"serviceId\": \"<string>\",\n \"service\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": 123,\n \"lastChangedAt\": 123,\n \"createdBy\": \"<string>\",\n \"lastChangedBy\": \"<string>\",\n \"properties\": [\n {}\n ],\n \"settings\": {},\n \"projectId\": \"<string>\"\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-trial.cognigy.ai/new/v2.0/handover/providers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"serviceId\": \"<string>\",\n \"service\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": 123,\n \"lastChangedAt\": 123,\n \"createdBy\": \"<string>\",\n \"lastChangedBy\": \"<string>\",\n \"properties\": [\n {}\n ],\n \"settings\": {},\n \"projectId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/handover/providers")
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 \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"serviceId\": \"<string>\",\n \"service\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": 123,\n \"lastChangedAt\": 123,\n \"createdBy\": \"<string>\",\n \"lastChangedBy\": \"<string>\",\n \"properties\": [\n {}\n ],\n \"settings\": {},\n \"projectId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"referenceId": "<string>",
"organisationId": "<string>",
"serviceId": "<string>",
"service": "<string>",
"name": "<string>",
"createdAt": 123,
"lastChangedAt": 123,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"properties": [
{}
],
"settings": {}
}{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Unauthorized",
"title": "Unauthorized Error",
"status": 401,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 401,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payment Required",
"title": "Payment Required Error",
"status": 402,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 402,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Forbidden",
"title": "Forbidden Error",
"status": 403,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Found",
"title": "Not Found Error",
"status": 404,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {},
"logLevel": "error"
}{
"type": "Method Not Allowed",
"title": "Method Not Allowed Error",
"status": 405,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Conflict",
"title": "Conflict Error",
"status": 409,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1004,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payload Too Large",
"title": "Payload Too Large Error",
"status": 413,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Internal Server Error",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Implemented",
"title": "Not Implemented Error",
"status": 501,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1009,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Bad Gateway",
"title": "Bad Gateway Error",
"status": 502,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Service Unavailable",
"title": "Service Unavailable Error",
"status": 503,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 503,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Gateway Timeout",
"title": "Gateway Timeout Error",
"status": 504,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}Authorizations
APIKeyHeaderAPIKeyQueryParamCXoneTokenHeader
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
Available options:
application/json, application/hal+json, application/xml, text/xml, text/csv Body
application/json
Response
Returns the handover provider object.
⌘I
Create a Handover Provider
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/handover/providers \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"_id": "<string>",
"referenceId": "<string>",
"organisationId": "<string>",
"serviceId": "<string>",
"service": "<string>",
"name": "<string>",
"createdAt": 123,
"lastChangedAt": 123,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"properties": [
{}
],
"settings": {},
"projectId": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/handover/providers"
payload = {
"_id": "<string>",
"referenceId": "<string>",
"organisationId": "<string>",
"serviceId": "<string>",
"service": "<string>",
"name": "<string>",
"createdAt": 123,
"lastChangedAt": 123,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"properties": [{}],
"settings": {},
"projectId": "<string>"
}
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({
_id: '<string>',
referenceId: '<string>',
organisationId: '<string>',
serviceId: '<string>',
service: '<string>',
name: '<string>',
createdAt: 123,
lastChangedAt: 123,
createdBy: '<string>',
lastChangedBy: '<string>',
properties: [{}],
settings: {},
projectId: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/handover/providers', 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-trial.cognigy.ai/new/v2.0/handover/providers",
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([
'_id' => '<string>',
'referenceId' => '<string>',
'organisationId' => '<string>',
'serviceId' => '<string>',
'service' => '<string>',
'name' => '<string>',
'createdAt' => 123,
'lastChangedAt' => 123,
'createdBy' => '<string>',
'lastChangedBy' => '<string>',
'properties' => [
[
]
],
'settings' => [
],
'projectId' => '<string>'
]),
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-trial.cognigy.ai/new/v2.0/handover/providers"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"serviceId\": \"<string>\",\n \"service\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": 123,\n \"lastChangedAt\": 123,\n \"createdBy\": \"<string>\",\n \"lastChangedBy\": \"<string>\",\n \"properties\": [\n {}\n ],\n \"settings\": {},\n \"projectId\": \"<string>\"\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-trial.cognigy.ai/new/v2.0/handover/providers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"serviceId\": \"<string>\",\n \"service\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": 123,\n \"lastChangedAt\": 123,\n \"createdBy\": \"<string>\",\n \"lastChangedBy\": \"<string>\",\n \"properties\": [\n {}\n ],\n \"settings\": {},\n \"projectId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/handover/providers")
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 \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"serviceId\": \"<string>\",\n \"service\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": 123,\n \"lastChangedAt\": 123,\n \"createdBy\": \"<string>\",\n \"lastChangedBy\": \"<string>\",\n \"properties\": [\n {}\n ],\n \"settings\": {},\n \"projectId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"referenceId": "<string>",
"organisationId": "<string>",
"serviceId": "<string>",
"service": "<string>",
"name": "<string>",
"createdAt": 123,
"lastChangedAt": 123,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"properties": [
{}
],
"settings": {}
}{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Unauthorized",
"title": "Unauthorized Error",
"status": 401,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 401,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payment Required",
"title": "Payment Required Error",
"status": 402,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 402,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Forbidden",
"title": "Forbidden Error",
"status": 403,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Found",
"title": "Not Found Error",
"status": 404,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {},
"logLevel": "error"
}{
"type": "Method Not Allowed",
"title": "Method Not Allowed Error",
"status": 405,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Conflict",
"title": "Conflict Error",
"status": 409,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1004,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payload Too Large",
"title": "Payload Too Large Error",
"status": 413,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Internal Server Error",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Implemented",
"title": "Not Implemented Error",
"status": 501,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1009,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Bad Gateway",
"title": "Bad Gateway Error",
"status": 502,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Service Unavailable",
"title": "Service Unavailable Error",
"status": 503,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 503,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Gateway Timeout",
"title": "Gateway Timeout Error",
"status": 504,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}