Create an SMS configuration
curl --request POST \
--url https://apiv2.vodex.ai/v1/sms/configurations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"senderId": "<string>",
"templateId": "<string>",
"body": "<string>",
"isDefault": false
}
'import requests
url = "https://apiv2.vodex.ai/v1/sms/configurations"
payload = {
"name": "<string>",
"senderId": "<string>",
"templateId": "<string>",
"body": "<string>",
"isDefault": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
senderId: '<string>',
templateId: '<string>',
body: JSON.stringify('<string>'),
isDefault: false
})
};
fetch('https://apiv2.vodex.ai/v1/sms/configurations', 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/configurations",
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([
'name' => '<string>',
'senderId' => '<string>',
'templateId' => '<string>',
'body' => '<string>',
'isDefault' => false
]),
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/configurations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"senderId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"body\": \"<string>\",\n \"isDefault\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://apiv2.vodex.ai/v1/sms/configurations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"senderId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"body\": \"<string>\",\n \"isDefault\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/sms/configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"senderId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"body\": \"<string>\",\n \"isDefault\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"providerKey": "twilio",
"senderKind": "messaging_service",
"senderId": "<string>",
"templateId": "<string>",
"body": "<string>",
"variables": [
"<string>"
],
"isDefault": true,
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "not found"
}{
"error": "not found"
}SMS
Create an SMS configuration
A configuration carries a provider templateId XOR a free-text
body, never both. senderId must match senderKind: an MG… SID for
a messaging service, an E.164 for a fixed number, and either an E.164 or
nothing for provider_managed (Pronto’s campaign number).
Exactly one configuration per tenant is the default. A new Pronto config gets the seed template id, because Pronto requires a template.
POST
/
sms
/
configurations
Create an SMS configuration
curl --request POST \
--url https://apiv2.vodex.ai/v1/sms/configurations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"senderId": "<string>",
"templateId": "<string>",
"body": "<string>",
"isDefault": false
}
'import requests
url = "https://apiv2.vodex.ai/v1/sms/configurations"
payload = {
"name": "<string>",
"senderId": "<string>",
"templateId": "<string>",
"body": "<string>",
"isDefault": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
senderId: '<string>',
templateId: '<string>',
body: JSON.stringify('<string>'),
isDefault: false
})
};
fetch('https://apiv2.vodex.ai/v1/sms/configurations', 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/configurations",
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([
'name' => '<string>',
'senderId' => '<string>',
'templateId' => '<string>',
'body' => '<string>',
'isDefault' => false
]),
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/configurations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"senderId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"body\": \"<string>\",\n \"isDefault\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://apiv2.vodex.ai/v1/sms/configurations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"senderId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"body\": \"<string>\",\n \"isDefault\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/sms/configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"senderId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"body\": \"<string>\",\n \"isDefault\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"providerKey": "twilio",
"senderKind": "messaging_service",
"senderId": "<string>",
"templateId": "<string>",
"body": "<string>",
"variables": [
"<string>"
],
"isDefault": true,
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Body
application/json
Maximum string length:
200Available options:
twilio, vonage, pronto_connects Available options:
messaging_service, number, provider_managed Maximum string length:
1600Response
Created.
Available options:
twilio, vonage, pronto_connects Available options:
messaging_service, number, provider_managed Tokens the body references, in order of first appearance.