SIP Credentials
Create SIP Credentials
Creates new SIP credentials for the specified organization.
POST
/
api
/
v1
/
vendors
/
{vendorId}
/
organizations
/
{organizationId}
/
sip
/
credentials
Create SIP Credentials
curl --request POST \
--url https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials \
--header 'Content-Type: application/json' \
--data '
{
"hostname": "sipconnect.sipgate.de",
"port": 5060,
"username": "agent001",
"password": "strong-password",
"maxAgentTasks": 10
}
'import requests
url = "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials"
payload = {
"hostname": "sipconnect.sipgate.de",
"port": 5060,
"username": "agent001",
"password": "strong-password",
"maxAgentTasks": 10
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
hostname: 'sipconnect.sipgate.de',
port: 5060,
username: 'agent001',
password: 'strong-password',
maxAgentTasks: 10
})
};
fetch('https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials', 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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials",
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([
'hostname' => 'sipconnect.sipgate.de',
'port' => 5060,
'username' => 'agent001',
'password' => 'strong-password',
'maxAgentTasks' => 10
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials"
payload := strings.NewReader("{\n \"hostname\": \"sipconnect.sipgate.de\",\n \"port\": 5060,\n \"username\": \"agent001\",\n \"password\": \"strong-password\",\n \"maxAgentTasks\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials")
.header("Content-Type", "application/json")
.body("{\n \"hostname\": \"sipconnect.sipgate.de\",\n \"port\": 5060,\n \"username\": \"agent001\",\n \"password\": \"strong-password\",\n \"maxAgentTasks\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"hostname\": \"sipconnect.sipgate.de\",\n \"port\": 5060,\n \"username\": \"agent001\",\n \"password\": \"strong-password\",\n \"maxAgentTasks\": 10\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": "2025-04-17T14:23:30Z",
"message": "<string>",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"hostname": "sip.example.com",
"port": 5060,
"username": "agent001",
"maxAgentTasks": 5
},
"traceId": "<string>"
}Path Parameters
ID of the Vendor (UUID)
ID of the Organization (UUID)
Body
application/json
Data required to create or update SIP credentials.
Hostname or IP address of the SIP server.
Example:
"sipconnect.sipgate.de"
Port of the SIP server.
Required range:
1 <= x <= 65535Example:
5060
Username for the SIP account.
Example:
"agent001"
Password for the SIP account.
Example:
"strong-password"
Maximum simultaneous agent tasks allowed for these credentials.
Required range:
x >= 1Example:
10
Response
SIP credentials created successfully
Standard API response wrapper
Indicates if the request was successful
Example:
true
Response timestamp in ISO-8601 format
Example:
"2025-04-17T14:23:30Z"
Human-readable message
Payload data object
Show child attributes
Show child attributes
Correlation or trace ID
Was this page helpful?
⌘I
Create SIP Credentials
curl --request POST \
--url https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials \
--header 'Content-Type: application/json' \
--data '
{
"hostname": "sipconnect.sipgate.de",
"port": 5060,
"username": "agent001",
"password": "strong-password",
"maxAgentTasks": 10
}
'import requests
url = "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials"
payload = {
"hostname": "sipconnect.sipgate.de",
"port": 5060,
"username": "agent001",
"password": "strong-password",
"maxAgentTasks": 10
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
hostname: 'sipconnect.sipgate.de',
port: 5060,
username: 'agent001',
password: 'strong-password',
maxAgentTasks: 10
})
};
fetch('https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials', 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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials",
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([
'hostname' => 'sipconnect.sipgate.de',
'port' => 5060,
'username' => 'agent001',
'password' => 'strong-password',
'maxAgentTasks' => 10
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials"
payload := strings.NewReader("{\n \"hostname\": \"sipconnect.sipgate.de\",\n \"port\": 5060,\n \"username\": \"agent001\",\n \"password\": \"strong-password\",\n \"maxAgentTasks\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials")
.header("Content-Type", "application/json")
.body("{\n \"hostname\": \"sipconnect.sipgate.de\",\n \"port\": 5060,\n \"username\": \"agent001\",\n \"password\": \"strong-password\",\n \"maxAgentTasks\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/sip/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"hostname\": \"sipconnect.sipgate.de\",\n \"port\": 5060,\n \"username\": \"agent001\",\n \"password\": \"strong-password\",\n \"maxAgentTasks\": 10\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": "2025-04-17T14:23:30Z",
"message": "<string>",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"hostname": "sip.example.com",
"port": 5060,
"username": "agent001",
"maxAgentTasks": 5
},
"traceId": "<string>"
}