Update the hosted-messaging inbound route
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inboundRoute": {
"type": "inbox",
"target": "inbox_01HZY8Q7"
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route"
payload = { "inboundRoute": {
"type": "inbox",
"target": "inbox_01HZY8Q7"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({inboundRoute: {type: 'inbox', target: 'inbox_01HZY8Q7'}})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route', 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.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'inboundRoute' => [
'type' => 'inbox',
'target' => 'inbox_01HZY8Q7'
]
]),
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://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route"
payload := strings.NewReader("{\n \"inboundRoute\": {\n \"type\": \"inbox\",\n \"target\": \"inbox_01HZY8Q7\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inboundRoute\": {\n \"type\": \"inbox\",\n \"target\": \"inbox_01HZY8Q7\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inboundRoute\": {\n \"type\": \"inbox\",\n \"target\": \"inbox_01HZY8Q7\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"phoneNumber": "<string>",
"voiceCarrier": "<string>",
"numberType": "landline",
"status": "draft",
"inboundRoute": {
"type": "webhook",
"target": "<string>"
},
"businessName": "<string>",
"loaFileUrl": "<string>",
"loaSignedAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"activatedAt": "2023-11-07T05:31:56Z",
"rejectionReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Numbers
Update the hosted-messaging inbound route
Change where inbound SMS on a hosted number is delivered, for an order that has not yet activated. Once the order is active the route is locked (open a new order to change live routing) and once it is rejected or cancelled it cannot be edited. Supply the new inboundRoute; the updated order is returned. Requires the numbers:write scope.
PATCH
/
api
/
v1
/
numbers
/
hosted-messaging
/
{id}
/
route
Update the hosted-messaging inbound route
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inboundRoute": {
"type": "inbox",
"target": "inbox_01HZY8Q7"
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route"
payload = { "inboundRoute": {
"type": "inbox",
"target": "inbox_01HZY8Q7"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({inboundRoute: {type: 'inbox', target: 'inbox_01HZY8Q7'}})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route', 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.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'inboundRoute' => [
'type' => 'inbox',
'target' => 'inbox_01HZY8Q7'
]
]),
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://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route"
payload := strings.NewReader("{\n \"inboundRoute\": {\n \"type\": \"inbox\",\n \"target\": \"inbox_01HZY8Q7\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inboundRoute\": {\n \"type\": \"inbox\",\n \"target\": \"inbox_01HZY8Q7\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/hosted-messaging/{id}/route")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inboundRoute\": {\n \"type\": \"inbox\",\n \"target\": \"inbox_01HZY8Q7\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"phoneNumber": "<string>",
"voiceCarrier": "<string>",
"numberType": "landline",
"status": "draft",
"inboundRoute": {
"type": "webhook",
"target": "<string>"
},
"businessName": "<string>",
"loaFileUrl": "<string>",
"loaSignedAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"activatedAt": "2023-11-07T05:31:56Z",
"rejectionReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Hosted-messaging order id.
Body
application/json
New inbound-SMS route for a hosted-messaging order that has not yet activated.
Delivery target for inbound SMS received on a hosted (text-enabled) number once the order is active. Inbound only — no outbound (MT) path is created.
Show child attributes
Show child attributes
⌘I