Store provider credentials
curl --request PUT \
--url https://apiv2.vodex.ai/v1/sms/providers/{provider} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"messagingServiceSid": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"accountId": "<string>",
"campaignId": "<string>",
"from": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/sms/providers/{provider}"
payload = {
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"messagingServiceSid": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"accountId": "<string>",
"campaignId": "<string>",
"from": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accountSid: '<string>',
apiKeySid: '<string>',
apiKeySecret: '<string>',
authToken: '<string>',
messagingServiceSid: '<string>',
apiKey: '<string>',
apiSecret: '<string>',
accountId: '<string>',
campaignId: '<string>',
from: '<string>'
})
};
fetch('https://apiv2.vodex.ai/v1/sms/providers/{provider}', 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://apiv2.vodex.ai/v1/sms/providers/{provider}",
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([
'accountSid' => '<string>',
'apiKeySid' => '<string>',
'apiKeySecret' => '<string>',
'authToken' => '<string>',
'messagingServiceSid' => '<string>',
'apiKey' => '<string>',
'apiSecret' => '<string>',
'accountId' => '<string>',
'campaignId' => '<string>',
'from' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://apiv2.vodex.ai/v1/sms/providers/{provider}"
payload := strings.NewReader("{\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://apiv2.vodex.ai/v1/sms/providers/{provider}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/sms/providers/{provider}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"provider": "<string>",
"accountRef": "<string>",
"webhookUrl": "<string>"
}{
"error": "not found"
}{
"error": "not found"
}{
"error": "not found"
}SMS
Store provider credentials
Verified against the provider before storing (Twilio and Vonage) — a typo’d token stored now is a failed send with a worse error later. The value goes to Secret Manager; only the reference and a fingerprint are kept.
Twilio has an overlay mode: posting only messagingServiceSid (no
account credentials) stores just that extra on top of the connected
Twilio carrier integration, which continues to own the credentials.
The delivery-receipt token outlives credential rotation, because the URL is pasted into the provider’s dashboard and must not change when a key does.
PUT
/
sms
/
providers
/
{provider}
Store provider credentials
curl --request PUT \
--url https://apiv2.vodex.ai/v1/sms/providers/{provider} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"messagingServiceSid": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"accountId": "<string>",
"campaignId": "<string>",
"from": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/sms/providers/{provider}"
payload = {
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"messagingServiceSid": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"accountId": "<string>",
"campaignId": "<string>",
"from": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accountSid: '<string>',
apiKeySid: '<string>',
apiKeySecret: '<string>',
authToken: '<string>',
messagingServiceSid: '<string>',
apiKey: '<string>',
apiSecret: '<string>',
accountId: '<string>',
campaignId: '<string>',
from: '<string>'
})
};
fetch('https://apiv2.vodex.ai/v1/sms/providers/{provider}', 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://apiv2.vodex.ai/v1/sms/providers/{provider}",
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([
'accountSid' => '<string>',
'apiKeySid' => '<string>',
'apiKeySecret' => '<string>',
'authToken' => '<string>',
'messagingServiceSid' => '<string>',
'apiKey' => '<string>',
'apiSecret' => '<string>',
'accountId' => '<string>',
'campaignId' => '<string>',
'from' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://apiv2.vodex.ai/v1/sms/providers/{provider}"
payload := strings.NewReader("{\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://apiv2.vodex.ai/v1/sms/providers/{provider}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/sms/providers/{provider}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"provider": "<string>",
"accountRef": "<string>",
"webhookUrl": "<string>"
}{
"error": "not found"
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Path Parameters
Available options:
twilio, vonage, pronto_connects Body
application/json
Twilio (AC…).
Twilio (MG…); alone = overlay mode.
Vonage / Pronto.
Vonage.
Pronto.
Pronto.
Pronto default sender (E.164).